SMART Base
0.1.1 - ci-build
SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.1 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
Official URL: http://smart.who.int/base/StructureDefinition/SGImplementationGuide | Version: 0.1.1 | |||
Draft as of 2024-06-12 | Computable Name: SGImplementationGuide |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImplementationGuide
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | 0..* | ImplementationGuide | A set of rules about how FHIR is used | |
license | 0..1 | code | SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO | |
definition | ||||
Slices for resource | 0..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() | |
resource:LogicalModel | 0..* | BackboneElement | Resource in the implementation guide | |
reference | 1..1 | Reference(SGLogicalModel) | Location of the resource | |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Required Pattern: StructureDefinition | |
resource:Extension | 0..* | BackboneElement | Resource in the implementation guide | |
resource:Profile | 0..* | BackboneElement | Resource in the implementation guide | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | C | 0..* | ImplementationGuide | A set of rules about how FHIR is used cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ig-2: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
url | ΣC | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
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 |
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 |
fhirVersion | ΣC | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ImplementationGuide.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ImplementationGuide.license | required | Pattern: CC-BY-SA-3.0-IGOhttp://hl7.org/fhir/ValueSet/spdx-license|5.0.0 from the FHIR Standard | |
ImplementationGuide.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ImplementationGuide | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ImplementationGuide.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-2 | error | ImplementationGuide | If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide : definition.resource.fhirVersion.all(%context.fhirVersion contains $this) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImplementationGuide | C | 0..* | ImplementationGuide | A set of rules about how FHIR is used cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ig-2: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | ||||
version | Σ | 0..1 | string | Business version of the implementation guide | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
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/steward (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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this implementation guide is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
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 | ||||
fhirVersion | ΣC | 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 | ||||
reason | 0..1 | markdown | Why dependency exists | |||||
global | Σ | 0..* | BackboneElement | Profiles that apply globally | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | code | Type this profile applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | ||||
definition | C | 0..1 | BackboneElement | Information needed to build the IG ig-1: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
grouping | C | 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 | markdown | Human readable text describing the package | |||||
Slices for resource | C | 0..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() | ||||
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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:LogicalModel | C | 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(SGLogicalModel) | Location of the resource | |||||
id | 0..1 | id | 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition | ||||
identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | ΣC | 0..1 | string | Text alternative for the resource | ||||
fhirVersion | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:Extension | C | 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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:Profile | C | 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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
page | C | 0..1 | BackboneElement | Page/Section in the Guide ig-3: Source must be absent if 'generated' is generated | ||||
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 | ||||
source[x] | C | 0..1 | Source for page | |||||
sourceUrl | url | |||||||
sourceString | string | |||||||
sourceMarkdown | markdown | |||||||
name | 1..1 | url | Name of the page when published | |||||
title | 1..1 | string | Short title shown for navigational assistance | |||||
generation | C | 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 | Coding | Code that identifies parameter Binding: GuideParameterCode (extensible) | |||||
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 | ||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
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 | Conformance | ValueSet / Code | URI |
ImplementationGuide.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ImplementationGuide.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ImplementationGuide.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ImplementationGuide.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ImplementationGuide.license | required | Pattern: CC-BY-SA-3.0-IGOhttp://hl7.org/fhir/ValueSet/spdx-license|5.0.0 from the FHIR Standard | |
ImplementationGuide.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.global.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:LogicalModel.reference.type | extensible | Pattern: StructureDefinitionhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
ImplementationGuide.definition.resource:LogicalModel.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:Extension.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:Profile.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.page.generation | required | GuidePageGenerationhttp://hl7.org/fhir/ValueSet/guide-page-generation|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.parameter.code | extensible | GuideParameterCodehttp://hl7.org/fhir/ValueSet/guide-parameter-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ImplementationGuide | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ImplementationGuide.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-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 one of the versions defined for the Implementation Guide : definition.resource.fhirVersion.all(%context.fhirVersion contains $this) | |
ig-3 | error | ImplementationGuide.definition.page | Source must be absent if 'generated' is generated : generation='generated' implies source.empty() |
This structure is derived from ImplementationGuide
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ImplementationGuide
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | 0..* | ImplementationGuide | A set of rules about how FHIR is used | |
license | 0..1 | code | SPDX license code for this IG (or not-open-source) Required Pattern: CC-BY-SA-3.0-IGO | |
definition | ||||
Slices for resource | 0..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() | |
resource:LogicalModel | 0..* | BackboneElement | Resource in the implementation guide | |
reference | 1..1 | Reference(SGLogicalModel) | Location of the resource | |
type | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Required Pattern: StructureDefinition | |
resource:Extension | 0..* | BackboneElement | Resource in the implementation guide | |
resource:Profile | 0..* | BackboneElement | Resource in the implementation guide | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImplementationGuide | C | 0..* | ImplementationGuide | A set of rules about how FHIR is used cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ig-2: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
url | ΣC | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
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 |
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 |
fhirVersion | ΣC | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ImplementationGuide.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ImplementationGuide.license | required | Pattern: CC-BY-SA-3.0-IGOhttp://hl7.org/fhir/ValueSet/spdx-license|5.0.0 from the FHIR Standard | |
ImplementationGuide.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ImplementationGuide | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ImplementationGuide.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-2 | error | ImplementationGuide | If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide : definition.resource.fhirVersion.all(%context.fhirVersion contains $this) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImplementationGuide | C | 0..* | ImplementationGuide | A set of rules about how FHIR is used cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation ig-2: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | ||||
version | Σ | 0..1 | string | Business version of the implementation guide | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
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/steward (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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this implementation guide is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
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 | ||||
fhirVersion | ΣC | 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 | ||||
reason | 0..1 | markdown | Why dependency exists | |||||
global | Σ | 0..* | BackboneElement | Profiles that apply globally | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | code | Type this profile applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
profile | Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | ||||
definition | C | 0..1 | BackboneElement | Information needed to build the IG ig-1: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
grouping | C | 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 | markdown | Human readable text describing the package | |||||
Slices for resource | C | 0..* | BackboneElement | Resource in the implementation guide Slice: Unordered, Open by profile:reference.resolve() | ||||
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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:LogicalModel | C | 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(SGLogicalModel) | Location of the resource | |||||
id | 0..1 | id | 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: StructureDefinition | ||||
identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | ΣC | 0..1 | string | Text alternative for the resource | ||||
fhirVersion | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:Extension | C | 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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
resource:Profile | C | 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 | C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (required): All published FHIR Versions. | ||||
name | 0..1 | string | Human readable name for the resource | |||||
description | 0..1 | markdown | Reason why included in guide | |||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
groupingId | C | 0..1 | id | Grouping this is part of | ||||
page | C | 0..1 | BackboneElement | Page/Section in the Guide ig-3: Source must be absent if 'generated' is generated | ||||
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 | ||||
source[x] | C | 0..1 | Source for page | |||||
sourceUrl | url | |||||||
sourceString | string | |||||||
sourceMarkdown | markdown | |||||||
name | 1..1 | url | Name of the page when published | |||||
title | 1..1 | string | Short title shown for navigational assistance | |||||
generation | C | 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 | Coding | Code that identifies parameter Binding: GuideParameterCode (extensible) | |||||
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 | ||||
isExample | 0..1 | boolean | Is this an example | |||||
profile | 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | |||||
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 | Conformance | ValueSet / Code | URI |
ImplementationGuide.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ImplementationGuide.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ImplementationGuide.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ImplementationGuide.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ImplementationGuide.license | required | Pattern: CC-BY-SA-3.0-IGOhttp://hl7.org/fhir/ValueSet/spdx-license|5.0.0 from the FHIR Standard | |
ImplementationGuide.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.global.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:LogicalModel.reference.type | extensible | Pattern: StructureDefinitionhttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
ImplementationGuide.definition.resource:LogicalModel.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:Extension.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.resource:Profile.fhirVersion | required | FHIRVersionhttp://hl7.org/fhir/ValueSet/FHIR-version|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.page.generation | required | GuidePageGenerationhttp://hl7.org/fhir/ValueSet/guide-page-generation|5.0.0 from the FHIR Standard | |
ImplementationGuide.definition.parameter.code | extensible | GuideParameterCodehttp://hl7.org/fhir/ValueSet/guide-parameter-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ImplementationGuide | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ImplementationGuide.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-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 one of the versions defined for the Implementation Guide : definition.resource.fhirVersion.all(%context.fhirVersion contains $this) | |
ig-3 | error | ImplementationGuide.definition.page | Source must be absent if 'generated' is generated : generation='generated' implies source.empty() |
This structure is derived from ImplementationGuide
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron