STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

6.16.7 Resource ImplementationGuide - Detailed Descriptions

Detailed Descriptions for the elements in the ImplementationGuide resource.

ImplementationGuide
Definition

A set of rules or 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 URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.

Control1..1
Typeuri
Requirements

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Requirements

There may be multiple resource versions of the Implementation Guide that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.

Summarytrue
ImplementationGuide.name
Definition

A free text natural language name identifying the Implementation Guide.

Control1..1
Typestring
Summarytrue
Comments

Not expected to be globally unique.

ImplementationGuide.status
Definition

The status of the Implementation Guide.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
Requirements

Allows filtering of Implementation Guides that are appropriate for use vs. not.

Summarytrue
ImplementationGuide.experimental
Definition

This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Requirements

Allows filtering of Implementation Guides that are appropriate for use vs. not.

Summarytrue
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. This item SHOULD be populated unless the information is available from context.

ImplementationGuide.contact
Definition

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

Control0..*
Summarytrue
Comments

May be a web site, an email address, a telephone number (tel:), etc.

ImplementationGuide.contact.name
Definition

The name of an individual to contact regarding the implementation guide.

Control0..1
Typestring
Summarytrue
Comments

If there is no named individual, the telecom is for the organization as a whole.

ImplementationGuide.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher.

Control0..*
TypeContactPoint
Summarytrue
ImplementationGuide.date
Definition

The date this version of the implementation guide was published. The date must change when the business version changes, if it does, 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
Summarytrue
Comments

Additional specific dates may be added as extensions.

ImplementationGuide.description
Definition

A free text natural language description of the Implementation Guide and its use.

Control0..1
Typestring
Summarytrue
Comments

This field can be used for things such as why the Implementation Guide was written, 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 Implementation Guide.text. This item SHOULD be populated unless the information is available from context.

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 of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.

Control0..*
BindingContext of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible)
TypeCodeableConcept
Requirements

Assist in searching for appropriate implementation guide.

Summarytrue
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 details of the constraints and mappings.

Control0..1
Typestring
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 1.4.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
BindingGuideDependencyType: How a dependency is represented when the guide is published. (Required)
Typecode
Summarytrue
Comments

For information about processing included guides, see [Including Guides]{implementationguide.html#include}.

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.

Control1..*
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, conformance 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.

Control1..1
Typeboolean
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
BindingResourceType: Any 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.

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

A short name 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
BindingGuidePageKind: The kind of an included page. (Required)
Typecode
Summarytrue
ImplementationGuide.page.type
Definition

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

Control0..*
BindingResourceType: Any 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
BindingMimeType : Required: BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) (The mime type of an attachment. Any valid mime type is allowed.)
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.