Current Build
FHIR Infrastructure Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ImplementationGuide resource.

ImplementationGuide
Element IdImplementationGuide
Definition

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Cardinality0..*
TypeDomainResource
Requirements

An implementation guide is able to define default profiles that must apply to any use of a resource, so validation services may need to take one or more implementation guide resources when validating.

Invariants
Defined on this element
ig-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ig-2Rule If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guidedefinition.resource.fhirVersion.all(%context.fhirVersion contains $this)
ImplementationGuide.url
Element IdImplementationGuide.url
Definition

An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.

Cardinality1..1
Typeuri
Requirements

Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.

Alternate Namesurl; authoritative-url; destination; identity
Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

ImplementationGuide.version
Element IdImplementationGuide.version
Definition

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 and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the implementation guide with the format [url]|[version].

ImplementationGuide.name
Element IdImplementationGuide.name
Definition

A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ImplementationGuide.title
Element IdImplementationGuide.title
Definition

A short, descriptive, user-friendly title for the implementation guide.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ImplementationGuide.status
Element IdImplementationGuide.status
Definition

The status of this implementation guide. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of implementation guides that are appropriate for use versus not.

ImplementationGuide.experimental
Element IdImplementationGuide.experimental
Definition

A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.

Summarytrue
Comments

Allows filtering of implementation guides that are appropriate for use versus not.

ImplementationGuide.date
Element IdImplementationGuide.date
Definition

The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ImplementationGuide.publisher
Element IdImplementationGuide.publisher
Definition

The name of the organization or individual that published the implementation guide.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the implementation guide. This item SHOULD be populated unless the information is available from context.

ImplementationGuide.contact
Element IdImplementationGuide.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ImplementationGuide.description
Element IdImplementationGuide.description
Definition

A free text natural language description of the implementation guide from a consumer's perspective.

Cardinality0..1
Typemarkdown
Comments

This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the implementation guide is presumed to be the predominant language in the place the implementation guide was created).

ImplementationGuide.useContext
Element IdImplementationGuide.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

ImplementationGuide.jurisdiction
Element IdImplementationGuide.jurisdiction
Definition

A legal or geographic region in which the implementation guide is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.

ImplementationGuide.copyright
Element IdImplementationGuide.copyright
Definition

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 implementation guide.

Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.

Alternate NamesLicense; Restrictions
ImplementationGuide.packageId
Element IdImplementationGuide.packageId
Definition

The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

Cardinality1..1
Typeid
Summarytrue
Comments

Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.

ImplementationGuide.license
Element IdImplementationGuide.license
Definition

The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.

Cardinality0..1
Terminology BindingSPDXLicense (Required)
Typecode
Summarytrue
ImplementationGuide.fhirVersion
Element IdImplementationGuide.fhirVersion
Definition

The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.0. for this version.

Cardinality1..*
Terminology BindingFHIRVersion (Required)
Typecode
Summarytrue
Comments

Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics.

ImplementationGuide.dependsOn
Element IdImplementationGuide.dependsOn
Definition

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

Cardinality0..*
Summarytrue
ImplementationGuide.dependsOn.uri
Element IdImplementationGuide.dependsOn.uri
Definition

A canonical reference to the Implementation guide for the dependency.

Cardinality1..1
Typecanonical(ImplementationGuide)
Summarytrue
Comments

Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.

ImplementationGuide.dependsOn.packageId
Element IdImplementationGuide.dependsOn.packageId
Definition

The NPM package name for the Implementation Guide that this IG depends on.

Cardinality0..1
Typeid
Summarytrue
ImplementationGuide.dependsOn.version
Element IdImplementationGuide.dependsOn.version
Definition

The version of the IG that is depended on, when the correct version is required to understand the IG correctly.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

This follows the syntax of the NPM packaging version field - see [[reference]].

ImplementationGuide.global
Element IdImplementationGuide.global
Definition

A set of profiles that all resources covered by this implementation guide must conform to.

Cardinality0..*
Summarytrue
Comments

