R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

FHIR Infrastructure Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ImplementationGuideOutput resource.

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

ImplementationGuideOutput.url
Definition

An absolute URI that is used to identify this implementation guide output 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 output is (or will be) published.

Control1..1
Typeuri
Requirements

Allows the implementation guide output 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 output. For more information see Technical and Business Versions.

ImplementationGuideOutput.version
Definition

The identifier that is used to identify this version of the implementation guide output when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide output 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 output 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 output with the format [url]|[version].

ImplementationGuideOutput.name
Definition

A natural language name identifying the implementation guide output. 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.

ImplementationGuideOutput.status
Definition

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

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

Allows filtering of implementation guide outputs that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired implementation guide output without due consideration.

ImplementationGuideOutput.experimental
Definition

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

Control0..1
Typeboolean
Is Modifiertrue
Requirements

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

Summarytrue
Comments

Allows filtering of implementation guide output that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental implementation guide output in production.

ImplementationGuideOutput.date
Definition

The date (and optionally time) when the implementation guide output 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 output 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 output. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ImplementationGuideOutput.publisher
Definition

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

Control0..1
Typestring
Requirements

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

Summarytrue
Comments

Usually an organization, but may be an individual. The publisher (or steward) of the implementation guide output is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide output. 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 output. This item SHOULD be populated unless the information is available from context.

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

ImplementationGuideOutput.description
Definition

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

Control0..1
Typemarkdown
Comments

This description can be used to capture details such as why the implementation guide output 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 output 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).

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

ImplementationGuideOutput.jurisdiction
Definition

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

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

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

ImplementationGuideOutput.copyright
Definition

A copyright statement relating to the implementation guide output and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide output.

Control0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
ImplementationGuideOutput.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.

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

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

ImplementationGuideOutput.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
ImplementationGuideOutput.resource.reference
Definition

Where this resource is found.

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

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

Control0..1
Typeboolean|Reference(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.

ImplementationGuideOutput.resource.relativePath
Definition

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

Control0..1
Typestring
Comments

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

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

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

ImplementationGuideOutput.global.profile
Definition

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

Control1..1
TypeReference(StructureDefinition)
Summarytrue
ImplementationGuideOutput.rendering
Definition

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

Control0..1
Typeuri
Summarytrue
ImplementationGuideOutput.page
Definition

Information about a page within the IG.

Control0..*
Requirements

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

ImplementationGuideOutput.page.name
Definition

Relative path to the page.

Control1..1
Typestring
Comments

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

ImplementationGuideOutput.page.title
Definition

Label for the page intended for human display.

Control0..1
Typestring
Requirements

Allows generation of labels for markdown-generated hyperlinks.

ImplementationGuideOutput.page.anchor
Definition

The name of an anchor available on the page.

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

ImplementationGuideOutput.image
Definition

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

Control0..*
Typestring
Requirements

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

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

Control0..*
Typestring
Requirements

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