Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-snapshot: STU1 Draft) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Shareable ImplementationGuide

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableimplementationguide Version: 1.0.0-snapshot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIShareableImplementationGuide
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.50

Enforces the minimum information set for the implementation guide metadata required by HL7 and other organizations that share and publish implementation guides

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ImplementationGuide

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide 1..1 ImplementationGuide A set of rules about how FHIR is used
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact

... url S 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version S 1..1 string Business version of the implementation guide
... name S 1..1 string Name for this implementation guide (computer friendly)
... title S 1..1 string Name for this implementation guide (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher (organization or individual)
... description S 1..1 markdown Natural language description of the implementation guide

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C 1..1 ImplementationGuide A set of rules about how FHIR is used
ig-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
ig-2: If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... versionAlgorithm S 0..1 string, Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version SΣ 1..1 string Business version of the implementation guide
... name SΣC 1..1 string Name for this implementation guide (computer friendly)
... title SΣ 1..1 string Name for this implementation guide (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... publisher SΣ 0..1 string Name of the publisher (organization or individual)
... description S 1..1 markdown Natural language description of the implementation guide
... packageId Σ 1..1 id NPM Package name for IG
... fhirVersion Σ 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImplementationGuide.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ImplementationGuide.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImplementationGuideIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImplementationGuideIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImplementationGuideA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ig-0warningImplementationGuideName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ig-2errorImplementationGuideIf a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
: definition.resource.fhirVersion.all(%context.fhirVersion contains $this)
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C 1..1 ImplementationGuide A set of rules about how FHIR is used
ig-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
ig-2: If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S 0..1 string, Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version SΣ 1..1 string Business version of the implementation guide
... name SΣC 1..1 string Name for this implementation guide (computer friendly)
... title SΣ 1..1 string Name for this implementation guide (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the implementation guide
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for implementation guide (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1 markdown Use and/or publishing restrictions
... packageId Σ 1..1 id NPM Package name for IG
... license Σ 0..1 code SPDX license code for this IG (or not-open-source)
Binding: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).

... fhirVersion Σ 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn Σ 0..* BackboneElement Another Implementation guide this depends on
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uri Σ 1..1 canonical(ImplementationGuide) Identity of the IG that this depends on
.... packageId Σ 0..1 id NPM Package name for IG this depends on
.... version Σ 0..1 string Version of the IG
... global Σ 0..* BackboneElement Profiles that apply globally
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code Type this profile applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

.... profile Σ 1..1 canonical(StructureDefinition) Profile that all resources must conform to
... definition C 0..1 BackboneElement Information needed to build the IG
ig-1: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... grouping 0..* BackboneElement Grouping used to present related resources in the IG
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Descriptive name for the package
..... description 0..1 string Human readable text describing the package
.... resource 1..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... reference 1..1 Reference(Resource) Location of the resource
..... fhirVersion 0..* code Versions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.


..... name 0..1 string Human Name for the resource
..... description 0..1 string Reason why included in guide
..... example[x] 0..1 Is an example/What is this an example of?
...... exampleBoolean boolean
...... exampleCanonical canonical(StructureDefinition)
..... groupingId 0..1 id Grouping this is part of
.... page 0..1 BackboneElement Page/Section in the Guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name[x] 1..1 Where to find that page
...... nameUrl url
...... nameReference Reference(Binary)
..... title 1..1 string Short title shown for navigational assistance
..... generation 1..1 code html | markdown | xml | generated
Binding: GuidePageGeneration (required): A code that indicates how the page is generated.

..... page 0..* See page (ImplementationGuide) Nested Pages / Sections
.... parameter 0..* BackboneElement Defines how IG is built by tools
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.

..... value 1..1 string Value for named type
.... template 0..* BackboneElement A template for building resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Type of template specified
..... source 1..1 string The source location for the template
..... scope 0..1 string The scope in which the template applies
... manifest 0..1 BackboneElement Information about an assembled IG
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... rendering Σ 0..1 url Location of rendered implementation guide
.... resource Σ 1..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... reference Σ 1..1 Reference(Resource) Location of the resource
..... example[x] 0..1 Is an example/What is this an example of?
...... exampleBoolean boolean
...... exampleCanonical canonical(StructureDefinition)
..... relativePath 0..1 url Relative path for page in IG
.... page 0..* BackboneElement HTML page within the parent IG
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string HTML page name
..... title 0..1 string Title of the page, for references
..... anchor 0..* string Anchor available on the page
.... image 0..* string Image within the IG
.... other 0..* string Additional linkable file in IG

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImplementationGuide.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImplementationGuide.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ImplementationGuide.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ImplementationGuide.licenserequiredSPDXLicense
http://hl7.org/fhir/ValueSet/spdx-license|4.0.1
from the FHIR Standard
ImplementationGuide.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard
ImplementationGuide.global.typerequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
ImplementationGuide.definition.resource.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard
ImplementationGuide.definition.page.generationrequiredGuidePageGeneration
http://hl7.org/fhir/ValueSet/guide-page-generation|4.0.1
from the FHIR Standard
ImplementationGuide.definition.parameter.coderequiredGuideParameterCode
http://hl7.org/fhir/ValueSet/guide-parameter-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImplementationGuideIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImplementationGuideIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImplementationGuideA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ig-0warningImplementationGuideName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ig-1errorImplementationGuide.definitionIf a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide
: resource.groupingId.all(%context.grouping.id contains $this)
ig-2errorImplementationGuideIf a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
: definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

Differential View

This structure is derived from ImplementationGuide

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide 1..1 ImplementationGuide A set of rules about how FHIR is used
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact

... url S 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version S 1..1 string Business version of the implementation guide
... name S 1..1 string Name for this implementation guide (computer friendly)
... title S 1..1 string Name for this implementation guide (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher (organization or individual)
... description S 1..1 markdown Natural language description of the implementation guide

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C 1..1 ImplementationGuide A set of rules about how FHIR is used
ig-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
ig-2: If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... versionAlgorithm S 0..1 string, Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version SΣ 1..1 string Business version of the implementation guide
... name SΣC 1..1 string Name for this implementation guide (computer friendly)
... title SΣ 1..1 string Name for this implementation guide (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... publisher SΣ 0..1 string Name of the publisher (organization or individual)
... description S 1..1 markdown Natural language description of the implementation guide
... packageId Σ 1..1 id NPM Package name for IG
... fhirVersion Σ 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImplementationGuide.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ImplementationGuide.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImplementationGuideIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImplementationGuideIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImplementationGuideA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ig-0warningImplementationGuideName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ig-2errorImplementationGuideIf a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
: definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C 1..1 ImplementationGuide A set of rules about how FHIR is used
ig-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
ig-2: If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S 0..1 string, Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
... versionPolicy S 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this implementation guide, represented as a URI (globally unique)
... version SΣ 1..1 string Business version of the implementation guide
... name SΣC 1..1 string Name for this implementation guide (computer friendly)
... title SΣ 1..1 string Name for this implementation guide (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the implementation guide
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for implementation guide (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1 markdown Use and/or publishing restrictions
... packageId Σ 1..1 id NPM Package name for IG
... license Σ 0..1 code SPDX license code for this IG (or not-open-source)
Binding: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/).

... fhirVersion Σ 1..* code FHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn Σ 0..* BackboneElement Another Implementation guide this depends on
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uri Σ 1..1 canonical(ImplementationGuide) Identity of the IG that this depends on
.... packageId Σ 0..1 id NPM Package name for IG this depends on
.... version Σ 0..1 string Version of the IG
... global Σ 0..* BackboneElement Profiles that apply globally
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code Type this profile applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

.... profile Σ 1..1 canonical(StructureDefinition) Profile that all resources must conform to
... definition C 0..1 BackboneElement Information needed to build the IG
ig-1: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... grouping 0..* BackboneElement Grouping used to present related resources in the IG
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Descriptive name for the package
..... description 0..1 string Human readable text describing the package
.... resource 1..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... reference 1..1 Reference(Resource) Location of the resource
..... fhirVersion 0..* code Versions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.


..... name 0..1 string Human Name for the resource
..... description 0..1 string Reason why included in guide
..... example[x] 0..1 Is an example/What is this an example of?
...... exampleBoolean boolean
...... exampleCanonical canonical(StructureDefinition)
..... groupingId 0..1 id Grouping this is part of
.... page 0..1 BackboneElement Page/Section in the Guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name[x] 1..1 Where to find that page
...... nameUrl url
...... nameReference Reference(Binary)
..... title 1..1 string Short title shown for navigational assistance
..... generation 1..1 code html | markdown | xml | generated
Binding: GuidePageGeneration (required): A code that indicates how the page is generated.

..... page 0..* See page (ImplementationGuide) Nested Pages / Sections
.... parameter 0..* BackboneElement Defines how IG is built by tools
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
Binding: GuideParameterCode (required): Code of parameter that is input to the guide.

..... value 1..1 string Value for named type
.... template 0..* BackboneElement A template for building resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Type of template specified
..... source 1..1 string The source location for the template
..... scope 0..1 string The scope in which the template applies
... manifest 0..1 BackboneElement Information about an assembled IG
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... rendering Σ 0..1 url Location of rendered implementation guide
.... resource Σ 1..* BackboneElement Resource in the implementation guide
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... reference Σ 1..1 Reference(Resource) Location of the resource
..... example[x] 0..1 Is an example/What is this an example of?
...... exampleBoolean boolean
...... exampleCanonical canonical(StructureDefinition)
..... relativePath 0..1 url Relative path for page in IG
.... page 0..* BackboneElement HTML page within the parent IG
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string HTML page name
..... title 0..1 string Title of the page, for references
..... anchor 0..* string Anchor available on the page
.... image 0..* string Image within the IG
.... other 0..* string Additional linkable file in IG

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImplementationGuide.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImplementationGuide.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ImplementationGuide.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ImplementationGuide.licenserequiredSPDXLicense
http://hl7.org/fhir/ValueSet/spdx-license|4.0.1
from the FHIR Standard
ImplementationGuide.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard
ImplementationGuide.global.typerequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
ImplementationGuide.definition.resource.fhirVersionrequiredFHIRVersion
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
from the FHIR Standard
ImplementationGuide.definition.page.generationrequiredGuidePageGeneration
http://hl7.org/fhir/ValueSet/guide-page-generation|4.0.1
from the FHIR Standard
ImplementationGuide.definition.parameter.coderequiredGuideParameterCode
http://hl7.org/fhir/ValueSet/guide-parameter-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImplementationGuideIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImplementationGuideIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImplementationGuideIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImplementationGuideA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ig-0warningImplementationGuideName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ig-1errorImplementationGuide.definitionIf a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide
: resource.groupingId.all(%context.grouping.id contains $this)
ig-2errorImplementationGuideIf a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide
: definition.resource.fhirVersion.all(%context.fhirVersion contains $this)

 

Other representations of profile: CSV, Excel, Schematron