See Default Profiles for a discussion of which resources are 'covered' by an implementation guide.

ImplementationGuide.global.type
Element IdImplementationGuide.global.type
Definition

The type of resource that all instances must conform to.

Cardinality1..1
Terminology BindingAny defined Resource Type name
Typecode
Summarytrue
Comments

The type must match that of the profile that is referred to but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available.

ImplementationGuide.global.profile
Element IdImplementationGuide.global.profile
Definition

A reference to the profile that all instances must conform to.

Cardinality1..1
Typecanonical(StructureDefinition)
Summarytrue
ImplementationGuide.definition
Element IdImplementationGuide.definition
Definition

The information needed by an IG publisher tool to publish the whole implementation guide.

Cardinality0..1
Comments

Principally, this consists of information abuot source resource and file locations, and build parameters and templates.

Invariants
Defined on this element
ig-1Rule If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guideresource.groupingId.all(%context.grouping.id contains $this)
ImplementationGuide.definition.grouping
Element IdImplementationGuide.definition.grouping
Definition

A logical group of resources. Logical groups can be used when building pages.

Cardinality0..*
Comments

Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.

ImplementationGuide.definition.grouping.name
Element IdImplementationGuide.definition.grouping.name
Definition

The human-readable title to display for the package of resources when rendering the implementation guide.

Cardinality1..1
Typestring
ImplementationGuide.definition.grouping.description
Element IdImplementationGuide.definition.grouping.description
Definition

Human readable text describing the package.

Cardinality0..1
Typestring
ImplementationGuide.definition.resource
Element IdImplementationGuide.definition.resource
Definition

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

Cardinality1..*
ImplementationGuide.definition.resource.reference
Element IdImplementationGuide.definition.resource.reference
Definition

Where this resource is found.

Cardinality1..1
TypeReference(Any)
Comments

Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.

ImplementationGuide.definition.resource.fhirVersion
Element IdImplementationGuide.definition.resource.fhirVersion
Definition

Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

Cardinality0..*
Terminology BindingFHIRVersion (Required)
Typecode
Comments

The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the applicable-version extension.

ImplementationGuide.definition.resource.name
Element IdImplementationGuide.definition.resource.name
Definition

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).

Cardinality0..1
Typestring
ImplementationGuide.definition.resource.description
Element IdImplementationGuide.definition.resource.description
Definition

A description of the reason that a resource has been included in the implementation guide.

Cardinality0..1
Typestring
Comments

This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).

ImplementationGuide.definition.resource.example[x]
Element IdImplementationGuide.definition.resource.example[x]
Definition

If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

