Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ConceptMap resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ConceptMap | |
| Definition | A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models. |
| Short | A map from one set of concepts to one or more other concepts |
| Control | 0..* |
| 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. ConceptMap.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. ConceptMap.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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. ConceptMap.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 8. ConceptMap.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 10. ConceptMap.extension:approvalDate | |
| Slice Name | approvalDate |
| Definition | R5: |
| Short | R5: When the ConceptMap was approved by publisher (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-approvalDate) |
| 12. ConceptMap.extension:lastReviewDate | |
| Slice Name | lastReviewDate |
| Definition | R5: |
| Short | R5: When the ConceptMap was last reviewed by the publisher (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate) |
| 14. ConceptMap.extension:effectivePeriod | |
| Slice Name | effectivePeriod |
| Definition | R5: |
| Short | R5: When the ConceptMap is expected to be used (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod) |
| 16. ConceptMap.extension:topic | |
| Slice Name | topic |
| Definition | R5: |
| Short | R5: E.g. Education, Treatment, Assessment, etc (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-topic) |
| 18. ConceptMap.extension:author | |
| Slice Name | author |
| Definition | R5: |
| Short | R5: Who authored the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-author) |
| 20. ConceptMap.extension:editor | |
| Slice Name | editor |
| Definition | R5: |
| Short | R5: Who edited the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-editor) |
| 22. ConceptMap.extension:reviewer | |
| Slice Name | reviewer |
| Definition | R5: |
| Short | R5: Who reviewed the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-reviewer) |
| 24. ConceptMap.extension:endorser | |
| Slice Name | endorser |
| Definition | R5: |
| Short | R5: Who endorsed the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-endorser) |
| 26. ConceptMap.extension:relatedArtifact | |
| Slice Name | relatedArtifact |
| Definition | R5: |
| Short | R5: Additional documentation, citations, etc (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact) |
| 28. ConceptMap.extension:property | |
| Slice Name | property |
| Definition | R5: |
| Short | R5: Additional properties of the mapping (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Additional properties of the mapping (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. ConceptMap.extension:additionalAttribute | |
| Slice Name | additionalAttribute |
| Definition | R5: |
| Short | R5: Definition of an additional attribute to act as a data source or target (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Definition of an additional attribute to act as a data source or target (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()) |
| 32. ConceptMap.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 |
| 34. ConceptMap.status | |
| Definition | The status of this concept map. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of concept maps 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 |
| 36. ConceptMap.experimental | |
| Definition | A boolean value to indicate that this concept map 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 concept map that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental concept map 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 concept map. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ConceptMap | |
| 2. ConceptMap.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. ConceptMap.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 6. ConceptMap.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 8. ConceptMap.extension:approvalDate | |
| Slice Name | approvalDate |
| Definition | R5: |
| Short | R5: When the ConceptMap was approved by publisher (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-approvalDate) |
| 10. ConceptMap.extension:lastReviewDate | |
| Slice Name | lastReviewDate |
| Definition | R5: |
| Short | R5: When the ConceptMap was last reviewed by the publisher (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate) |
| 12. ConceptMap.extension:effectivePeriod | |
| Slice Name | effectivePeriod |
| Definition | R5: |
| Short | R5: When the ConceptMap is expected to be used (new) |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod) |
| 14. ConceptMap.extension:topic | |
| Slice Name | topic |
| Definition | R5: |
| Short | R5: E.g. Education, Treatment, Assessment, etc (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-topic) |
| 16. ConceptMap.extension:author | |
| Slice Name | author |
| Definition | R5: |
| Short | R5: Who authored the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-author) |
| 18. ConceptMap.extension:editor | |
| Slice Name | editor |
| Definition | R5: |
| Short | R5: Who edited the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-editor) |
| 20. ConceptMap.extension:reviewer | |
| Slice Name | reviewer |
| Definition | R5: |
| Short | R5: Who reviewed the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-reviewer) |
| 22. ConceptMap.extension:endorser | |
| Slice Name | endorser |
| Definition | R5: |
| Short | R5: Who endorsed the ConceptMap (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-endorser) |
| 24. ConceptMap.extension:relatedArtifact | |
| Slice Name | relatedArtifact |
| Definition | R5: |
| Short | R5: Additional documentation, citations, etc (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact) |
| 26. ConceptMap.extension:property | |
| Slice Name | property |
| Definition | R5: |
| Short | R5: Additional properties of the mapping (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Additional properties of the mapping (new)) (Complex Extension) |
| 28. ConceptMap.extension:additionalAttribute | |
| Slice Name | additionalAttribute |
| Definition | R5: |
| Short | R5: Definition of an additional attribute to act as a data source or target (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Definition of an additional attribute to act as a data source or target (new)) (Complex Extension) |
| 30. ConceptMap.contact | |
| 32. ConceptMap.contact.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. ConceptMap.contact.extension:contact | |
| Slice Name | contact |
| Definition | R5: |
| Short | R5: contact additional types |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..* |
| Type | Extension(R5: contact additional types) (Complex Extension) |
| 36. ConceptMap.group | |
| 38. ConceptMap.group.element | |
| 40. ConceptMap.group.element.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.element.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. ConceptMap.group.element.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R5: |
| Short | R5: Identifies the set of concepts being mapped (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Identifies the set of concepts being mapped (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) |
| 44. ConceptMap.group.element.target | |
| 46. ConceptMap.group.element.target.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. ConceptMap.group.element.target.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R5: |
| Short | R5: Identifies the set of target concepts (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Identifies the set of target concepts (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) |
| 50. ConceptMap.group.element.target.extension:property | |
| Slice Name | property |
| Definition | R5: |
| Short | R5: Property value for the source -> target mapping (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Property value for the source -> target mapping (new)) (Complex Extension) |
| 52. ConceptMap.group.element.target.equivalence | |
| 54. ConceptMap.group.element.target.equivalence.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.equivalence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. ConceptMap.group.element.target.equivalence.extension:noMap | |
| Slice Name | noMap |
| Definition | R5: |
| Short | R5: No mapping to a target concept for this source concept additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: No mapping to a target concept for this source concept additional types) (Extension Type: boolean) |
| 58. ConceptMap.group.element.target.dependsOn | |
| 60. ConceptMap.group.element.target.dependsOn.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. ConceptMap.group.element.target.dependsOn.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: Value of the referenced data element additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Value of the referenced data element additional types) (Extension Type: Choice of: Coding, boolean, Quantity) |
| 64. ConceptMap.group.element.target.dependsOn.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R5: |
| Short | R5: The mapping depends on a data element with a value from this value set (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: The mapping depends on a data element with a value from this value set (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) |
| 66. ConceptMap.group.element.target.dependsOn.property | |
| 68. ConceptMap.group.element.target.dependsOn.property.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.property.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. ConceptMap.group.element.target.dependsOn.property.extension:attribute | |
| Slice Name | attribute |
| Definition | R5: |
| Short | R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types) (Extension Type: code) |
| 72. ConceptMap.group.unmapped | |
| 74. ConceptMap.group.unmapped.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.unmapped.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 76. ConceptMap.group.unmapped.extension:valueSet | |
| Slice Name | valueSet |
| Definition | R5: |
| Short | R5: Fixed code set when mode = fixed (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Fixed code set when mode = fixed (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) |
| 78. ConceptMap.group.unmapped.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ConceptMap.group.unmapped.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 80. ConceptMap.group.unmapped.modifierExtension:relationship | |
| Slice Name | relationship |
| Definition | R5: |
| Short | R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)) (Extension Type: code) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ConceptMap | |||||
| Definition | A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models. | ||||
| Short | A map from one set of concepts to one or more other concepts | ||||
| Control | 0..* | ||||
| 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. ConceptMap.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. ConceptMap.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. ConceptMap.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. ConceptMap.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. ConceptMap.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. ConceptMap.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. ConceptMap.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. ConceptMap.extension:versionAlgorithm | |||||
| Slice Name | versionAlgorithm | ||||
| Definition | R5: | ||||
| Short | R5: How to compare versions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) | ||||
| 18. ConceptMap.extension:copyrightLabel | |||||
| Slice Name | copyrightLabel | ||||
| Definition | R5: | ||||
| Short | R5: Copyright holder and year(s) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) | ||||
| 20. ConceptMap.extension:approvalDate | |||||
| Slice Name | approvalDate | ||||
| Definition | R5: | ||||
| Short | R5: When the ConceptMap was approved by publisher (new) | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-approvalDate) | ||||
| 22. ConceptMap.extension:lastReviewDate | |||||
| Slice Name | lastReviewDate | ||||
| Definition | R5: | ||||
| Short | R5: When the ConceptMap was last reviewed by the publisher (new) | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate) | ||||
| 24. ConceptMap.extension:effectivePeriod | |||||
| Slice Name | effectivePeriod | ||||
| Definition | R5: | ||||
| Short | R5: When the ConceptMap is expected to be used (new) | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod) | ||||
| 26. ConceptMap.extension:topic | |||||
| Slice Name | topic | ||||
| Definition | R5: | ||||
| Short | R5: E.g. Education, Treatment, Assessment, etc (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-topic) | ||||
| 28. ConceptMap.extension:author | |||||
| Slice Name | author | ||||
| Definition | R5: | ||||
| Short | R5: Who authored the ConceptMap (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-author) | ||||
| 30. ConceptMap.extension:editor | |||||
| Slice Name | editor | ||||
| Definition | R5: | ||||
| Short | R5: Who edited the ConceptMap (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-editor) | ||||
| 32. ConceptMap.extension:reviewer | |||||
| Slice Name | reviewer | ||||
| Definition | R5: | ||||
| Short | R5: Who reviewed the ConceptMap (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-reviewer) | ||||
| 34. ConceptMap.extension:endorser | |||||
| Slice Name | endorser | ||||
| Definition | R5: | ||||
| Short | R5: Who endorsed the ConceptMap (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-endorser) | ||||
| 36. ConceptMap.extension:relatedArtifact | |||||
| Slice Name | relatedArtifact | ||||
| Definition | R5: | ||||
| Short | R5: Additional documentation, citations, etc (new) | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact) | ||||
| 38. ConceptMap.extension:property | |||||
| Slice Name | property | ||||
| Definition | R5: | ||||
| Short | R5: Additional properties of the mapping (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Additional properties of the mapping (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()) | ||||
| 40. ConceptMap.extension:additionalAttribute | |||||
| Slice Name | additionalAttribute | ||||
| Definition | R5: | ||||
| Short | R5: Definition of an additional attribute to act as a data source or target (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Definition of an additional attribute to act as a data source or target (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()) | ||||
| 42. ConceptMap.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 | ||||
| 44. ConceptMap.url | |||||
| Definition | An absolute URI that is used to identify this concept map 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 concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see Technical and Business Versions. | ||||
| Short | Logical URI to reference this concept map (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 | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the concept map to be referenced by a single globally unique identifier. | ||||
| 46. ConceptMap.identifier | |||||
| Definition | A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||
| Short | Additional identifier for the concept map | ||||
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this concept map outside of FHIR, where it is not possible to use the logical URI. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
| 48. ConceptMap.version | |||||
| Definition | The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map 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 concept map | ||||
| Comments | There may be different concept map 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 concept map 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 | ||||
| 50. ConceptMap.name | |||||
| Definition | A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||
| Short | Name for this concept map (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 | 0..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. | ||||
| 52. ConceptMap.title | |||||
| Definition | A short, descriptive, user-friendly title for the concept map. | ||||
| Short | Name for this concept map (human friendly) | ||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 54. ConceptMap.status | |||||
| Definition | The status of this concept map. Enables tracking the life-cycle of the content. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | Allows filtering of concept maps 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 | ||||
| 56. ConceptMap.experimental | |||||
| Definition | A boolean value to indicate that this concept map 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 concept map that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental concept map 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 concept map. | ||||
| 58. ConceptMap.date | |||||
| Definition | The date (and optionally time) when the concept map 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 concept map 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 concept map. 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 | ||||
| 60. ConceptMap.publisher | |||||
| Definition | The name of the individual or organization that published the concept map. | ||||
| Short | Name of the publisher (organization or individual) | ||||
| Comments | Usually an organization, but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. 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 concept map. 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 concept map. May also allow for contact. | ||||
| 62. ConceptMap.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 | ||||
| 64. ConceptMap.contact.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. | ||||
| 66. ConceptMap.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 68. ConceptMap.contact.extension:contact | |||||
| Slice Name | contact | ||||
| Definition | R5: | ||||
| Short | R5: contact additional types | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..* | ||||
| Type | Extension(R5: contact additional types) (Complex Extension) | ||||
| 70. ConceptMap.contact.name | |||||
| Definition | The name of an individual to contact. | ||||
| Short | Name of an individual to contact | ||||
| Comments | If there is no named individual, the telecom information is for the organization as a whole. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 72. ConceptMap.contact.telecom | |||||
| Definition | The contact details for the individual (if a name was provided) or the organization. | ||||
| Short | Contact details for individual or organization | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Summary | true | ||||
| 74. ConceptMap.description | |||||
| Definition | A free text natural language description of the concept map from a consumer's perspective. | ||||
| Short | Natural language description of the concept map | ||||
| Comments | The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 76. ConceptMap.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 concept map 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. | ||||
| 78. ConceptMap.jurisdiction | |||||
| Definition | A legal or geographic region in which the concept map is intended to be used. | ||||
| Short | Intended jurisdiction for concept map (if applicable) | ||||
| Comments | It may be possible for the concept map 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 | ||||
| 80. ConceptMap.purpose | |||||
| Definition | Explaination of why this concept map is needed and why it has been designed as it has. | ||||
| Short | Why this concept map is defined | ||||
| Comments | This element does not describe the usage of the concept map Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map. | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 82. ConceptMap.copyright | |||||
| Definition | A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map. | ||||
| Short | Use and/or publishing restrictions | ||||
| Comments | null Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required. | ||||
| 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 concept map and/or its content. | ||||
| Alternate Names | License, Restrictions | ||||
| 84. ConceptMap.source[x] | |||||
| Definition | The source value set that specifies the concepts that are being mapped. | ||||
| Short | Identifies the source of the concepts which are being mapped | ||||
| Comments | Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map. | ||||
| Control | 0..1 | ||||
| Type | Choice of: uri, Reference(ValueSet) | ||||
| [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 | ||||
| 86. ConceptMap.target[x] | |||||
| Definition | The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made. | ||||
| Short | Provides context to the mappings | ||||
| Comments | Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map. | ||||
| Control | 0..1 | ||||
| Type | Choice of: uri, Reference(ValueSet) | ||||
| [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 | ||||
| 88. ConceptMap.group | |||||
| Definition | A group of mappings that all have the same source and target system. | ||||
| Short | Same source and target systems | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 90. ConceptMap.group.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. | ||||
| 92. ConceptMap.group.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 | ||||
| 94. ConceptMap.group.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 | ||||
| 96. ConceptMap.group.source | |||||
| Definition | An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system). | ||||
| Short | Code System (if value set crosses code systems) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 98. ConceptMap.group.sourceVersion | |||||
| Definition | The specific version of the code system, as determined by the code system authority. | ||||
| Short | Specific version of the code system | ||||
| Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 100. ConceptMap.group.target | |||||
| Definition | An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems). | ||||
| Short | System of the target (if necessary) | ||||
| Comments | Target may be omitted if all the targget element equivalence values are 'unmatched'. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 102. ConceptMap.group.targetVersion | |||||
| Definition | The specific version of the code system, as determined by the code system authority. | ||||
| Short | Specific version of the code system | ||||
| Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 104. ConceptMap.group.element | |||||
| Definition | Mappings for an individual concept in the source to one or more concepts in the target. | ||||
| Short | Mappings for a concept from the source set | ||||
| Comments | Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies. | ||||
| Control | 1..* | ||||
| Type | BackboneElement | ||||
| Alternate Names | code, concept, item | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 106. ConceptMap.group.element.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. | ||||
| 108. ConceptMap.group.element.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.element.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 110. ConceptMap.group.element.extension:valueSet | |||||
| Slice Name | valueSet | ||||
| Definition | R5: | ||||
| Short | R5: Identifies the set of concepts being mapped (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Identifies the set of concepts being mapped (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) | ||||
| 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()) | ||||
| 112. ConceptMap.group.element.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 | ||||
| 114. ConceptMap.group.element.code | |||||
| Definition | Identity (code or path) or the element/item being mapped. | ||||
| Short | Identifies element being mapped | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 116. ConceptMap.group.element.display | |||||
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||
| Short | Display for the code | ||||
| Comments | The display is ignored when processing the map. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 118. ConceptMap.group.element.target | |||||
| Definition | A concept from the target value set that this concept maps to. | ||||
| Short | Concept in target system for element | ||||
| Comments | Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))cmd-1: If the map is narrower or inexact, there SHALL be some comments ( comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))) | ||||
| 120. ConceptMap.group.element.target.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. | ||||
| 122. ConceptMap.group.element.target.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. ConceptMap.group.element.target.extension:valueSet | |||||
| Slice Name | valueSet | ||||
| Definition | R5: | ||||
| Short | R5: Identifies the set of target concepts (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Identifies the set of target concepts (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) | ||||
| 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. ConceptMap.group.element.target.extension:property | |||||
| Slice Name | property | ||||
| Definition | R5: | ||||
| Short | R5: Property value for the source -> target mapping (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Property value for the source -> target mapping (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()) | ||||
| 128. ConceptMap.group.element.target.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 | ||||
| 130. ConceptMap.group.element.target.code | |||||
| Definition | Identity (code or path) or the element/item that the map refers to. | ||||
| Short | Code that identifies the target element | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 132. ConceptMap.group.element.target.display | |||||
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||
| Short | Display for the code | ||||
| Comments | The display is ignored when processing the map. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 134. ConceptMap.group.element.target.equivalence | |||||
| Definition | The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source). | ||||
| Short | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint | ||||
| Comments | This element is labeled as a modifier because it may indicate that a target does not apply. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ConceptMapEquivalence (required to http://hl7.org/fhir/ValueSet/concept-map-equivalence|3.0.2)The degree of equivalence between concepts. | ||||
| 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 | ||||
| Default Value | equivalent | ||||
| 136. ConceptMap.group.element.target.equivalence.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. | ||||
| 138. ConceptMap.group.element.target.equivalence.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.equivalence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 140. ConceptMap.group.element.target.equivalence.extension:noMap | |||||
| Slice Name | noMap | ||||
| Definition | R5: | ||||
| Short | R5: No mapping to a target concept for this source concept additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: No mapping to a target concept for this source concept additional types) (Extension Type: boolean) | ||||
| 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()) | ||||
| 142. ConceptMap.group.element.target.equivalence.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. | ||||
| 144. ConceptMap.group.element.target.comment | |||||
| Definition | A description of status/issues in mapping that conveys additional information not represented in the structured data. | ||||
| Short | Description of status/issues in mapping | ||||
| Control | 0..1 This element is affected by the following invariants: cmd-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 146. ConceptMap.group.element.target.dependsOn | |||||
| Definition | A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value. | ||||
| Short | Other elements required for this mapping (from context) | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 148. ConceptMap.group.element.target.dependsOn.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. | ||||
| 150. ConceptMap.group.element.target.dependsOn.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 152. ConceptMap.group.element.target.dependsOn.extension:value | |||||
| Slice Name | value | ||||
| Definition | R5: | ||||
| Short | R5: Value of the referenced data element additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Value of the referenced data element additional types) (Extension Type: Choice of: Coding, boolean, Quantity) | ||||
| 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()) | ||||
| 154. ConceptMap.group.element.target.dependsOn.extension:valueSet | |||||
| Slice Name | valueSet | ||||
| Definition | R5: | ||||
| Short | R5: The mapping depends on a data element with a value from this value set (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: The mapping depends on a data element with a value from this value set (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) | ||||
| 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()) | ||||
| 156. ConceptMap.group.element.target.dependsOn.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 | ||||
| 158. ConceptMap.group.element.target.dependsOn.property | |||||
| Definition | A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property. | ||||
| Short | Reference to property mapping depends on | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 160. ConceptMap.group.element.target.dependsOn.property.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. | ||||
| 162. ConceptMap.group.element.target.dependsOn.property.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.property.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 164. ConceptMap.group.element.target.dependsOn.property.extension:attribute | |||||
| Slice Name | attribute | ||||
| Definition | R5: | ||||
| Short | R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute 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()) | ||||
| 166. ConceptMap.group.element.target.dependsOn.property.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for uri | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 168. ConceptMap.group.element.target.dependsOn.system | |||||
| Definition | An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). | ||||
| Short | Code System (if necessary) | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Meaning if Missing | The code is in the source (dependsOn) or target (product) system | ||||
| 170. ConceptMap.group.element.target.dependsOn.code | |||||
| Definition | Identity (code or path) or the element/item/ValueSet that the map depends on / refers to. | ||||
| Short | Value of the referenced element | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 172. ConceptMap.group.element.target.dependsOn.display | |||||
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||
| Short | Display for the code | ||||
| Comments | The display is ignored when processing the map. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 174. ConceptMap.group.element.target.product | |||||
| Definition | A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on. | ||||
| Short | Other concepts that this mapping also produces | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn | ||||
| 176. ConceptMap.group.unmapped | |||||
| Definition | What to do when there is no match in the mappings in the group. | ||||
| Short | When no match in the mappings | ||||
| Comments | This only applies if the source code is in the system defined for the group. | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))cmd-3: If the mode is 'other-map', a code must be provided ( (mode = 'other-map') implies url.exists())cmd-2: If the mode is 'fixed', a code must be provided ( (mode = 'fixed') implies code.exists()) | ||||
| 178. ConceptMap.group.unmapped.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. | ||||
| 180. ConceptMap.group.unmapped.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.unmapped.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 182. ConceptMap.group.unmapped.extension:valueSet | |||||
| Slice Name | valueSet | ||||
| Definition | R5: | ||||
| Short | R5: Fixed code set when mode = fixed (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Fixed code set when mode = fixed (new)) (Extension Type: uri(Cross-version Profile for R5.ValueSet for use in FHIR STU3, ValueSet)) | ||||
| 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()) | ||||
| 184. ConceptMap.group.unmapped.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Slicing | This element introduces a set of slices on ConceptMap.group.unmapped.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 186. ConceptMap.group.unmapped.modifierExtension:relationship | |||||
| Slice Name | relationship | ||||
| Definition | R5: | ||||
| Short | R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)) (Extension Type: code) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| 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()) | ||||
| 188. ConceptMap.group.unmapped.mode | |||||
| Definition | Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL). | ||||
| Short | provided | fixed | other-map | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ConceptMapGroupUnmappedMode (required to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|3.0.2)Defines which action to take if there is no match in the group. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 190. ConceptMap.group.unmapped.code | |||||
| Definition | The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. | ||||
| Short | Fixed code when mode = fixed | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 192. ConceptMap.group.unmapped.display | |||||
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||
| Short | Display for the code | ||||
| Comments | The display is ignored when processing the map. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 194. ConceptMap.group.unmapped.url | |||||
| Definition | The canonical URL of the map to use if this map contains no mapping. | ||||
| Short | Canonical URL for other concept map | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change