extension shown: fhir [x]


Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/ImplementationGuide

Thing > Resource > DomainResource > ImplementationGuide
conformance.misc > ImplementationGuide

Base StructureDefinition for ImplementationGuide Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from ImplementationGuide
ImplementationGuide.binary Text A binary file that is included in the implementation guide when it is published.
ImplementationGuide.contact BackboneElement Contacts to assist a user in finding and communicating with the publisher.
ImplementationGuide.contact.name Text The name of an individual to contact regarding the implementation guide.
ImplementationGuide.contact.telecom ContactPoint Contact details for individual (if a name was provided) or the publisher.
ImplementationGuide.copyright Text A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
ImplementationGuide.date DateTime The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
ImplementationGuide.dependency BackboneElement Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
ImplementationGuide.dependency.type guide-dependency-type How the dependency is represented when the guide is published.
ImplementationGuide.dependency.uri Text Where the dependency is located.
ImplementationGuide.description Text A free text natural language description of the Implementation Guide and its use.
ImplementationGuide.experimental Boolean This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
ImplementationGuide.fhirVersion Text The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.
ImplementationGuide.global BackboneElement A set of profiles that all resources covered by this implementation guide must conform to.
ImplementationGuide.global.profile StructureDefinition A reference to the profile that all instances must conform to.
ImplementationGuide.global.type resource-types The type of resource that all instances must conform to.
ImplementationGuide.name Text A free text natural language name identifying the Implementation Guide.
ImplementationGuide.package BackboneElement A logical group of resources. Logical groups can be used when building pages.
ImplementationGuide.package.description Text Human readable text describing the package.
ImplementationGuide.package.name Text The name for the group, as used in page.package.
ImplementationGuide.package.resource BackboneElement A resource that is part of the implementation guide. Conformance resources (value set, structure definition, conformance statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
ImplementationGuide.package.resource.acronym Text A short code that may be used to identify the resource throughout the implementation guide.
ImplementationGuide.package.resource.description Text A description of the reason that a resource has been included in the implementation guide.
ImplementationGuide.package.resource.exampleFor StructureDefinition Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
ImplementationGuide.package.resource.name Text A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
ImplementationGuide.package.resource.purpose guide-resource-purpose Why the resource is included in the guide.
ImplementationGuide.package.resource.sourceReference Resource Where this resource is found.
ImplementationGuide.package.resource.sourceuri Text Where this resource is found.
ImplementationGuide.page BackboneElement A page / section in the implementation guide. The root page is the implementation guide home page.
ImplementationGuide.page.format http://www.rfc-editor.org/bcp/bcp13.txt The format of the page.
ImplementationGuide.page.kind guide-page-kind The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.
ImplementationGuide.page.name Text A short name used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
ImplementationGuide.page.package Text For constructed pages, a list of packages to include in the page (or else empty for everything).
ImplementationGuide.page.source Text The source address for the page.
ImplementationGuide.page.type resource-types For constructed pages, what kind of resources to include in the list.
ImplementationGuide.publisher Text The name of the individual or organization that published the implementation guide.
ImplementationGuide.status conformance-resource-status The status of the Implementation Guide.
ImplementationGuide.url Text An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.
ImplementationGuide.useContext use-context The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.
ImplementationGuide.version Text The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.
Properties from DomainResource
DomainResource.contained Resource These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
DomainResource.modifierExtension Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image ImageObject  or
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage URL  or
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Available supertypes defined in extensions

Schema Version 2.2