Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ImplementationGuide | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_ImplementationGuide_R4B | ||
This cross-version profile allows STU3 ImplementationGuide content to be represented via FHIR R4B ImplementationGuide resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ImplementationGuide |
C | 0..* | ImplementationGuide(4.3.0) | A set of rules about how FHIR is used Constraints: ig-0, ig-2 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
| name |
Σ | 1..1 | string | Name for this implementation guide (computer friendly) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| packageId |
Σ | 1..1 | id | NPM Package name for IG |
 fhirVersion |
Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').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 | ImplementationGuide.implicitRules, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.name, ImplementationGuide.status, ImplementationGuide.packageId, ImplementationGuide.fhirVersion | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImplementationGuide.modifierExtension | 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.exists() implies 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)
|
This structure is derived from ImplementationGuide
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide(4.3.0) | A set of rules about how FHIR is used Constraints: ig-0, ig-2 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
  meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
  extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | ||||
| version |
Σ | 0..1 | string | Business version of the implementation guide | ||||
| name |
Σ | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this implementation guide (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the implementation guide | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
  value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
 valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
 valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| packageId |
Σ | 1..1 | id | NPM Package name for IG | ||||
| license |
Σ | 0..1 | code | SPDX license code for this IG (or not-open-source) Binding: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/). | ||||
| fhirVersion |
Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. | ||||
| dependsOn |
Σ | 0..* | BackboneElement | Another Implementation guide this depends on | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
1..1 | code | STU3: reference | inclusion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.dependency.type Binding: R3GuideDependencyTypeForR4B (0.1.0) (required): How a dependency is represented when the guide is published. Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..1 | code | STU3: Type this profiles applies to additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.global.type Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| profile |
Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:profile |
0..1 | Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B(0.1.0) | StructureDefinition) | STU3: profile additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.global.profile Constraints: ext-1 | |||||
| value |
0..1 | canonical | Primitive value for canonical | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| name |
1..1 | string | Descriptive name for the package | |||||
| description |
0..1 | string | Human readable text describing the package | |||||
| resource |
1..* | BackboneElement | Resource in the implementation guide | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:acronym |
0..1 | string | STU3: Short code to identify the resource (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.acronym Constraints: ext-1 | |||||
| extension:exampleFor |
0..1 | Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B(0.1.0) | StructureDefinition) | STU3: Resource this is an example of (if applicable) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.exampleFor Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| reference |
1..1 | Reference(Resource) | Location of the resource | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:source |
1..1 | uri | STU3: source additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.source Constraints: ext-1 | |||||
| extension:sourceAlternateReference |
0..1 | Reference(Resource) | STU3: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| 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) | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:kind |
1..1 | code | STU3: page | example | list | include | directory | dictionary | toc | resource (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.kind Binding: R3GuidePageKindForR4B (0.1.0) (required): The kind of an included page. Constraints: ext-1 | |||||
| extension:type |
0..* | code | STU3: Kind of resource to include in the list (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.type Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| extension:package |
0..* | string | STU3: Name of package to include (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.package Constraints: ext-1 | |||||
| extension:format |
0..1 | code | STU3: Format of the page (e.g. html, markdown, etc.) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.format Constraints: ext-1 | |||||
| extension:page |
0..* | (Complex) | STU3: Nested Pages / Sections (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| name |
1..1 | string | HTML page name | |||||
| title |
0..1 | string | Title of the page, for references | |||||
| anchor |
0..* | string | Anchor available on the page | |||||
| image |
0..* | string | Image within the IG | |||||
| other |
0..* | string | Additional linkable file in IG | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.license | Base | required | SPDXLicense | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.global.type | Base | required | ResourceType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.resource.reference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.resource.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.page.generation | Base | required | GuidePageGeneration | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.parameter.code | Base | required | GuideParameterCode | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ImplementationGuide.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ImplementationGuide.meta, ImplementationGuide.meta.extension, ImplementationGuide.meta.extension:meta, ImplementationGuide.meta.versionId, ImplementationGuide.meta.lastUpdated, ImplementationGuide.meta.source, ImplementationGuide.meta.profile, ImplementationGuide.meta.security, ImplementationGuide.meta.tag, ImplementationGuide.implicitRules, ImplementationGuide.language, ImplementationGuide.text, ImplementationGuide.text.extension, ImplementationGuide.text.extension:text, ImplementationGuide.text.status, ImplementationGuide.text.div, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.version, ImplementationGuide.name, ImplementationGuide.title, ImplementationGuide.status, ImplementationGuide.experimental, ImplementationGuide.date, ImplementationGuide.publisher, ImplementationGuide.contact, ImplementationGuide.contact.extension, ImplementationGuide.contact.extension:contact, ImplementationGuide.contact.name, ImplementationGuide.contact.telecom, ImplementationGuide.description, ImplementationGuide.useContext, ImplementationGuide.useContext.extension, ImplementationGuide.useContext.extension:useContext, ImplementationGuide.useContext.code, ImplementationGuide.useContext.value[x], ImplementationGuide.jurisdiction, ImplementationGuide.copyright, ImplementationGuide.packageId, ImplementationGuide.license, ImplementationGuide.fhirVersion, ImplementationGuide.dependsOn, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.extension:type, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.dependsOn.uri, ImplementationGuide.dependsOn.packageId, ImplementationGuide.dependsOn.version, ImplementationGuide.global, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile, ImplementationGuide.global.profile.extension, ImplementationGuide.global.profile.extension:profile, ImplementationGuide.definition, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.grouping.name, ImplementationGuide.definition.grouping.description, ImplementationGuide.definition.resource, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:acronym, ImplementationGuide.definition.resource.extension:exampleFor, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference, ImplementationGuide.definition.resource.reference.extension, ImplementationGuide.definition.resource.reference.extension:source, ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference, ImplementationGuide.definition.resource.reference.reference, ImplementationGuide.definition.resource.reference.type, ImplementationGuide.definition.resource.reference.identifier, ImplementationGuide.definition.resource.reference.display, ImplementationGuide.definition.resource.fhirVersion, ImplementationGuide.definition.resource.name, ImplementationGuide.definition.resource.description, ImplementationGuide.definition.resource.example[x], ImplementationGuide.definition.resource.groupingId, ImplementationGuide.definition.page, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.page.name[x], ImplementationGuide.definition.page.title, ImplementationGuide.definition.page.generation, ImplementationGuide.definition.page.page, ImplementationGuide.definition.parameter, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code, ImplementationGuide.definition.parameter.value, ImplementationGuide.definition.template, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.definition.template.code, ImplementationGuide.definition.template.source, ImplementationGuide.definition.template.scope, ImplementationGuide.manifest, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.rendering, ImplementationGuide.manifest.resource, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.resource.reference, ImplementationGuide.manifest.resource.example[x], ImplementationGuide.manifest.resource.relativePath, ImplementationGuide.manifest.page, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.extension:kind, ImplementationGuide.manifest.page.extension:type, ImplementationGuide.manifest.page.extension:package, ImplementationGuide.manifest.page.extension:format, ImplementationGuide.manifest.page.extension:page, ImplementationGuide.manifest.page.modifierExtension, ImplementationGuide.manifest.page.name, ImplementationGuide.manifest.page.title, ImplementationGuide.manifest.page.anchor, ImplementationGuide.manifest.image, ImplementationGuide.manifest.other | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImplementationGuide.meta.extension, ImplementationGuide.meta.extension:meta, ImplementationGuide.text.extension, ImplementationGuide.text.extension:text, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.contact.extension, ImplementationGuide.contact.extension:contact, ImplementationGuide.useContext.extension, ImplementationGuide.useContext.extension:useContext, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.extension:type, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile.extension, ImplementationGuide.global.profile.extension:profile, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:acronym, ImplementationGuide.definition.resource.extension:exampleFor, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference.extension, ImplementationGuide.definition.resource.reference.extension:source, ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.extension:kind, ImplementationGuide.manifest.page.extension:type, ImplementationGuide.manifest.page.extension:package, ImplementationGuide.manifest.page.extension:format, ImplementationGuide.manifest.page.extension:page, ImplementationGuide.manifest.page.modifierExtension | 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.exists() implies 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)
|
| txt-1 | error | ImplementationGuide.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ImplementationGuide.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ImplementationGuide
Summary
Mandatory: 0 element(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide(4.3.0) | A set of rules about how FHIR is used Constraints: ig-0, ig-2 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| url |
Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) |
| name |
Σ | 1..1 | string | Name for this implementation guide (computer friendly) |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| packageId |
Σ | 1..1 | id | NPM Package name for IG |
| fhirVersion |
Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').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 | ImplementationGuide.implicitRules, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.name, ImplementationGuide.status, ImplementationGuide.packageId, ImplementationGuide.fhirVersion | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImplementationGuide.modifierExtension | 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.exists() implies 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)
|
Differential View
This structure is derived from ImplementationGuide
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImplementationGuide |
C | 0..* | ImplementationGuide(4.3.0) | A set of rules about how FHIR is used Constraints: ig-0, ig-2 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | ||||
| version |
Σ | 0..1 | string | Business version of the implementation guide | ||||
| name |
Σ | 1..1 | string | Name for this implementation guide (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this implementation guide (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the implementation guide | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
| value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| packageId |
Σ | 1..1 | id | NPM Package name for IG | ||||
| license |
Σ | 0..1 | code | SPDX license code for this IG (or not-open-source) Binding: SPDXLicense (required): The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/). | ||||
| fhirVersion |
Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (required): All published FHIR Versions. | ||||
| dependsOn |
Σ | 0..* | BackboneElement | Another Implementation guide this depends on | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
1..1 | code | STU3: reference | inclusion (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.dependency.type Binding: R3GuideDependencyTypeForR4B (0.1.0) (required): How a dependency is represented when the guide is published. Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..1 | code | STU3: Type this profiles applies to additional codes URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.global.type Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| profile |
Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:profile |
0..1 | Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B(0.1.0) | StructureDefinition) | STU3: profile additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.global.profile Constraints: ext-1 | |||||
| value |
0..1 | canonical | Primitive value for canonical | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| name |
1..1 | string | Descriptive name for the package | |||||
| description |
0..1 | string | Human readable text describing the package | |||||
| resource |
1..* | BackboneElement | Resource in the implementation guide | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:acronym |
0..1 | string | STU3: Short code to identify the resource (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.acronym Constraints: ext-1 | |||||
| extension:exampleFor |
0..1 | Reference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B(0.1.0) | StructureDefinition) | STU3: Resource this is an example of (if applicable) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.exampleFor Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| reference |
1..1 | Reference(Resource) | Location of the resource | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:source |
1..1 | uri | STU3: source additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.package.resource.source Constraints: ext-1 | |||||
| extension:sourceAlternateReference |
0..1 | Reference(Resource) | STU3: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| 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) | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:kind |
1..1 | code | STU3: page | example | list | include | directory | dictionary | toc | resource (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.kind Binding: R3GuidePageKindForR4B (0.1.0) (required): The kind of an included page. Constraints: ext-1 | |||||
| extension:type |
0..* | code | STU3: Kind of resource to include in the list (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.type Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| extension:package |
0..* | string | STU3: Name of package to include (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.package Constraints: ext-1 | |||||
| extension:format |
0..1 | code | STU3: Format of the page (e.g. html, markdown, etc.) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page.format Constraints: ext-1 | |||||
| extension:page |
0..* | (Complex) | STU3: Nested Pages / Sections (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ImplementationGuide.page Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| name |
1..1 | string | HTML page name | |||||
| title |
0..1 | string | Title of the page, for references | |||||
| anchor |
0..* | string | Anchor available on the page | |||||
| image |
0..* | string | Image within the IG | |||||
| other |
0..* | string | Additional linkable file in IG | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImplementationGuide.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.license | Base | required | SPDXLicense | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.global.type | Base | required | ResourceType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.resource.reference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.resource.fhirVersion | Base | required | FHIRVersion | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.page.generation | Base | required | GuidePageGeneration | 📍4.3.0 | FHIR Std. |
| ImplementationGuide.definition.parameter.code | Base | required | GuideParameterCode | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImplementationGuide | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ImplementationGuide.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ImplementationGuide.meta, ImplementationGuide.meta.extension, ImplementationGuide.meta.extension:meta, ImplementationGuide.meta.versionId, ImplementationGuide.meta.lastUpdated, ImplementationGuide.meta.source, ImplementationGuide.meta.profile, ImplementationGuide.meta.security, ImplementationGuide.meta.tag, ImplementationGuide.implicitRules, ImplementationGuide.language, ImplementationGuide.text, ImplementationGuide.text.extension, ImplementationGuide.text.extension:text, ImplementationGuide.text.status, ImplementationGuide.text.div, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.url, ImplementationGuide.version, ImplementationGuide.name, ImplementationGuide.title, ImplementationGuide.status, ImplementationGuide.experimental, ImplementationGuide.date, ImplementationGuide.publisher, ImplementationGuide.contact, ImplementationGuide.contact.extension, ImplementationGuide.contact.extension:contact, ImplementationGuide.contact.name, ImplementationGuide.contact.telecom, ImplementationGuide.description, ImplementationGuide.useContext, ImplementationGuide.useContext.extension, ImplementationGuide.useContext.extension:useContext, ImplementationGuide.useContext.code, ImplementationGuide.useContext.value[x], ImplementationGuide.jurisdiction, ImplementationGuide.copyright, ImplementationGuide.packageId, ImplementationGuide.license, ImplementationGuide.fhirVersion, ImplementationGuide.dependsOn, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.extension:type, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.dependsOn.uri, ImplementationGuide.dependsOn.packageId, ImplementationGuide.dependsOn.version, ImplementationGuide.global, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile, ImplementationGuide.global.profile.extension, ImplementationGuide.global.profile.extension:profile, ImplementationGuide.definition, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.grouping.name, ImplementationGuide.definition.grouping.description, ImplementationGuide.definition.resource, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:acronym, ImplementationGuide.definition.resource.extension:exampleFor, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference, ImplementationGuide.definition.resource.reference.extension, ImplementationGuide.definition.resource.reference.extension:source, ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference, ImplementationGuide.definition.resource.reference.reference, ImplementationGuide.definition.resource.reference.type, ImplementationGuide.definition.resource.reference.identifier, ImplementationGuide.definition.resource.reference.display, ImplementationGuide.definition.resource.fhirVersion, ImplementationGuide.definition.resource.name, ImplementationGuide.definition.resource.description, ImplementationGuide.definition.resource.example[x], ImplementationGuide.definition.resource.groupingId, ImplementationGuide.definition.page, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.page.name[x], ImplementationGuide.definition.page.title, ImplementationGuide.definition.page.generation, ImplementationGuide.definition.page.page, ImplementationGuide.definition.parameter, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.parameter.code, ImplementationGuide.definition.parameter.value, ImplementationGuide.definition.template, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.definition.template.code, ImplementationGuide.definition.template.source, ImplementationGuide.definition.template.scope, ImplementationGuide.manifest, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.rendering, ImplementationGuide.manifest.resource, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.resource.reference, ImplementationGuide.manifest.resource.example[x], ImplementationGuide.manifest.resource.relativePath, ImplementationGuide.manifest.page, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.extension:kind, ImplementationGuide.manifest.page.extension:type, ImplementationGuide.manifest.page.extension:package, ImplementationGuide.manifest.page.extension:format, ImplementationGuide.manifest.page.extension:page, ImplementationGuide.manifest.page.modifierExtension, ImplementationGuide.manifest.page.name, ImplementationGuide.manifest.page.title, ImplementationGuide.manifest.page.anchor, ImplementationGuide.manifest.image, ImplementationGuide.manifest.other | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ImplementationGuide.meta.extension, ImplementationGuide.meta.extension:meta, ImplementationGuide.text.extension, ImplementationGuide.text.extension:text, ImplementationGuide.extension, ImplementationGuide.modifierExtension, ImplementationGuide.contact.extension, ImplementationGuide.contact.extension:contact, ImplementationGuide.useContext.extension, ImplementationGuide.useContext.extension:useContext, ImplementationGuide.dependsOn.extension, ImplementationGuide.dependsOn.extension:type, ImplementationGuide.dependsOn.modifierExtension, ImplementationGuide.global.extension, ImplementationGuide.global.modifierExtension, ImplementationGuide.global.type.extension, ImplementationGuide.global.type.extension:type, ImplementationGuide.global.profile.extension, ImplementationGuide.global.profile.extension:profile, ImplementationGuide.definition.extension, ImplementationGuide.definition.modifierExtension, ImplementationGuide.definition.grouping.extension, ImplementationGuide.definition.grouping.modifierExtension, ImplementationGuide.definition.resource.extension, ImplementationGuide.definition.resource.extension:acronym, ImplementationGuide.definition.resource.extension:exampleFor, ImplementationGuide.definition.resource.modifierExtension, ImplementationGuide.definition.resource.reference.extension, ImplementationGuide.definition.resource.reference.extension:source, ImplementationGuide.definition.resource.reference.extension:sourceAlternateReference, ImplementationGuide.definition.page.extension, ImplementationGuide.definition.page.modifierExtension, ImplementationGuide.definition.parameter.extension, ImplementationGuide.definition.parameter.modifierExtension, ImplementationGuide.definition.template.extension, ImplementationGuide.definition.template.modifierExtension, ImplementationGuide.manifest.extension, ImplementationGuide.manifest.modifierExtension, ImplementationGuide.manifest.resource.extension, ImplementationGuide.manifest.resource.modifierExtension, ImplementationGuide.manifest.page.extension, ImplementationGuide.manifest.page.extension:kind, ImplementationGuide.manifest.page.extension:type, ImplementationGuide.manifest.page.extension:package, ImplementationGuide.manifest.page.extension:format, ImplementationGuide.manifest.page.extension:page, ImplementationGuide.manifest.page.modifierExtension | 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.exists() implies 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)
|
| txt-1 | error | ImplementationGuide.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ImplementationGuide.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ImplementationGuide
Summary
Mandatory: 0 element(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change