SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/ and changes regularly. See the Directory of published versions
Resource Profile: SMART Guidelines ImplementationGuide
| Official URL: http://smart.who.int/base/StructureDefinition/SGImplementationGuide | Version: 0.3.0 | |||
| Draft as of 2026-10-20 | Computable Name: SGImplementationGuide | |||
Defines the minimum expectations for ImplementationGuide resources used in SMART Guidelines
Usages:
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ImplementationGuide |
C | 1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2, shr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:knowledgeCapability |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
 extension:webSource |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |
 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 |
1..1 | string | Business version of the implementation guide | |
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) |
| title |
1..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 |
1..1 | boolean | For testing purposes, not real usage | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the implementation guide | |
| 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/). Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |
 fhirVersion |
1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍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. |
Constraints
| 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-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)
|
| shr-1 | error | ImplementationGuide | If knowledge capabilities are stated, they SHALL include shareable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
|
This structure is derived from CRMIShareableImplementationGuide
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used | |
 publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| license |
0..1 | code | SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |
 definition |
||||
 Slices for resource |
1..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 resource:ActivityDefinition |
0..* | BackboneElement | Resource in the implementation guide | |
   reference |
1..1 | Reference(SMART Guidelines ActivityDefinition) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ActivityDefinition (extensions allowed) | |
| resource:CodeSystem |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines CodeSystem) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: CodeSystem (extensions allowed) | |
| resource:ConceptMap |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines ConceptMap) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ConceptMap (extensions allowed) | |
| resource:Extension |
0..* | BackboneElement | Resource in the implementation guide | |
| resource:Library |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Library) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Library (extensions allowed) | |
| resource:LogicalModel |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Logical Model) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition (extensions allowed) | |
| resource:Measure |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Measure) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Measure (extensions allowed) | |
| resource:Profile |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines StructureDefinition) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition (extensions allowed) | |
| resource:Questionnaire |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Questionnaire) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Questionnaire (extensions allowed) | |
| resource:StructureMap |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines StructureMap) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureMap (extensions allowed) | |
 resource:ValueSet |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines ValueSet) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ValueSet (extensions allowed) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2, shr-1 | ||||
