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.

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.

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.

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.

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.

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.

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.

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

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.

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.

Support human navigation and code generation.

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.

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

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

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

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

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.

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

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

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.

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.

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

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

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.

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

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

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

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

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.

Assist in searching for appropriate content.

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

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

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

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.

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

...

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

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

The (c) symbol 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.

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.

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.

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

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.

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.

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

A canonical reference to the Implementation guide for the dependency.

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

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

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

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

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

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

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

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

The type of resource that all instances must conform to.

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.

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

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

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

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

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

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

Human readable text describing the package.

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.

Where this resource is found.

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.

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.

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.

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

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

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

If true, indicates the resource is an example instance.

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

Examples:

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

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

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

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

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

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

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.

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

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.

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

A code that indicates how the page is generated.

Nested Pages/Sections under this page.

The implementation guide breadcrumbs may be generated from this structure.

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.

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

A tool-specific code that defines the parameter.

Value for named type.

A template for building resources.

Type of template specified.

The source location for the template.

The scope in which the template applies.

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

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

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.

Where this resource is found.

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.

If true, indicates the resource is an example instance.

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

Examples:

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

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

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

Information about a page within the IG.

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

Relative path to the page.

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

Label for the page intended for human display.

Allows generation of labels for markdown-generated hyperlinks.

The name of an anchor available on the page.

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

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

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

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

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.

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