Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Computable Guideline

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computableguideline Version: 2.0.0-ballot
Active as of 2023-12-19 Computable Name: CPGComputableGuideline

Profile of ImplementationGuide to describe a computable Clinical Practice Guideline

This is a computable artifact profile

Examples:

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 0..*ImplementationGuideA set of rules about how FHIR is used
... dependsOn S0..*BackboneElementAnother Implementation guide this depends on
... definition S0..1BackboneElementInformation needed to build the IG

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C0..*ImplementationGuideA set of rules about how FHIR is used
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this implementation guide, represented as a URI (globally unique)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... packageId Σ1..1idNPM Package name for IG
... fhirVersion Σ1..*codeFHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn SΣ0..*BackboneElementAnother Implementation guide this depends on
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri Σ1..1canonical(ImplementationGuide)Identity of the IG that this depends on
... definition SC0..1BackboneElementInformation needed to build the IG
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource 1..*BackboneElementResource in the implementation guide
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1Reference(Resource)Location of the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImplementationGuide.statusrequiredPublicationStatus
ImplementationGuide.fhirVersionrequiredFHIRVersion

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)
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C0..*ImplementationGuideA set of rules about how FHIR is used
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this implementation guide, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the implementation guide
... name ΣC1..1stringName for this implementation guide (computer friendly)
... title Σ0..1stringName for this implementation guide (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1markdownUse and/or publishing restrictions
... packageId Σ1..1idNPM Package name for IG
... license Σ0..1codeSPDX 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..*codeFHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn SΣ0..*BackboneElementAnother Implementation guide this depends on
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri Σ1..1canonical(ImplementationGuide)Identity of the IG that this depends on
.... packageId Σ0..1idNPM Package name for IG this depends on
.... version Σ0..1stringVersion of the IG
... global Σ0..*BackboneElementProfiles that apply globally
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeType this profile applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

.... profile Σ1..1canonical(StructureDefinition)Profile that all resources must conform to
... definition SC0..1BackboneElementInformation needed to build the IG
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... grouping 0..*BackboneElementGrouping used to present related resources in the IG
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringDescriptive name for the package
..... description 0..1stringHuman readable text describing the package
.... resource 1..*BackboneElementResource in the implementation guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1Reference(Resource)Location of the resource
..... fhirVersion 0..*codeVersions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.


..... name 0..1stringHuman Name for the resource
..... description 0..1stringReason why included in guide
..... example[x] 0..1Is an example/What is this an example of?
...... exampleBooleanboolean
...... exampleCanonicalcanonical(StructureDefinition)
..... groupingId 0..1idGrouping this is part of
.... page 0..1BackboneElementPage/Section in the Guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name[x] 1..1Where to find that page
...... nameUrlurl
...... nameReferenceReference(Binary)
..... title 1..1stringShort title shown for navigational assistance
..... generation 1..1codehtml | 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..*BackboneElementDefines how IG is built by tools
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeapply | 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..1stringValue for named type
.... template 0..*BackboneElementA template for building resources
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeType of template specified
..... source 1..1stringThe source location for the template
..... scope 0..1stringThe scope in which the template applies
... manifest 0..1BackboneElementInformation about an assembled IG
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... rendering Σ0..1urlLocation of rendered implementation guide
.... resource Σ1..*BackboneElementResource in the implementation guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference Σ1..1Reference(Resource)Location of the resource
..... example[x] 0..1Is an example/What is this an example of?
...... exampleBooleanboolean
...... exampleCanonicalcanonical(StructureDefinition)
..... relativePath 0..1urlRelative path for page in IG
.... page 0..*BackboneElementHTML page within the parent IG
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringHTML page name
..... title 0..1stringTitle of the page, for references
..... anchor 0..*stringAnchor available on the page
.... image 0..*stringImage within the IG
.... other 0..*stringAdditional linkable file in IG

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImplementationGuide.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImplementationGuide.statusrequiredPublicationStatus
ImplementationGuide.jurisdictionextensibleJurisdiction ValueSet
ImplementationGuide.licenserequiredSPDXLicense
ImplementationGuide.fhirVersionrequiredFHIRVersion
ImplementationGuide.global.typerequiredResourceType
ImplementationGuide.definition.resource.fhirVersionrequiredFHIRVersion
ImplementationGuide.definition.page.generationrequiredGuidePageGeneration
ImplementationGuide.definition.parameter.coderequiredGuideParameterCode

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)

This structure is derived from ImplementationGuide

Summary

Must-Support: 2 elements