| 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 | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:versionAlgorithm |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
| extension:webSource |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |||||
| 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 |
1..1 | string | Business version of the implementation guide | |||||
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
1..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 |
1..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
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/). Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |||||
| 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 | |||||
| Slices for resource |
1..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| resource:All Slices |
Content/Rules for all slices | |||||||
| 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 | |||||
| resource:ActivityDefinition |
0..* | 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(SMART Guidelines ActivityDefinition) | Location of the resource | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ActivityDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:CodeSystem |
0..* | 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(SMART Guidelines CodeSystem) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: CodeSystem (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:ConceptMap |
0..* | 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(SMART Guidelines ConceptMap) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ConceptMap (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Extension |
0..* | 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 | |||||
| resource:Library |
0..* | 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(SMART Guidelines Library) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Library (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:LogicalModel |
0..* | 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(SMART Guidelines Logical Model) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Measure |
0..* | 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(SMART Guidelines Measure) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Measure (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Profile |
0..* | 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(SMART Guidelines StructureDefinition) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Questionnaire |
0..* | 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(SMART Guidelines Questionnaire) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Questionnaire (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:StructureMap |
0..* | 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(SMART Guidelines StructureMap) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureMap (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:ValueSet |
0..* | 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(SMART Guidelines ValueSet) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ValueSet (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | ||||||||
Terminology Bindings
| 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.resource:ActivityDefinition.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ActivityDefinition.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:CodeSystem.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:CodeSystem.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ConceptMap.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ConceptMap.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Extension.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Library.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Library.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:LogicalModel.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:LogicalModel.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Measure.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Measure.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Profile.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Profile.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Questionnaire.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Questionnaire.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:StructureMap.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:StructureMap.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ValueSet.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ValueSet.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. |
Constraints
| 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)
|
| shr-1 | error | ImplementationGuide | If knowledge capabilities are stated, they SHALL include shareable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
|
This structure is derived from CRMIShareableImplementationGuide
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
- SMART Guidelines ActivityDefinition (http://smart.who.int/base/StructureDefinition/SGActivityDefinition)
- SMART Guidelines CodeSystem (http://smart.who.int/base/StructureDefinition/SGCodeSystem)
- SMART Guidelines ConceptMap (http://smart.who.int/base/StructureDefinition/SGConceptMap)
- SMART Guidelines Library (http://smart.who.int/base/StructureDefinition/SGLibrary)
- SMART Guidelines Logical Model (http://smart.who.int/base/StructureDefinition/SGLogicalModel)
- SMART Guidelines Measure (http://smart.who.int/base/StructureDefinition/SGMeasure)
- SMART Guidelines StructureDefinition (http://smart.who.int/base/StructureDefinition/SGStructureDefinition)
- SMART Guidelines Questionnaire (http://smart.who.int/base/StructureDefinition/SGQuestionnaire)
- SMART Guidelines StructureMap (http://smart.who.int/base/StructureDefinition/SGStructureMap)
- SMART Guidelines ValueSet (http://smart.who.int/base/StructureDefinition/SGValueSet)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of ImplementationGuide.definition.resource
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
C | 1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2, shr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:knowledgeCapability |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| extension:versionAlgorithm |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |
| extension:webSource |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |
| 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 |
1..1 | string | Business version of the implementation guide | |
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) |
| title |
1..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 |
1..1 | boolean | For testing purposes, not real usage | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the implementation guide | |
| 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/). Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |
| fhirVersion |
1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍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. |
Constraints
| 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-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)
|
| shr-1 | error | ImplementationGuide | If knowledge capabilities are stated, they SHALL include shareable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
|
Differential View
This structure is derived from CRMIShareableImplementationGuide
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| license |
0..1 | code | SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |
| definition |
||||
| Slices for resource |
1..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| resource:ActivityDefinition |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines ActivityDefinition) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ActivityDefinition (extensions allowed) | |
| resource:CodeSystem |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines CodeSystem) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: CodeSystem (extensions allowed) | |
| resource:ConceptMap |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines ConceptMap) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ConceptMap (extensions allowed) | |
| resource:Extension |
0..* | BackboneElement | Resource in the implementation guide | |
| resource:Library |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Library) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Library (extensions allowed) | |
| resource:LogicalModel |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Logical Model) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition (extensions allowed) | |
| resource:Measure |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Measure) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Measure (extensions allowed) | |
| resource:Profile |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines StructureDefinition) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureDefinition (extensions allowed) | |
| resource:Questionnaire |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines Questionnaire) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Questionnaire (extensions allowed) | |
| resource:StructureMap |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines StructureMap) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: StructureMap (extensions allowed) | |
| resource:ValueSet |
0..* | BackboneElement | Resource in the implementation guide | |
| reference |
1..1 | Reference(SMART Guidelines ValueSet) | Location of the resource | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: ValueSet (extensions allowed) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 1..1 | CRMIShareableImplementationGuide | A set of rules about how FHIR is used Constraints: ig-0, ig-2, shr-1 | ||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:knowledgeCapability |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| extension:versionAlgorithm |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
| extension:versionPolicy |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
| extension:webSource |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |||||
| 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 |
1..1 | string | Business version of the implementation guide | |||||
| name |
C | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
1..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 |
1..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
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/). Required Pattern: CC-BY-SA-3.0-IGO (extensions allowed) | |||||
| 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 | |||||
| Slices for resource |
1..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| resource:All Slices |
Content/Rules for all slices | |||||||
| 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 | |||||
| resource:ActivityDefinition |
0..* | 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(SMART Guidelines ActivityDefinition) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ActivityDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:CodeSystem |
0..* | 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(SMART Guidelines CodeSystem) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: CodeSystem (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:ConceptMap |
0..* | 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(SMART Guidelines ConceptMap) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ConceptMap (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Extension |
0..* | 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 | |||||
| resource:Library |
0..* | 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(SMART Guidelines Library) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Library (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:LogicalModel |
0..* | 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(SMART Guidelines Logical Model) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Measure |
0..* | 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(SMART Guidelines Measure) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Measure (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Profile |
0..* | 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(SMART Guidelines StructureDefinition) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:Questionnaire |
0..* | 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(SMART Guidelines Questionnaire) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Questionnaire (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:StructureMap |
0..* | 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(SMART Guidelines StructureMap) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureMap (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | |||||
| resource:ValueSet |
0..* | 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(SMART Guidelines ValueSet) | Location of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: ValueSet (extensions allowed) | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for 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 | ||||||||
Terminology Bindings
| 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.resource:ActivityDefinition.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ActivityDefinition.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:CodeSystem.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:CodeSystem.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ConceptMap.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ConceptMap.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Extension.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Library.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Library.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:LogicalModel.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:LogicalModel.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Measure.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Measure.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Profile.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Profile.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Questionnaire.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:Questionnaire.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:StructureMap.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:StructureMap.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ValueSet.reference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImplementationGuide.definition.resource:ValueSet.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. |
Constraints
| 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)
|
| shr-1 | error | ImplementationGuide | If knowledge capabilities are stated, they SHALL include shareable |
extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
|
This structure is derived from CRMIShareableImplementationGuide
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
- SMART Guidelines ActivityDefinition (http://smart.who.int/base/StructureDefinition/SGActivityDefinition)
- SMART Guidelines CodeSystem (http://smart.who.int/base/StructureDefinition/SGCodeSystem)
- SMART Guidelines ConceptMap (http://smart.who.int/base/StructureDefinition/SGConceptMap)
- SMART Guidelines Library (http://smart.who.int/base/StructureDefinition/SGLibrary)
- SMART Guidelines Logical Model (http://smart.who.int/base/StructureDefinition/SGLogicalModel)
- SMART Guidelines Measure (http://smart.who.int/base/StructureDefinition/SGMeasure)
- SMART Guidelines StructureDefinition (http://smart.who.int/base/StructureDefinition/SGStructureDefinition)
- SMART Guidelines Questionnaire (http://smart.who.int/base/StructureDefinition/SGQuestionnaire)
- SMART Guidelines StructureMap (http://smart.who.int/base/StructureDefinition/SGStructureMap)
- SMART Guidelines ValueSet (http://smart.who.int/base/StructureDefinition/SGValueSet)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of ImplementationGuide.definition.resource
Other representations of profile: CSV, Excel, Schematron