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

Detailed Descriptions for the elements in the ImplementationGuide resource.

ImplementationGuide
Definition

A set of rules of how FHIR is used to solve a particular problem. 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.

Control1..1
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.

ImplementationGuide.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. This SHOULD be globally unique, and SHOULD be a literal address at which this implementation guide is (or will be) published.

Control1..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 URL SHOULD include the major version of the implementation guide. For more information see Technical and Business Versions.

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

Control1..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 alpha-numeric type name to ensure that it is computable friendly.

ImplementationGuide.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: null)
Summarytrue
Comments

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

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

Control0..1
Typeboolean
Is Modifiertrue (Reason: null)
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 guide that are appropriate for use vs. not.

ImplementationGuide.date
Definition

The date (and optionally time) when the implementation guide was published. The date must change if and 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.

Control0..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
Definition

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

Control0..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
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

ImplementationGuide.description
Definition

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

Control0..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 profile is presumed to be the predominant language in the place the profile was created).

ImplementationGuide.useContext
Definition

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 for appropriate implementation guide instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ImplementationGuide.jurisdiction
Definition

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

Control0..*
Terminology BindingJurisdiction ValueSet (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
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.

Control0..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.fhirVersion
Definition

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 3.2.0 for this version.

Control0..1
Typeid
Summarytrue
Comments

An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.

ImplementationGuide.dependency
Definition

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

Control0..*
Summarytrue
ImplementationGuide.dependency.type
Definition

How the dependency is represented when the guide is published.

Control1..1
Terminology BindingGuideDependencyType (Required)
Typecode
Summarytrue
Comments

For information about processing included guides, see Including Guides.

ImplementationGuide.dependency.uri
Definition

Where the dependency is located.

Control1..1
Typeuri
Summarytrue
Comments

When a guide is published, and the type is 'include', this will be a relative reference within the guide.

ImplementationGuide.package
Definition

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

Control0..*
Summarytrue
ImplementationGuide.package.name
Definition

The name for the group, as used in page.package.

Control1..1
Typestring
Summarytrue
ImplementationGuide.package.description
Definition

Human readable text describing the package.

Control0..1
Typestring
ImplementationGuide.package.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.

Control1..*
Summarytrue
ImplementationGuide.package.resource.example
Definition

Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.

Control0..1
Typeboolean
Default Valuefalse
Summarytrue
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.package.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).

Control0..1
Typestring
Summarytrue
ImplementationGuide.package.resource.description
Definition

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

Control0..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.package.resource.acronym
Definition

A short code that may be used to identify the resource throughout the implementation guide.

Control0..1
Typestring
Comments

This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well).

ImplementationGuide.package.resource.source[x]
Definition

Where this resource is found.

Control1..1
Typeuri|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.package.resource.exampleFor
Definition

Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.

Control0..1
TypeReference(StructureDefinition)
Comments

Examples:

  • StructureDefinition -> Any
  • ValueSet -> expansion
  • OperationDefinition -> Parameters
  • Questionnaire -> QuestionnaireResponse.
ImplementationGuide.global
Definition

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

Control0..*
Summarytrue
Comments

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

ImplementationGuide.global.type
Definition

The type of resource that all instances must conform to.

Control1..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
Definition

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

Control1..1
TypeReference(StructureDefinition)
Summarytrue
ImplementationGuide.binary
Definition

A binary file that is included in the implementation guide when it is published.

Control0..*
Typeuri
Comments

This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.

ImplementationGuide.page
Definition

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

Control0..1
Summarytrue
Comments

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

ImplementationGuide.page.source
Definition

The source address for the page.

Control1..1
Typeuri
Summarytrue
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.page.title
Definition

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

Control1..1
Typestring
Summarytrue
ImplementationGuide.page.kind
Definition

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.

Control1..1
Terminology BindingGuidePageKind (Required)
Typecode
Summarytrue
ImplementationGuide.page.type
Definition

For constructed pages, what kind of resources to include in the list.

Control0..*
Terminology BindingAny defined Resource Type name
Typecode
ImplementationGuide.page.package
Definition

For constructed pages, a list of packages to include in the page (or else empty for everything).

Control0..*
Typestring
ImplementationGuide.page.format
Definition

The format of the page.

Control0..1
Terminology BindingMimeType :
Typecode
Comments

This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.

ImplementationGuide.page.page
Definition

Nested Pages/Sections under this page.

Control0..*
TypeSee ImplementationGuide.page
Comments

The implementation guide breadcrumbs are generated from this structure.