Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ImplementationGuide resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |
| Definition | A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. |
| Short | A set of rules about how FHIR is used |
| Control | 1..1 |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. ImplementationGuide.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. ImplementationGuide.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on ImplementationGuide.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. ImplementationGuide.extension:title | |
| Slice Name | title |
| Definition | R4: |
| Short | R4: Name for this implementation guide (human friendly) (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Name for this implementation guide (human friendly) (new)) (Extension Type: string) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. ImplementationGuide.extension:packageId | |
| Slice Name | packageId |
| Definition | R4: |
| Short | R4: NPM Package name for IG (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: NPM Package name for IG (new)) (Extension Type: id) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. ImplementationGuide.extension:license | |
| Slice Name | license |
| Definition | R4: |
| Short | R4: SPDX license code for this IG (or not-open-source) (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: SPDX license code for this IG (or not-open-source) (new)) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. ImplementationGuide.extension:definition | |
| Slice Name | definition |
| Definition | R4: |
| Short | R4: Information needed to build the IG (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Information needed to build the IG (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. ImplementationGuide.extension:page | |
| Slice Name | page |
| Definition | R4: |
| Short | R4: Page/Section in the Guide (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. ImplementationGuide.extension:page | |
| Slice Name | page |
| Definition | R4: |
| Short | R4: Nested Pages / Sections (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. ImplementationGuide.extension:manifest | |
| Slice Name | manifest |
| Definition | R4: |
| Short | R4: Information about an assembled IG (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Information about an assembled IG (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. ImplementationGuide.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 22. ImplementationGuide.url | |
| Definition | An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see Technical and Business Versions. |
| Short | Logical URI to reference this implementation guide (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process. |
| Alternate Names | url, authoritative-url, destination, identity |
| 24. ImplementationGuide.name | |
| Definition | A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Name for this implementation guide (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Support human navigation and code generation. |
| 26. ImplementationGuide.status | |
| Definition | The status of this implementation guide. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of implementation guides that are appropriate for use vs. not. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 28. ImplementationGuide.experimental | |
| Definition | A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| Short | For testing purposes, not real usage |
| Comments | Allows filtering of implementation guide that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental implementation guide in production. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |
| 2. ImplementationGuide.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. ImplementationGuide.extension:title | |
| Slice Name | title |
| Definition | R4: |
| Short | R4: Name for this implementation guide (human friendly) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Name for this implementation guide (human friendly) (new)) (Extension Type: string) |
| 6. ImplementationGuide.extension:packageId | |
| Slice Name | packageId |
| Definition | R4: |
| Short | R4: NPM Package name for IG (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4: NPM Package name for IG (new)) (Extension Type: id) |
| 8. ImplementationGuide.extension:license | |
| Slice Name | license |
| Definition | R4: |
| Short | R4: SPDX license code for this IG (or not-open-source) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: SPDX license code for this IG (or not-open-source) (new)) (Extension Type: code) |
| 10. ImplementationGuide.extension:definition | |
| Slice Name | definition |
| Definition | R4: |
| Short | R4: Information needed to build the IG (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Information needed to build the IG (new)) (Complex Extension) |
| 12. ImplementationGuide.extension:page | |
| Slice Name | page |
| Definition | R4: |
| Short | R4: Page/Section in the Guide (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) |
| 14. ImplementationGuide.extension:page | |
| Slice Name | page |
| Definition | R4: |
| Short | R4: Nested Pages / Sections (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) |
| 16. ImplementationGuide.extension:manifest | |
| Slice Name | manifest |
| Definition | R4: |
| Short | R4: Information about an assembled IG (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Information about an assembled IG (new)) (Complex Extension) |
| 18. ImplementationGuide.fhirVersion | |
| 20. ImplementationGuide.fhirVersion.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.fhirVersion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. ImplementationGuide.fhirVersion.extension:fhirVersion | |
| Slice Name | fhirVersion |
| Definition | R4: |
| Short | R4: FHIR Version(s) this Implementation Guide targets additional types |
| Comments | Element |
| Control | 1..* |
| Type | Extension(R4: FHIR Version(s) this Implementation Guide targets additional types) (Extension Type: code) |
| 24. ImplementationGuide.global | |
| 26. ImplementationGuide.global.type | |
| 28. ImplementationGuide.global.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. ImplementationGuide.global.type.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Type this profile applies to |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Type this profile applies to) (Extension Type: code) |
| 32. ImplementationGuide.global.profile | |
| 34. ImplementationGuide.global.profile.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ImplementationGuide.global.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. ImplementationGuide.global.profile.extension:profile | |
| Slice Name | profile |
| Definition | R4: |
| Short | R4: profile additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: profile additional types) (Extension Type: uri(Cross-version Profile for R4.StructureDefinition for use in FHIR STU3, StructureDefinition)) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImplementationGuide | |||||
| Definition | A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. | ||||
| Short | A set of rules about how FHIR is used | ||||
| Control | 1..1 | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. ImplementationGuide.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. ImplementationGuide.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. ImplementationGuide.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. ImplementationGuide.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. ImplementationGuide.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. ImplementationGuide.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. ImplementationGuide.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ImplementationGuide.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. ImplementationGuide.extension:title | |||||
| Slice Name | title | ||||
| Definition | R4: | ||||
| Short | R4: Name for this implementation guide (human friendly) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Name for this implementation guide (human friendly) (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. ImplementationGuide.extension:packageId | |||||
| Slice Name | packageId | ||||
| Definition | R4: | ||||
| Short | R4: NPM Package name for IG (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: NPM Package name for IG (new)) (Extension Type: id) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. ImplementationGuide.extension:license | |||||
| Slice Name | license | ||||
| Definition | R4: | ||||
| Short | R4: SPDX license code for this IG (or not-open-source) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: SPDX license code for this IG (or not-open-source) (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. ImplementationGuide.extension:definition | |||||
| Slice Name | definition | ||||
| Definition | R4: | ||||
| Short | R4: Information needed to build the IG (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Information needed to build the IG (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. ImplementationGuide.extension:page | |||||
| Slice Name | page | ||||
| Definition | R4: | ||||
| Short | R4: Page/Section in the Guide (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. ImplementationGuide.extension:page | |||||
| Slice Name | page | ||||
| Definition | R4: | ||||
| Short | R4: Nested Pages / Sections (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Page/Section in the Guide (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. ImplementationGuide.extension:manifest | |||||
| Slice Name | manifest | ||||
| Definition | R4: | ||||
| Short | R4: Information about an assembled IG (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Information about an assembled IG (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. ImplementationGuide.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 32. ImplementationGuide.url | |||||
| Definition | An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see Technical and Business Versions. | ||||
| Short | Logical URI to reference this implementation guide (globally unique) | ||||
| Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process. | ||||
| Alternate Names | url, authoritative-url, destination, identity | ||||
| 34. ImplementationGuide.version | |||||
| Definition | The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | ||||
| Short | Business version of the implementation guide | ||||
| Comments | There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the implementation guide with the format [url]|[version]. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 36. ImplementationGuide.name | |||||
| Definition | A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||
| Short | Name for this implementation guide (computer friendly) | ||||
| Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| 38. ImplementationGuide.status | |||||
| Definition | The status of this implementation guide. Enables tracking the life-cycle of the content. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | Allows filtering of implementation guides that are appropriate for use vs. not. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 40. ImplementationGuide.experimental | |||||
| Definition | A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | ||||
| Short | For testing purposes, not real usage | ||||
| Comments | Allows filtering of implementation guide that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental implementation guide in production. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide. | ||||
| 42. ImplementationGuide.date | |||||
| Definition | The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes. | ||||
| Short | Date this was last changed | ||||
| Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| 44. ImplementationGuide.publisher | |||||
| Definition | The name of the individual or organization that published the implementation guide. | ||||
| Short | Name of the publisher (organization or individual) | ||||
| Comments | Usually an organization, but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the implementation guide. This item SHOULD be populated unless the information is available from context. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps establish the "authority/credibility" of the implementation guide. May also allow for contact. | ||||
| 46. ImplementationGuide.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
| Short | Contact details for the publisher | ||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 48. ImplementationGuide.description | |||||
| Definition | A free text natural language description of the implementation guide from a consumer's perspective. | ||||
| Short | Natural language description of the implementation guide | ||||
| Comments | This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 50. ImplementationGuide.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instances. | ||||
| Short | Context the content is intended to support | ||||
| Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| 52. ImplementationGuide.jurisdiction | |||||
| Definition | A legal or geographic region in which the implementation guide is intended to be used. | ||||
| Short | Intended jurisdiction for implementation guide (if applicable) | ||||
| Comments | It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)Countries and regions within which this artifact is targeted for use | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 54. ImplementationGuide.copyright | |||||
| Definition | A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide. | ||||
| Short | Use and/or publishing restrictions | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content. | ||||
| Alternate Names | License, Restrictions | ||||
| 56. ImplementationGuide.fhirVersion | |||||
| Definition | The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.2 for this version. | ||||
| Short | FHIR Version this Implementation Guide targets | ||||
| Comments | An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 58. ImplementationGuide.fhirVersion.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 60. ImplementationGuide.fhirVersion.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ImplementationGuide.fhirVersion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 62. ImplementationGuide.fhirVersion.extension:fhirVersion | |||||
| Slice Name | fhirVersion | ||||
| Definition | R4: | ||||
| Short | R4: FHIR Version(s) this Implementation Guide targets additional types | ||||
| Comments | Element | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: FHIR Version(s) this Implementation Guide targets additional types) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 64. ImplementationGuide.fhirVersion.value | |||||
| Definition | Primitive value for id | ||||
| Short | Primitive value for id | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 66. ImplementationGuide.dependency | |||||
| Definition | Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides. | ||||
| Short | Another Implementation guide this depends on | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 68. ImplementationGuide.dependency.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 70. ImplementationGuide.dependency.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 72. ImplementationGuide.dependency.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 74. ImplementationGuide.dependency.type | |||||
| Definition | How the dependency is represented when the guide is published. | ||||
| Short | reference | inclusion | ||||
| Comments | For information about processing included guides, see [Including Guides]{implementationguide.html#include}. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from GuideDependencyType (required to http://hl7.org/fhir/ValueSet/guide-dependency-type|3.0.2)How a dependency is represented when the guide is published. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 76. ImplementationGuide.dependency.uri | |||||
| Definition | Where the dependency is located. | ||||
| Short | Where to find dependency | ||||
| Comments | When a guide is published, and the type is 'include', this will be a relative reference within the guide. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 78. ImplementationGuide.package | |||||
| Definition | A logical group of resources. Logical groups can be used when building pages. | ||||
| Short | Group of resources as used in .page.package | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 80. ImplementationGuide.package.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 82. ImplementationGuide.package.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 84. ImplementationGuide.package.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 86. ImplementationGuide.package.name | |||||
| Definition | The name for the group, as used in page.package. | ||||
| Short | Name used .page.package | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 88. ImplementationGuide.package.description | |||||
| Definition | Human readable text describing the package. | ||||
| Short | Human readable text describing the package | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 90. ImplementationGuide.package.resource | |||||
| Definition | A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource. | ||||
| Short | Resource in the implementation guide | ||||
| Control | 1..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 92. ImplementationGuide.package.resource.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 94. ImplementationGuide.package.resource.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 96. ImplementationGuide.package.resource.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 98. ImplementationGuide.package.resource.example | |||||
| Definition | Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide. | ||||
| Short | If not an example, has its normal meaning | ||||
| Comments | Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true. | ||||
| Control | 1..1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 100. ImplementationGuide.package.resource.name | |||||
| Definition | A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name). | ||||
| Short | Human Name for the resource | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 102. ImplementationGuide.package.resource.description | |||||
| Definition | A description of the reason that a resource has been included in the implementation guide. | ||||
| Short | Reason why included in guide | ||||
| Comments | This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 104. ImplementationGuide.package.resource.acronym | |||||
| Definition | A short code that may be used to identify the resource throughout the implementation guide. | ||||
| Short | Short code to identify the resource | ||||
| Comments | This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 106. ImplementationGuide.package.resource.source[x] | |||||
| Definition | Where this resource is found. | ||||
| Short | Location of the resource | ||||
| Comments | Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it. | ||||
| Control | 1..1 | ||||
| Type | Choice of: uri, Reference(Resource) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 108. ImplementationGuide.package.resource.exampleFor | |||||
| Definition | Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions. | ||||
| Short | Resource this is an example of (if applicable) | ||||
| Comments | Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse. | ||||
| Control | 0..1 | ||||
| Type | Reference(StructureDefinition) | ||||
| 110. ImplementationGuide.global | |||||
| Definition | A set of profiles that all resources covered by this implementation guide must conform to. | ||||
| Short | Profiles that apply globally | ||||
| Comments | See Default Profiles for a discussion of which resources are 'covered' by an implementation guide. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 112. ImplementationGuide.global.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 114. ImplementationGuide.global.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 116. ImplementationGuide.global.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 118. ImplementationGuide.global.type | |||||
| Definition | The type of resource that all instances must conform to. | ||||
| Short | Type this profiles applies to | ||||
| Comments | The type must match that of the profile that is referred to, but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ResourceType ![]() (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)One of the resource types defined as part of FHIR. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 120. ImplementationGuide.global.type.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 122. ImplementationGuide.global.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ImplementationGuide.global.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. ImplementationGuide.global.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R4: | ||||
| Short | R4: Type this profile applies to | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Type this profile applies to) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 126. ImplementationGuide.global.type.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 128. ImplementationGuide.global.profile | |||||
| Definition | A reference to the profile that all instances must conform to. | ||||
| Short | Profile that all resources must conform to | ||||
| Control | 1..1 | ||||
| Type | Reference(StructureDefinition) | ||||
| Summary | true | ||||
| 130. ImplementationGuide.global.profile.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 132. ImplementationGuide.global.profile.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ImplementationGuide.global.profile.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 134. ImplementationGuide.global.profile.extension:profile | |||||
| Slice Name | profile | ||||
| Definition | R4: | ||||
| Short | R4: profile additional types | ||||
| Comments | Element | ||||
| Control | 1..1 | ||||
| Type | Extension(R4: profile additional types) (Extension Type: uri(Cross-version Profile for R4.StructureDefinition for use in FHIR STU3, StructureDefinition)) | ||||
| 136. ImplementationGuide.global.profile.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 138. ImplementationGuide.global.profile.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 140. ImplementationGuide.global.profile.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 142. ImplementationGuide.binary | |||||
| Definition | A binary file that is included in the implementation guide when it is published. | ||||
| Short | Image, css, script, etc. | ||||
| Comments | This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide. | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 144. ImplementationGuide.page | |||||
| Definition | A page / section in the implementation guide. The root page is the implementation guide home page. | ||||
| Short | Page/Section in the Guide | ||||
| Comments | Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html. | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 146. ImplementationGuide.page.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 148. ImplementationGuide.page.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 150. ImplementationGuide.page.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 152. ImplementationGuide.page.source | |||||
| Definition | The source address for the page. | ||||
| Short | Where to find that page | ||||
| Comments | The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include). | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 154. ImplementationGuide.page.title | |||||
| Definition | A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc. | ||||
| Short | Short title shown for navigational assistance | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 156. ImplementationGuide.page.kind | |||||
| Definition | The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest. | ||||
| Short | page | example | list | include | directory | dictionary | toc | resource | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from GuidePageKind (required to http://hl7.org/fhir/ValueSet/guide-page-kind|3.0.2)The kind of an included page. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 158. ImplementationGuide.page.type | |||||
| Definition | For constructed pages, what kind of resources to include in the list. | ||||
| Short | Kind of resource to include in the list | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from ResourceType ![]() (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)One of the resource types defined as part of FHIR. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 160. ImplementationGuide.page.package | |||||
| Definition | For constructed pages, a list of packages to include in the page (or else empty for everything). | ||||
| Short | Name of package to include | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 162. ImplementationGuide.page.format | |||||
| Definition | The format of the page. | ||||
| Short | Format of the page (e.g. html, markdown, etc.) | ||||
| Comments | This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from (required to http://hl7.org/fhir/ValueSet/mimetypes)The mime type of an attachment. Any valid mime type is allowed. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 164. ImplementationGuide.page.page | |||||
| Definition | Nested Pages/Sections under this page. | ||||
| Short | Nested Pages / Sections | ||||
| Comments | The implementation guide breadcrumbs are generated from this structure. | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/ImplementationGuide#ImplementationGuide.page | ||||