This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Vocabulary Work Group | Maturity Level: 3 | Trial Use | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ConceptMap resource.
ConceptMap | |||||||||||||
Element Id | ConceptMap | ||||||||||||
Definition | A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | DomainResource | ||||||||||||
Invariants |
| ||||||||||||
ConceptMap.url | |||||||||||||
Element Id | 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Requirements | Allows the concept map to be referenced by a single globally unique identifier. | ||||||||||||
Summary | true | ||||||||||||
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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. | ||||||||||||
ConceptMap.identifier | |||||||||||||
Element Id | 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. | ||||||||||||
Note | This is a business identifer, not a resource identifier (see discussion) | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Identifier | ||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||
Summary | true | ||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||
ConceptMap.version | |||||||||||||
Element Id | 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. | ||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Summary | true | ||||||||||||
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 reference to a particular business version of the concept map with the format [url]|[version]. | ||||||||||||
ConceptMap.name | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||
Summary | true | ||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||
Invariants |
| ||||||||||||
ConceptMap.title | |||||||||||||
Element Id | ConceptMap.title | ||||||||||||
Definition | A short, descriptive, user-friendly title for the concept map. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Summary | true | ||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||
ConceptMap.status | |||||||||||||
Element Id | ConceptMap.status | ||||||||||||
Definition | The status of this concept map. Enables tracking the life-cycle of the content. | ||||||||||||
Control | 1..1 | ||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||
Summary | true | ||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||
ConceptMap.experimental | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map. | ||||||||||||
Summary | true | ||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||
ConceptMap.date | |||||||||||||
Element Id | ConceptMap.date | ||||||||||||
Definition | The date (and optionally time) when the concept map was published. The date must change 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Alternate Names | Revision Date | ||||||||||||
Summary | true | ||||||||||||
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. | ||||||||||||
ConceptMap.publisher | |||||||||||||
Element Id | ConceptMap.publisher | ||||||||||||
Definition | The name of the organization or individual that published the concept map. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Helps establish the "authority/credibility" of the concept map. May also allow for contact. | ||||||||||||
Summary | true | ||||||||||||
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. | ||||||||||||
ConceptMap.contact | |||||||||||||
Element Id | ConceptMap.contact | ||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||
Control | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Summary | true | ||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||
ConceptMap.description | |||||||||||||
Element Id | ConceptMap.description | ||||||||||||
Definition | A free text natural language description of the concept map from a consumer's perspective. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
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. | ||||||||||||
ConceptMap.useContext | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | UsageContext | ||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||
Summary | true | ||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||
ConceptMap.jurisdiction | |||||||||||||
Element Id | ConceptMap.jurisdiction | ||||||||||||
Definition | A legal or geographic region in which the concept map is intended to be used. | ||||||||||||
Control | 0..* | ||||||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||||||
Type | CodeableConcept | ||||||||||||
Summary | true | ||||||||||||
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. | ||||||||||||
ConceptMap.purpose | |||||||||||||
Element Id | ConceptMap.purpose | ||||||||||||
Definition | Explanation of why this concept map is needed and why it has been designed as it has. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
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. | ||||||||||||
ConceptMap.copyright | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
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 | ||||||||||||
Comments | nullFrequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required. | ||||||||||||
ConceptMap.source[x] | |||||||||||||
Element Id | ConceptMap.source[x] | ||||||||||||
Definition | Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri|canonical(ValueSet) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Summary | true | ||||||||||||
Comments | Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, there is no specified context for the map (not recommended). The source value set may select codes from either an explicit (standard or local) or implicit code system. | ||||||||||||
ConceptMap.target[x] | |||||||||||||
Element Id | ConceptMap.target[x] | ||||||||||||
Definition | The target value set provides context for 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri|canonical(ValueSet) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Summary | true | ||||||||||||
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. | ||||||||||||
ConceptMap.group | |||||||||||||
Element Id | ConceptMap.group | ||||||||||||
Definition | A group of mappings that all have the same source and target system. | ||||||||||||
Control | 0..* | ||||||||||||
ConceptMap.group.source | |||||||||||||
Element Id | ConceptMap.group.source | ||||||||||||
Definition | An absolute URI that identifies the source system where the concepts to be mapped are defined. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | This is not needed if the source value set is specified and it contains concepts from only a single system. | ||||||||||||
ConceptMap.group.sourceVersion | |||||||||||||
Element Id | ConceptMap.group.sourceVersion | ||||||||||||
Definition | The specific version of the code system, as determined by the code system authority. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. | ||||||||||||
ConceptMap.group.target | |||||||||||||
Element Id | ConceptMap.group.target | ||||||||||||
Definition | An absolute URI that identifies the target system that the concepts will be mapped to. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element equivalence values are 'unmatched'. | ||||||||||||
ConceptMap.group.targetVersion | |||||||||||||
Element Id | ConceptMap.group.targetVersion | ||||||||||||
Definition | The specific version of the code system, as determined by the code system authority. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. | ||||||||||||
ConceptMap.group.element | |||||||||||||
Element Id | ConceptMap.group.element | ||||||||||||
Definition | Mappings for an individual concept in the source to one or more concepts in the target. | ||||||||||||
Control | 1..* | ||||||||||||
Alternate Names | code; concept; item | ||||||||||||
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. | ||||||||||||
ConceptMap.group.element.code | |||||||||||||
Element Id | ConceptMap.group.element.code | ||||||||||||
Definition | Identity (code or path) or the element/item being mapped. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | code | ||||||||||||
ConceptMap.group.element.display | |||||||||||||
Element Id | ConceptMap.group.element.display | ||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||
ConceptMap.group.element.target | |||||||||||||
Element Id | ConceptMap.group.element.target | ||||||||||||
Definition | A concept from the target value set that this concept maps to. | ||||||||||||
Control | 0..* | ||||||||||||
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. | ||||||||||||
Invariants |
| ||||||||||||
ConceptMap.group.element.target.code | |||||||||||||
Element Id | ConceptMap.group.element.target.code | ||||||||||||
Definition | Identity (code or path) or the element/item that the map refers to. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | code | ||||||||||||
ConceptMap.group.element.target.display | |||||||||||||
Element Id | ConceptMap.group.element.target.display | ||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||
ConceptMap.group.element.target.equivalence | |||||||||||||
Element Id | 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). | ||||||||||||
Control | 1..1 | ||||||||||||
Terminology Binding | ConceptMapEquivalence (Required) | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: Some of the values mean that there is no mapping from the source to the target, particularly 'disjoint', and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between) | ||||||||||||
Comments | This element is labeled as a modifier because it may indicate that a target does not apply. | ||||||||||||
ConceptMap.group.element.target.comment | |||||||||||||
Element Id | ConceptMap.group.element.target.comment | ||||||||||||
Definition | A description of status/issues in mapping that conveys additional information not represented in the structured data. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
ConceptMap.group.element.target.dependsOn | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..* | ||||||||||||
ConceptMap.group.element.target.dependsOn.property | |||||||||||||
Element Id | 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 somewhere that is labeled to correspond with a code system property. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | uri | ||||||||||||
ConceptMap.group.element.target.dependsOn.system | |||||||||||||
Element Id | 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). | ||||||||||||
Control | 0..1 | ||||||||||||
Type | canonical(CodeSystem) | ||||||||||||
Meaning if Missing | The code is in the source (dependsOn) or target (product) system | ||||||||||||
ConceptMap.group.element.target.dependsOn.value | |||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.value | ||||||||||||
Definition | Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | string | ||||||||||||
ConceptMap.group.element.target.dependsOn.display | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||
ConceptMap.group.element.target.product | |||||||||||||
Element Id | 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | See ConceptMap.group.element.target.dependsOn | ||||||||||||
ConceptMap.group.unmapped | |||||||||||||
Element Id | ConceptMap.group.unmapped | ||||||||||||
Definition | What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unamatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched. | ||||||||||||
Control | 0..1 | ||||||||||||
Comments | This only applies if the source code has a system value that matches the system defined for the group. | ||||||||||||
Invariants |
| ||||||||||||
ConceptMap.group.unmapped.mode | |||||||||||||
Element Id | ConceptMap.group.unmapped.mode | ||||||||||||
Definition | Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are 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). | ||||||||||||
Control | 1..1 | ||||||||||||
Terminology Binding | ConceptMapGroupUnmappedMode (Required) | ||||||||||||
Type | code | ||||||||||||
ConceptMap.group.unmapped.code | |||||||||||||
Element Id | ConceptMap.group.unmapped.code | ||||||||||||
Definition | The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | code | ||||||||||||
ConceptMap.group.unmapped.display | |||||||||||||
Element Id | ConceptMap.group.unmapped.display | ||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||
ConceptMap.group.unmapped.url | |||||||||||||
Element Id | ConceptMap.group.unmapped.url | ||||||||||||
Definition | The canonical URI of an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | canonical(ConceptMap) |