Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.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
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computableguideline | Version: 3.0.0-ballot | ||||
| Active as of 2026-11-10 | Computable Name: CPGComputableGuideline | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.43 | |||||
Profile of ImplementationGuide to describe a computable Clinical Practice Guideline
This is a computable artifact profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ImplementationGuide |
C | 0..* | ImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | |
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| 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. | |
  dependsOn |
0..* | BackboneElement | Another Implementation guide this depends on | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 uri |
1..1 | canonical(ImplementationGuide) | Identity of the IG that this depends on | |
 definition |
C | 0..1 | BackboneElement | Information needed to build the IG Constraints: ig-1 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..* | BackboneElement | Resource in the implementation guide | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 reference |
1..1 | Reference(Resource) | Location of the resource | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If 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-4 | error | ImplementationGuide | If 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-5 | error | ImplementationGuide | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImplementationGuide | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ig-0 | warning | ImplementationGuide | Name 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-1 | error | ImplementationGuide.definition | If 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-2 | error | ImplementationGuide | If 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
0..* | ImplementationGuide | A set of rules about how FHIR is used | |
 dependsOn |
0..* | BackboneElement | Another Implementation guide this depends on | |
| definition |
0..1 | BackboneElement | Information needed to build the IG | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | |||||
| version |
0..1 | string | Business version of the implementation guide | |||||
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
0..1 | string | Name for this implementation guide (human friendly) | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
0..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 Constraints: ig-1 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.license | Base | required | SPDXLicense | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.global.type | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.page.generation | Base | required | GuidePageGeneration | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.parameter.code | Base | required | GuideParameterCode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If 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-4 | error | ImplementationGuide | If 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-5 | error | ImplementationGuide | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImplementationGuide | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ig-0 | warning | ImplementationGuide | Name 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-1 | error | ImplementationGuide.definition | If 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-2 | error | ImplementationGuide | If 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | |
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| 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. | |
| dependsOn |
0..* | BackboneElement | Another Implementation guide this depends on | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| uri |
1..1 | canonical(ImplementationGuide) | Identity of the IG that this depends on | |
| definition |
C | 0..1 | BackboneElement | Information needed to build the IG Constraints: ig-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..* | BackboneElement | Resource in the implementation guide | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| reference |
1..1 | Reference(Resource) | Location of the resource | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If 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-4 | error | ImplementationGuide | If 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-5 | error | ImplementationGuide | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImplementationGuide | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ig-0 | warning | ImplementationGuide | Name 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-1 | error | ImplementationGuide.definition | If 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-2 | error | ImplementationGuide | If 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
0..* | ImplementationGuide | A set of rules about how FHIR is used | |
| dependsOn |
0..* | BackboneElement | Another Implementation guide this depends on | |
| definition |
0..1 | BackboneElement | Information needed to build the IG | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | |||||
| version |
0..1 | string | Business version of the implementation guide | |||||
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
0..1 | string | Name for this implementation guide (human friendly) | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
0..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 Constraints: ig-1 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.license | Base | required | SPDXLicense | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.global.type | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.page.generation | Base | required | GuidePageGeneration | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.parameter.code | Base | required | GuideParameterCode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If 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-4 | error | ImplementationGuide | If 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-5 | error | ImplementationGuide | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImplementationGuide | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ig-0 | warning | ImplementationGuide | Name 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-1 | error | ImplementationGuide.definition | If 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-2 | error | ImplementationGuide | If 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
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support.
Package hl7.fhir.uv.cpg#3.0.0-ballot based on FHIR 4.0.1.
Generated
2026-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change