type: resource-definitionsresource: ImplementationGuide

ImplementationGuide Definitions

ImplementationGuide

A set of rules about how FHIR is used

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.

Cardinality: 0..*

Constraints: cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^A-Z{1,254}$'); ig-2 | error | If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide | definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

Mappings: rim=n/a; w5=conformance.misc

ImplementationGuide.url

Canonical identifier for this implementation guide, represented as a URI (globally unique)

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

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.

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.

Aliases: url, authoritative-url, destination, identity

Cardinality: 1..1

Type: uri

Summary: true

Mappings: w5=FiveWs.identifier

ImplementationGuide.identifier

Additional identifier for the implementation guide (business identifier)

Definition: A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.

Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier

ImplementationGuide.version

Business version of the implementation guide

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.

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]. The version SHOULD NOT contain a '#' - see Business Version.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.version

ImplementationGuide.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

Comments: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

ImplementationGuide.name

Name for this implementation guide (computer friendly)

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.

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.

Requirements: Support human navigation and code generation.

Conditions: cnl-0

Cardinality: 1..1

Type: string

Summary: true

ImplementationGuide.title

Name for this implementation guide (human friendly)

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

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

Cardinality: 0..1

Type: string

Summary: true

ImplementationGuide.status

draft | active | retired | unknown

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: w5=FiveWs.status

ImplementationGuide.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of implementation guides that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

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

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: w5=FiveWs.class

ImplementationGuide.date

Date last changed

Definition: The date (and optionally time) when the implementation guide was last significantly changed. 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.

Comments: The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded

ImplementationGuide.publisher

Name of the publisher/steward (organization or individual)

Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.

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.

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.witness

ImplementationGuide.contact

Contact details for the publisher

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

ImplementationGuide.description

Natural language description of the implementation guide

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

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

Cardinality: 0..1

Type: markdown

ImplementationGuide.useContext

The context that the content is intended to support

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.

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

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

ImplementationGuide.jurisdiction

Jurisdiction of the authority that maintains the implementation guide (if applicable)

Definition: A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

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.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

ImplementationGuide.purpose

Why this implementation guide is defined

Definition: Explanation of why this implementation guide is needed and why it has been designed as it has.

Comments: This element does not describe the usage of the implementation guide. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this implementation guide.

Cardinality: 0..1

Type: markdown

Mappings: w5=FiveWs.why[x]; objimpl=no-gen-base

ImplementationGuide.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the implementation guide and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the implementation guide.

Comments: ...

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

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: objimpl=no-gen-base

ImplementationGuide.copyrightLabel

Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Requirements: Defines the content expected to be rendered in all representations of the artifact.

Cardinality: 0..1

Type: string

ImplementationGuide.packageId

NPM Package name for IG

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.

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.

Cardinality: 1..1

Type: id

Summary: true

ImplementationGuide.license

SPDX license code for this IG (or not-open-source)

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

Cardinality: 0..1

Type: code

Binding: required:spdx-license

Summary: true

ImplementationGuide.fhirVersion

FHIR Version(s) this Implementation Guide targets

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

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.

Conditions: ig-2

Cardinality: 1..*

Type: code

Binding: required:FHIR-version

Summary: true

ImplementationGuide.dependsOn

Another Implementation guide this depends on

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

ImplementationGuide.dependsOn.uri

Identity of the IG that this depends on

Definition: A canonical reference to the Implementation guide for the dependency.

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

Cardinality: 1..1

Type: canonical

Summary: true

ImplementationGuide.dependsOn.packageId

NPM Package name for IG this depends on

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

Cardinality: 0..1

Type: id

Summary: true

ImplementationGuide.dependsOn.version

Version of the IG

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

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

Cardinality: 0..1

Type: string

Summary: true

ImplementationGuide.dependsOn.reason

Why dependency exists

Definition: A description explaining the nature of the dependency on the listed IG.

Comments: This doesn't need to enumerate every resource used, but should give some sense of why the dependency exists. It will be used in the rendered list of dependencies

Cardinality: 0..1

Type: markdown

Summary: false

ImplementationGuide.global

Profiles that apply globally

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

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

ImplementationGuide.global.type

Type this profile applies to

Definition: The type of resource that all instances must conform to.

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.

Cardinality: 1..1

Type: code

Binding: required:resource-types

Summary: true

ImplementationGuide.global.profile

Profile that all resources must conform to

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

Cardinality: 1..1

Type: canonical

Summary: true

ImplementationGuide.definition

Information needed to build the IG

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

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

Conditions: ig-2

Cardinality: 0..1

Type: BackboneElement

Constraints: ig-1 | error | If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide | resource.groupingId.all(%context.grouping.id contains $this)

ImplementationGuide.definition.grouping

Grouping used to present related resources in the IG

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

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

Conditions: ig-1

Cardinality: 0..*

Type: BackboneElement

ImplementationGuide.definition.grouping.name

Descriptive name for the package

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

Cardinality: 1..1

Type: string

ImplementationGuide.definition.grouping.description

Human readable text describing the package

Definition: Human readable text describing the package.

Cardinality: 0..1

Type: markdown

ImplementationGuide.definition.resource

Resource in the implementation guide

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.

Conditions: ig-2, ig-1

Cardinality: 0..*

Type: BackboneElement

ImplementationGuide.definition.resource.reference

Location of the resource

Definition: Where this resource is found.

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.

Cardinality: 1..1

Type: Reference(Resource)

ImplementationGuide.definition.resource.fhirVersion

Versions this applies to (if different to IG)

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.

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 [[[http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version]]] extension.

Conditions: ig-2

Cardinality: 0..*

Type: code

Binding: required:FHIR-version

ImplementationGuide.definition.resource.name

Human readable name for the resource

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

Cardinality: 0..1

Type: string

ImplementationGuide.definition.resource.description

Reason why included in guide

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

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

Cardinality: 0..1

Type: markdown

ImplementationGuide.definition.resource.isExample

Is this an example

Definition: If true, indicates the resource is an example instance.

Cardinality: 0..1

Type: boolean

ImplementationGuide.definition.resource.profile

Profile(s) this resource is valid against

Definition: If present, indicates profile(s) the instance is valid against.

Comments: This can be used for both example and non-example resources to indicate profiles they are expected to be valid against. E.g. a non-example ValueSet might be declared to be a valid 'ShareableValueSet'

Cardinality: 0..*

Type: canonical

ImplementationGuide.definition.resource.groupingId

Grouping this is part of

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

Comments: This must correspond to a group.id element within this implementation guide.

Conditions: ig-1

Cardinality: 0..1

Type: id

ImplementationGuide.definition.page

Page/Section in the Guide

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

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

Cardinality: 0..1

Type: BackboneElement

Constraints: ig-3 | error | Source must be absent if 'generated' is generated | generation='generated' implies source.empty()

ImplementationGuide.definition.page.source[x]

Source for page

Definition: Indicates the URL or the actual content to provide for the page.

Comments: If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative.

Conditions: ig-3

Cardinality: 0..1

Type: url, string, markdown

ImplementationGuide.definition.page.name

Name of the page when published

Definition: The url by which the page should be known when published.

Comments: This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended.

Cardinality: 1..1

Type: url

ImplementationGuide.definition.page.title

Short title shown for navigational assistance

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

Cardinality: 1..1

Type: string

ImplementationGuide.definition.page.generation

html | markdown | xml | generated

Definition: A code that indicates how the page is generated.

Conditions: ig-3

Cardinality: 1..1

Type: code

Binding: required:guide-page-generation

ImplementationGuide.definition.page.page

Nested Pages / Sections

Definition: Nested Pages/Sections under this page.

Comments: The implementation guide breadcrumbs may be generated from this structure.

Cardinality: 0..*

ImplementationGuide.definition.parameter

Defines how IG is built by tools

Definition: A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.

Comments: see confluence for the parameters defined by the HL7 IG publisher.

Cardinality: 0..*

Type: BackboneElement

ImplementationGuide.definition.parameter.code

Code that identifies parameter

Definition: A tool-specific code that defines the parameter.

Cardinality: 1..1

Type: Coding

Binding: extensible:guide-parameter-code

ImplementationGuide.definition.parameter.value

Value for named type

Definition: Value for named type.

Cardinality: 1..1

Type: string

ImplementationGuide.definition.template

A template for building resources

Definition: A template for building resources.

Cardinality: 0..*

Type: BackboneElement

ImplementationGuide.definition.template.code

Type of template specified

Definition: Type of template specified.

Cardinality: 1..1

Type: code

ImplementationGuide.definition.template.source

The source location for the template

Definition: The source location for the template.

Cardinality: 1..1

Type: string

ImplementationGuide.definition.template.scope

The scope in which the template applies

Definition: The scope in which the template applies.

Cardinality: 0..1

Type: string

ImplementationGuide.manifest

Information about an assembled IG

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

Cardinality: 0..1

Type: BackboneElement

ImplementationGuide.manifest.rendering

Location of rendered implementation guide

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

Cardinality: 0..1

Type: url

Summary: true

ImplementationGuide.manifest.resource

Resource in the implementation guide

Cardinality: 1..*

Type: BackboneElement

Summary: true

ImplementationGuide.manifest.resource.reference

Location of the resource

Definition: Where this resource is found.

Cardinality: 1..1

Type: Reference(Resource)

Summary: true

ImplementationGuide.manifest.resource.isExample

Is this an example

Definition: If true, indicates the resource is an example instance.

Cardinality: 0..1

Type: boolean

ImplementationGuide.manifest.resource.profile

Profile(s) this is an example of

Definition: If present, indicates profile(s) the instance is valid against.

Comments: Examples:

StructureDefinition -> Any
ValueSet -> expansion
OperationDefinition -> Parameters
Questionnaire -> QuestionnaireResponse.

Cardinality: 0..*

Type: canonical

ImplementationGuide.manifest.resource.relativePath

Relative path for page in IG

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

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

Cardinality: 0..1

Type: url

ImplementationGuide.manifest.page

HTML page within the parent IG

Definition: Information about a page within the IG.

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

Cardinality: 0..*

Type: BackboneElement

ImplementationGuide.manifest.page.name

HTML page name

Definition: Relative path to the page.

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

Cardinality: 1..1

Type: string

ImplementationGuide.manifest.page.title

Title of the page, for references

Definition: Label for the page intended for human display.

Requirements: Allows generation of labels for markdown-generated hyperlinks.

Cardinality: 0..1

Type: string

ImplementationGuide.manifest.page.anchor

Anchor available on the page

Definition: The name of an anchor available on the page.

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

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

Cardinality: 0..*

Type: string

ImplementationGuide.manifest.image

Image within the IG

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

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

Cardinality: 0..*

Type: string

ImplementationGuide.manifest.other

Additional linkable file in IG

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.

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

Cardinality: 0..*

Type: string