Cardinality0..1
Typeboolean|canonical(StructureDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Examples:

  • StructureDefinition -> Any
  • ValueSet -> expansion
  • OperationDefinition -> Parameters
  • Questionnaire -> QuestionnaireResponse.
ImplementationGuide.definition.resource.groupingId
Element IdImplementationGuide.definition.resource.groupingId
Definition

Reference to the id of the grouping this resource appears in.

Cardinality0..1
Typeid
Comments

This must correspond to a package.id element within this implementation guide.

ImplementationGuide.definition.page
Element IdImplementationGuide.definition.page
Definition

A page / section in the implementation guide. The root page is the implementation guide home page.

Cardinality0..1
Comments

Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.

ImplementationGuide.definition.page.name[x]
Element IdImplementationGuide.definition.page.name[x]
Definition

The source address for the page.

Cardinality1..1
Typeurl|Reference(Binary)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

The publishing tool will autogenerate source for list (source = n/a) and inject included implementations for include (source = uri of guide to include).

ImplementationGuide.definition.page.title
Element IdImplementationGuide.definition.page.title
Definition

A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.

Cardinality1..1
Typestring
ImplementationGuide.definition.page.generation
Element IdImplementationGuide.definition.page.generation
Definition

A code that indicates how the page is generated.

Cardinality1..1
Terminology BindingGuidePageGeneration (Required)
Typecode
ImplementationGuide.definition.page.page
Element IdImplementationGuide.definition.page.page
Definition

Nested Pages/Sections under this page.

Cardinality0..*
TypeSee ImplementationGuide.definition.page
Comments

The implementation guide breadcrumbs are generated from this structure.

ImplementationGuide.definition.parameter
Element IdImplementationGuide.definition.parameter
Definition

Defines how IG is built by tools.

Cardinality0..*
ImplementationGuide.definition.parameter.code
Element IdImplementationGuide.definition.parameter.code
Definition

apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.

Cardinality1..1
Terminology BindingGuideParameterCode (Required)
Typecode
ImplementationGuide.definition.parameter.value
Element IdImplementationGuide.definition.parameter.value
Definition

Value for named type.

Cardinality1..1
Typestring
ImplementationGuide.definition.template
Element IdImplementationGuide.definition.template
Definition

A template for building resources.

Cardinality0..*
ImplementationGuide.definition.template.code
Element IdImplementationGuide.definition.template.code
Definition

Type of template specified.

Cardinality1..1
Typecode
ImplementationGuide.definition.template.source
Element IdImplementationGuide.definition.template.source
Definition

The source location for the template.

Cardinality1..1
Typestring
ImplementationGuide.definition.template.scope
Element IdImplementationGuide.definition.template.scope
Definition

The scope in which the template applies.

Cardinality0..1
Typestring
ImplementationGuide.manifest
Element IdImplementationGuide.manifest
Definition

Information about an assembled implementation guide, created by the publication tooling.

Cardinality0..1
ImplementationGuide.manifest.rendering
Element IdImplementationGuide.manifest.rendering
Definition

A pointer to official web page, PDF or other rendering of the implementation guide.

Cardinality0..1
Typeurl
Summarytrue
ImplementationGuide.manifest.resource
Element IdImplementationGuide.manifest.resource
Definition

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

Cardinality1..*
Summarytrue
ImplementationGuide.manifest.resource.reference
Element IdImplementationGuide.manifest.resource.reference
Definition

Where this resource is found.

Cardinality1..1
TypeReference(Any)
Summarytrue
Comments

Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.

ImplementationGuide.manifest.resource.example[x]
Element IdImplementationGuide.manifest.resource.example[x]
Definition

If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

Cardinality0..1
Typeboolean|canonical(StructureDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.

ImplementationGuide.manifest.resource.relativePath
Element IdImplementationGuide.manifest.resource.relativePath
Definition

The relative path for primary page for this resource within the IG.

Cardinality0..1
Typeurl
Comments

Appending 'rendering' + "/" + this should resolve to the resource page.

ImplementationGuide.manifest.page
Element IdImplementationGuide.manifest.page
Definition

Information about a page within the IG.

Cardinality0..*
Requirements

Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.

ImplementationGuide.manifest.page.name
Element IdImplementationGuide.manifest.page.name
Definition

Relative path to the page.

Cardinality1..1
Typestring
Comments

Appending 'rendering' + "/" + this should resolve to the page.

ImplementationGuide.manifest.page.title
Element IdImplementationGuide.manifest.page.title
Definition

Label for the page intended for human display.

Cardinality0..1
Typestring
Requirements

Allows generation of labels for markdown-generated hyperlinks.

ImplementationGuide.manifest.page.anchor
Element IdImplementationGuide.manifest.page.anchor
Definition

The name of an anchor available on the page.

Cardinality0..*
Typestring
Requirements

Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.

Comments

Appending 'rendering' + "/" + page.name + "#" + page.anchor should resolve to the anchor.

ImplementationGuide.manifest.image
Element IdImplementationGuide.manifest.image
Definition

Indicates a relative path to an image that exists within the IG.

Cardinality0..*
Typestring
Requirements

Allows validation of image links from a derived IG to this IG without a local copy of the IG.

ImplementationGuide.manifest.other
Element IdImplementationGuide.manifest.other
Definition

Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.

Cardinality0..*
Typestring
Requirements

Allows validation of links from a derived IG to this IG without a local copy of the IG.