Differential View

This structure is derived from ImplementationGuide

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide 0..*ImplementationGuideA set of rules about how FHIR is used
... dependsOn S0..*BackboneElementAnother Implementation guide this depends on
... definition S0..1BackboneElementInformation needed to build the IG

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C0..*ImplementationGuideA set of rules about how FHIR is used
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this implementation guide, represented as a URI (globally unique)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... packageId Σ1..1idNPM Package name for IG
... fhirVersion Σ1..*codeFHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn SΣ0..*BackboneElementAnother Implementation guide this depends on
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri Σ1..1canonical(ImplementationGuide)Identity of the IG that this depends on
... definition SC0..1BackboneElementInformation needed to build the IG
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource 1..*BackboneElementResource in the implementation guide
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1Reference(Resource)Location of the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImplementationGuide.statusrequiredPublicationStatus
ImplementationGuide.fhirVersionrequiredFHIRVersion

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)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuide C0..*ImplementationGuideA set of rules about how FHIR is used
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this implementation guide, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the implementation guide
... name ΣC1..1stringName for this implementation guide (computer friendly)
... title Σ0..1stringName for this implementation guide (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... copyright 0..1markdownUse and/or publishing restrictions
... packageId Σ1..1idNPM Package name for IG
... license Σ0..1codeSPDX 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..*codeFHIR Version(s) this Implementation Guide targets
Binding: FHIRVersion (required): All published FHIR Versions.


... dependsOn SΣ0..*BackboneElementAnother Implementation guide this depends on
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri Σ1..1canonical(ImplementationGuide)Identity of the IG that this depends on
.... packageId Σ0..1idNPM Package name for IG this depends on
.... version Σ0..1stringVersion of the IG
... global Σ0..*BackboneElementProfiles that apply globally
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeType this profile applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.

.... profile Σ1..1canonical(StructureDefinition)Profile that all resources must conform to
... definition SC0..1BackboneElementInformation needed to build the IG
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... grouping 0..*BackboneElementGrouping used to present related resources in the IG
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringDescriptive name for the package
..... description 0..1stringHuman readable text describing the package
.... resource 1..*BackboneElementResource in the implementation guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1Reference(Resource)Location of the resource
..... fhirVersion 0..*codeVersions this applies to (if different to IG)
Binding: FHIRVersion (required): All published FHIR Versions.


..... name 0..1stringHuman Name for the resource
..... description 0..1stringReason why included in guide
..... example[x] 0..1Is an example/What is this an example of?
...... exampleBooleanboolean
...... exampleCanonicalcanonical(StructureDefinition)
..... groupingId 0..1idGrouping this is part of
.... page 0..1BackboneElementPage/Section in the Guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name[x] 1..1Where to find that page
...... nameUrlurl
...... nameReferenceReference(Binary)
..... title 1..1stringShort title shown for navigational assistance
..... generation 1..1codehtml | 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..*BackboneElementDefines how IG is built by tools
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeapply | 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..1stringValue for named type
.... template 0..*BackboneElementA template for building resources
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeType of template specified
..... source 1..1stringThe source location for the template
..... scope 0..1stringThe scope in which the template applies
... manifest 0..1BackboneElementInformation about an assembled IG
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... rendering Σ0..1urlLocation of rendered implementation guide
.... resource Σ1..*BackboneElementResource in the implementation guide
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference Σ1..1Reference(Resource)Location of the resource
..... example[x] 0..1Is an example/What is this an example of?
...... exampleBooleanboolean
...... exampleCanonicalcanonical(StructureDefinition)
..... relativePath 0..1urlRelative path for page in IG
.... page 0..*BackboneElementHTML page within the parent IG
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringHTML page name
..... title 0..1stringTitle of the page, for references
..... anchor 0..*stringAnchor available on the page
.... image 0..*stringImage within the IG
.... other 0..*stringAdditional linkable file in IG

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImplementationGuide.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImplementationGuide.statusrequiredPublicationStatus
ImplementationGuide.jurisdictionextensibleJurisdiction ValueSet
ImplementationGuide.licenserequiredSPDXLicense
ImplementationGuide.fhirVersionrequiredFHIRVersion
ImplementationGuide.global.typerequiredResourceType
ImplementationGuide.definition.resource.fhirVersionrequiredFHIRVersion
ImplementationGuide.definition.page.generationrequiredGuidePageGeneration
ImplementationGuide.definition.parameter.coderequiredGuideParameterCode

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)

This structure is derived from ImplementationGuide

Summary

Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron