This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Terminology Infrastructure Work Group | Maturity Level: 3 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
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.
A concept map defines a mapping from a set of concepts defined in a code system (commonly referred to as the "system") to one or more concepts defined in other code systems. In the mapping context, a system can be a typical code system based on a recognized standard or local terminology (in any of its forms), or in some cases it may be an "implicit" code system that is not based on a recognized terminology but still represents a set of "concepts" that can be usefully mapped. Mappings are one way - from the source to the target system. In many cases, the reverse mappings are valid, but this cannot be assumed to be the case.
Mappings between code system concepts are only intended to be defined in the context of a particular business usage. The business use case is normally defined by the specification of the source and target value sets. The mappings may be useful in other contexts, but this must be determined based on the context of use and meaning; it cannot be taken for granted automatically. An example where the usage context is important for choosing the correct mapping is mapping from a clinical terminology (e.g. SNOMED CT) to a classification (e.g. ICD-10) for either data analysis or billing. Mappings in the data analysis context would be targeted for an appropriate classification (often at a higher level), whereas in the billing context there may be specific requirements to be met (e.g. leaf level codes only) that could result in multiple mappings for a single source concept and then require additional information beyond the source concept itself in order to select the correct final mapping.
Note that all code systems (explicit or implicit) represented in FHIR have URI identifiers for value sets (also either explicit or implicit) that include the entire code system, and these "all codes" value sets can be used for mappings that are valid in all use contexts that are appropriate for the code system.
Each mapping from a source concept to a target concept includes a relationship
element describing the semantic correspondence between the two (or, in some cases, that there is no valid mapping).
If none of the relationships in ConceptMapRelationship is precise enough, then a ConceptMap.group.element.target.property
data element can be used with
code
value corresponding to the http://hl7.org/fhir/conceptmap-properties#relationshipRefinement
concept (from the ConceptMap Properties code system) and valueCode
or valueCoding
value to indicate the precise relationship.
There can be an element
for each concept or field in the sourceScope
value set or group.source
code system that needs to be mapped.
Each source concept may have multiple targets:
The mapping applies to all members of the expansion of the group.element.valueSet
which
are also within the scope of sourceScope
if specified.
The meaning associated with the use of group.element.valueSet is the same as having individual
group.element.code
mappings for each concept in the expansion of the group.element.valueSet
.
The mapping applies to all members of the expansion of the group.element.target.valueSet
which are
also within the scope of targetScope
if specified.
The meaning associated with the use of group.element.target.valueSet
is the same as having individual
group.element.target.code
mappings for each concept in the expansion of the group.element.target.valueSet
.
The expansion of the group.unmapped.valueSet
value set provides the set of fixed codes to use when the mode = 'fixed'.
All unmapped source codes are then mapped to each of these fixed codes.
There SHOULD be at least one target for each element, but some incomplete concept maps might not have a target for each concept.
A key concept for the ConceptMap resource is the $translate operation. This operation is a formal definition of an API by which a terminology server can allow clients to ask for a translation to be done based on the content in the ConceptMap resource. As such it also provides useful perspective on the operational use of ConceptMap resources in any context.
While ConceptMap
resources are not referred to directly from any other
resource, they may be included and used in ImplementationGuide
resources, and provide background knowledge that is useful in many contexts, including
operations defined in this specification.
In addition to ConceptMap
, there is also the StructureMap
resource. The ConceptMap resource defines relationships between concepts in their own right,
along with grading of their equivalencies, while the StructureMap defines an executable
transform for instances that conform to a known structure.
Both Code System supplements and Concept Maps may be used to define relationships between concepts in different systems. ConceptMaps are assertions of the relationships between different concepts that are associated with particular contexts of use, while CodeSystem supplements are used to define inherent properties and semantics of the concepts in the code system
Further discussion of the issues involved in mapping between concept definition systems can be found in the HL7 v3 Core Principles document and the functionality described in the OMG CTS 2 specification.
Implementation Note: This resource has undergone an extensive redesign between Release 4 and Release 5. Key changes:
- A number of metadata fields have been added (same as CodeSystem and ValueSet)
source
andtarget
were renamed tosourceScope
andtargetScope
for clarityConceptMap.group.element.target.equivalence
has been renamed toConceptMap.group.element.target.relationship
for clarity, and the set of relationship codes has simplified, and the codeumatched
has been moved to thenoMap
elementConceptMap.group.element.target.property
has been added to support providing additional details about the relationship between source and target. Like with CodeSystem and ValueSet, properties are defined usingConceptMap.property
ConceptMap.group.element.target.dependsOn.property
was renamed toConceptMap.group.element.target.dependsOn.attribute
to clarify that these are not properties of the mapping, but additional attributes of the source or target content. The data type was changed fromurl
tocode
which referencesConceptMap.additionalAttribute
to allow for a more concise representation, along with documentationConceptMap.group.element.valueSet
was added to facilitate mapping all concepts from a source value setConceptMap.group.element.target.valueSet
has been added to facilitate mapping to each concept in a target value setrelationship
andvalueSet
have been added to theunmapped
element and some other clarifications have been made
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | TU | DomainResource | A map from one set of concepts to one or more other concepts + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | ΣC | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Business version of the concept map |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) |
title | ΣT | 0..1 | string | Name for this concept map (human friendly) |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | T | 0..1 | markdown | Natural language description of the concept map |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this concept map is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the ConceptMap was approved by publisher | |
lastReviewDate | 0..1 | date | When the ConceptMap was last reviewed by the publisher | |
effectivePeriod | Σ | 0..1 | Period | When the ConceptMap is expected to be used |
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) |
author | 0..* | ContactDetail | Who authored the ConceptMap | |
editor | 0..* | ContactDetail | Who edited the ConceptMap | |
reviewer | 0..* | ContactDetail | Who reviewed the ConceptMap | |
endorser | 0..* | ContactDetail | Who endorsed the ConceptMap | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
property | ΣC | 0..* | BackboneElement | Additional properties of the mapping + Rule: If the property type is code, a system SHALL be specified |
code | Σ | 1..1 | code | Identifies the property on the mappings, and when referred to in the $translate operation |
uri | Σ | 0..1 | uri | Formal identifier for the property |
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys |
type | ΣC | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | code Binding: ConceptMap Property Type (Required) |
system | ΣC | 0..1 | canonical(CodeSystem) | The CodeSystem from which code values come |
additionalAttribute | Σ | 0..* | BackboneElement | Definition of an additional attribute to act as a data source or target |
code | Σ | 1..1 | code | Identifies this additional attribute through this resource |
uri | Σ | 0..1 | uri | Formal identifier for the data element referred to in this attribte |
description | Σ | 0..1 | string | Why the additional attribute is defined, and/or what the data element it refers to is |
type | Σ | 1..1 | code | code | Coding | string | boolean | Quantity Binding: ConceptMap Attribute Type (Required) |
sourceScope[x] | Σ | 0..1 | The source value set that contains the concepts that are being mapped | |
sourceScopeUri | uri | |||
sourceScopeCanonical | canonical(ValueSet) | |||
targetScope[x] | Σ | 0..1 | The target value set which provides context for the mappings | |
targetScopeUri | uri | |||
targetScopeCanonical | canonical(ValueSet) | |||
group | 0..* | BackboneElement | Same source and target systems | |
source | 0..1 | canonical(CodeSystem) | Source system where concepts to be mapped are defined | |
target | 0..1 | canonical(CodeSystem) | Target system that the concepts are to be mapped to | |
element | C | 1..* | BackboneElement | Mappings for a concept from the source set + Rule: If noMap is present, target SHALL NOT be present + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Identifies element being mapped |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of concepts being mapped |
noMap | C | 0..1 | boolean | No mapping to a target concept for this source concept |
target | C | 0..* | BackboneElement | Concept in target system for element + Rule: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Code that identifies the target element |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of target concepts |
relationship | ?!C | 1..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
comment | C | 0..1 | string | Description of status/issues in mapping |
property | 0..* | BackboneElement | Property value for the source -> target mapping | |
code | 1..1 | code | Reference to ConceptMap.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueCode | code | |||
dependsOn | C | 0..* | BackboneElement | Other properties required for this mapping + Rule: One of value[x] or valueSet must exist, but not both. |
attribute | 1..1 | code | A reference to a mapping attribute defined in ConceptMap.additionalAttribute | |
value[x] | C | 0..1 | Value of the referenced data element | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueSet | C | 0..1 | canonical(ValueSet) | The mapping depends on a data element with a value from this value set |
product | 0..* | see dependsOn | Other data elements that this mapping also produces | |
unmapped | C | 0..1 | BackboneElement | What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true + Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both. + Rule: If the mode is 'other-map', a url for the other map must be provided + Rule: If the mode is not 'fixed', code, display and valueSet are not allowed + Rule: If the mode is not 'other-map', relationship must be provided + Rule: If the mode is not 'other-map', otherMap is not allowed |
mode | C | 1..1 | code | use-source-code | fixed | other-map Binding: Concept Map Group Unmapped Mode (Required) |
code | C | 0..1 | code | Fixed code when mode = fixed |
display | C | 0..1 | string | Display for the code |
valueSet | C | 0..1 | canonical(ValueSet) | Fixed code set when mode = fixed |
relationship | ?!C | 0..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
otherMap | C | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<ConceptMap xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the concept map --></identifier> <version value="[string]"/><!-- 0..1 Business version of the concept map --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this concept map (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this concept map (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the ConceptMap was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the ConceptMap was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the ConceptMap is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- 0..* ContactDetail Who authored the ConceptMap --></author> <editor><!-- 0..* ContactDetail Who edited the ConceptMap --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the ConceptMap --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the ConceptMap --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <property> <!-- 0..* Additional properties of the mapping --> <code value="[code]"/><!-- 1..1 Identifies the property on the mappings, and when referred to in the $translate operation --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the property --> <description value="[string]"/><!-- 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- I 1..1 Coding | string | integer | boolean | dateTime | decimal | code --> <system><!-- I 0..1 canonical(CodeSystem) The CodeSystem from which code values come --></system> </property> <additionalAttribute> <!-- 0..* Definition of an additional attribute to act as a data source or target --> <code value="[code]"/><!-- 1..1 Identifies this additional attribute through this resource --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the data element referred to in this attribte --> <description value="[string]"/><!-- 0..1 Why the additional attribute is defined, and/or what the data element it refers to is --> <type value="[code]"/><!-- 1..1 code | Coding | string | boolean | Quantity --> </additionalAttribute> <sourceScope[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></sourceScope[x]> <targetScope[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></targetScope[x]> <group> <!-- 0..* Same source and target systems --> <source><!-- 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined --></source> <target><!-- 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to --></target> <element> <!-- 1..* Mappings for a concept from the source set --> <code value="[code]"/><!-- I 0..1 Identifies element being mapped --> <display value="[string]"/><!-- 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of concepts being mapped --></valueSet> <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept --> <target> <!-- I 0..* Concept in target system for element --> <code value="[code]"/><!-- I 0..1 Code that identifies the target element --> <display value="[string]"/><!-- 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of target concepts --></valueSet> <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to --> <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping --> <property> <!-- 0..* Property value for the source -> target mapping --> <code value="[code]"/><!-- 1..1 Reference to ConceptMap.property.code --> <value[x]><!-- 1..1 Coding|string|integer|boolean|dateTime|decimal|code Value of the property for this concept --></value[x]> </property> <dependsOn> <!-- 0..* Other properties required for this mapping --> <attribute value="[code]"/><!-- 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute --> <value[x]><!-- I 0..1 code|Coding|string|boolean|Quantity Value of the referenced data element --></value[x]> <valueSet><!-- I 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set --></valueSet> </dependsOn> <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other data elements that this mapping also produces --></product> </target> </element> <unmapped> <!-- 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true --> <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map --> <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed --> <display value="[string]"/><!-- I 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Fixed code set when mode = fixed --></valueSet> <relationship value="[code]"/><!-- I 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to --> <otherMap><!-- I 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped --></otherMap> </unmapped> </group> </ConceptMap>
JSON Template
{ "resourceType" : "ConceptMap", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this concept map, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the concept map "version" : "<string>", // Business version of the concept map // versionAlgorithm[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", "versionAlgorithmCoding" : { Coding }, "name" : "<string>", // I Name for this concept map (computer friendly) "title" : "<string>", // Name for this concept map (human friendly) "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the concept map "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable) "purpose" : "<markdown>", // Why this concept map is defined "copyright" : "<markdown>", // Use and/or publishing restrictions "copyrightLabel" : "<string>", // Copyright holder and year(s) "approvalDate" : "<date>", // When the ConceptMap was approved by publisher "lastReviewDate" : "<date>", // When the ConceptMap was last reviewed by the publisher "effectivePeriod" : { Period }, // When the ConceptMap is expected to be used "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // Who authored the ConceptMap "editor" : [{ ContactDetail }], // Who edited the ConceptMap "reviewer" : [{ ContactDetail }], // Who reviewed the ConceptMap "endorser" : [{ ContactDetail }], // Who endorsed the ConceptMap "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "property" : [{ // Additional properties of the mapping "code" : "<code>", // R! Identifies the property on the mappings, and when referred to in the $translate operation "uri" : "<uri>", // Formal identifier for the property "description" : "<string>", // Why the property is defined, and/or what it conveys "type" : "<code>", // I R! Coding | string | integer | boolean | dateTime | decimal | code "system" : "<canonical(CodeSystem)>" // I The CodeSystem from which code values come }], "additionalAttribute" : [{ // Definition of an additional attribute to act as a data source or target "code" : "<code>", // R! Identifies this additional attribute through this resource "uri" : "<uri>", // Formal identifier for the data element referred to in this attribte "description" : "<string>", // Why the additional attribute is defined, and/or what the data element it refers to is "type" : "<code>" // R! code | Coding | string | boolean | Quantity }], // sourceScope[x]: The source value set that contains the concepts that are being mapped. One of these 2: "sourceScopeUri" : "<uri>", "sourceScopeCanonical" : "<canonical(ValueSet)>", // targetScope[x]: The target value set which provides context for the mappings. One of these 2: "targetScopeUri" : "<uri>", "targetScopeCanonical" : "<canonical(ValueSet)>", "group" : [{ // Same source and target systems "source" : "<canonical(CodeSystem)>", // Source system where concepts to be mapped are defined "target" : "<canonical(CodeSystem)>", // Target system that the concepts are to be mapped to "element" : [{ // R! Mappings for a concept from the source set "code" : "<code>", // I Identifies element being mapped "display" : "<string>", // Display for the code "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of concepts being mapped "noMap" : <boolean>, // I No mapping to a target concept for this source concept "target" : [{ // I Concept in target system for element "code" : "<code>", // I Code that identifies the target element "display" : "<string>", // Display for the code "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of target concepts "relationship" : "<code>", // I R! related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to "comment" : "<string>", // I Description of status/issues in mapping "property" : [{ // Property value for the source -> target mapping "code" : "<code>", // R! Reference to ConceptMap.property.code // value[x]: Value of the property for this concept. One of these 7: "valueCoding" : { Coding }, "valueString" : "<string>", "valueInteger" : <integer>, "valueBoolean" : <boolean>, "valueDateTime" : "<dateTime>", "valueDecimal" : <decimal>, "valueCode" : "<code>" }], "dependsOn" : [{ // Other properties required for this mapping "attribute" : "<code>", // R! A reference to a mapping attribute defined in ConceptMap.additionalAttribute // value[x]: Value of the referenced data element. One of these 5: "valueCode" : "<code>", "valueCoding" : { Coding }, "valueString" : "<string>", "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueSet" : "<canonical(ValueSet)>" // I The mapping depends on a data element with a value from this value set }], "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other data elements that this mapping also produces }] }], "unmapped" : { // What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true "mode" : "<code>", // I R! use-source-code | fixed | other-map "code" : "<code>", // I Fixed code when mode = fixed "display" : "<string>", // I Display for the code "valueSet" : "<canonical(ValueSet)>", // I Fixed code set when mode = fixed "relationship" : "<code>", // I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to "otherMap" : "<canonical(ConceptMap)>" // I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ConceptMap; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the concept map fhir:version [ string ] ; # 0..1 Business version of the concept map # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:string ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this concept map (computer friendly) fhir:title [ string ] ; # 0..1 Name for this concept map (human friendly) fhir:status [ code ] ; # 1..1 I draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the concept map fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for concept map (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this concept map is defined fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the ConceptMap was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the ConceptMap was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the ConceptMap is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the ConceptMap fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the ConceptMap fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the ConceptMap fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the ConceptMap fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:property ( [ # 0..* Additional properties of the mapping fhir:code [ code ] ; # 1..1 Identifies the property on the mappings, and when referred to in the $translate operation fhir:uri [ uri ] ; # 0..1 Formal identifier for the property fhir:description [ string ] ; # 0..1 Why the property is defined, and/or what it conveys fhir:type [ code ] ; # 1..1 I Coding | string | integer | boolean | dateTime | decimal | code fhir:system [ canonical(CodeSystem) ] ; # 0..1 I The CodeSystem from which code values come ] ... ) ; fhir:additionalAttribute ( [ # 0..* Definition of an additional attribute to act as a data source or target fhir:code [ code ] ; # 1..1 Identifies this additional attribute through this resource fhir:uri [ uri ] ; # 0..1 Formal identifier for the data element referred to in this attribte fhir:description [ string ] ; # 0..1 Why the additional attribute is defined, and/or what the data element it refers to is fhir:type [ code ] ; # 1..1 code | Coding | string | boolean | Quantity ] ... ) ; # sourceScope[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2 fhir:sourceScope [ a fhir:uri ; uri ] fhir:sourceScope [ a fhir:canonical ; canonical(ValueSet) ] # targetScope[x] : 0..1 The target value set which provides context for the mappings. One of these 2 fhir:targetScope [ a fhir:uri ; uri ] fhir:targetScope [ a fhir:canonical ; canonical(ValueSet) ] fhir:group ( [ # 0..* Same source and target systems fhir:source [ canonical(CodeSystem) ] ; # 0..1 Source system where concepts to be mapped are defined fhir:target [ canonical(CodeSystem) ] ; # 0..1 Target system that the concepts are to be mapped to fhir:element ( [ # 1..* Mappings for a concept from the source set fhir:code [ code ] ; # 0..1 I Identifies element being mapped fhir:display [ string ] ; # 0..1 Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of concepts being mapped fhir:noMap [ boolean ] ; # 0..1 I No mapping to a target concept for this source concept fhir:target ( [ # 0..* I Concept in target system for element fhir:code [ code ] ; # 0..1 I Code that identifies the target element fhir:display [ string ] ; # 0..1 Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of target concepts fhir:relationship [ code ] ; # 1..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to fhir:comment [ string ] ; # 0..1 I Description of status/issues in mapping fhir:property ( [ # 0..* Property value for the source -> target mapping fhir:code [ code ] ; # 1..1 Reference to ConceptMap.property.code # value[x] : 1..1 Value of the property for this concept. One of these 7 fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:integer ; integer ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:dateTime ; dateTime ] fhir:value [ a fhir:decimal ; decimal ] fhir:value [ a fhir:code ; code ] ] ... ) ; fhir:dependsOn ( [ # 0..* Other properties required for this mapping fhir:attribute [ code ] ; # 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute # value[x] : 0..1 I Value of the referenced data element. One of these 5 fhir:value [ a fhir:code ; code ] fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I The mapping depends on a data element with a value from this value set ] ... ) ; fhir:product ( [ See ConceptMap.group.element.target.dependsOn ] ... ) ; # 0..* Other data elements that this mapping also produces ] ... ) ; ] ... ) ; fhir:unmapped [ # 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true fhir:mode [ code ] ; # 1..1 I use-source-code | fixed | other-map fhir:code [ code ] ; # 0..1 I Fixed code when mode = fixed fhir:display [ string ] ; # 0..1 I Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Fixed code set when mode = fixed fhir:relationship [ code ] ; # 0..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to fhir:otherMap [ canonical(ConceptMap) ] ; # 0..1 I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped ] ; ] ... ) ; ]
Changes from both R4 and R4B
ConceptMap | |
ConceptMap.identifier |
|
ConceptMap.versionAlgorithm[x] |
|
ConceptMap.copyrightLabel |
|
ConceptMap.approvalDate |
|
ConceptMap.lastReviewDate |
|
ConceptMap.effectivePeriod |
|
ConceptMap.topic |
|
ConceptMap.author |
|
ConceptMap.editor |
|
ConceptMap.reviewer |
|
ConceptMap.endorser |
|
ConceptMap.relatedArtifact |
|
ConceptMap.property |
|
ConceptMap.property.code |
|
ConceptMap.property.uri |
|
ConceptMap.property.description |
|
ConceptMap.property.type |
|
ConceptMap.property.system |
|
ConceptMap.additionalAttribute |
|
ConceptMap.additionalAttribute.code |
|
ConceptMap.additionalAttribute.uri |
|
ConceptMap.additionalAttribute.description |
|
ConceptMap.additionalAttribute.type |
|
ConceptMap.sourceScope[x] |
|
ConceptMap.targetScope[x] |
|
ConceptMap.group.source |
|
ConceptMap.group.target |
|
ConceptMap.group.element.valueSet |
|
ConceptMap.group.element.noMap |
|
ConceptMap.group.element.target.valueSet |
|
ConceptMap.group.element.target.relationship |
|
ConceptMap.group.element.target.property |
|
ConceptMap.group.element.target.property.code |
|
ConceptMap.group.element.target.property.value[x] |
|
ConceptMap.group.element.target.dependsOn.attribute |
|
ConceptMap.group.element.target.dependsOn.value[x] |
|
ConceptMap.group.element.target.dependsOn.valueSet |
|
ConceptMap.group.unmapped.mode |
|
ConceptMap.group.unmapped.valueSet |
|
ConceptMap.group.unmapped.relationship |
|
ConceptMap.group.unmapped.otherMap |
|
ConceptMap.source[x] |
|
ConceptMap.target[x] |
|
ConceptMap.group.sourceVersion |
|
ConceptMap.group.targetVersion |
|
ConceptMap.group.element.target.equivalence |
|
ConceptMap.group.element.target.dependsOn.system |
|
ConceptMap.group.element.target.dependsOn.display |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | TU | DomainResource | A map from one set of concepts to one or more other concepts + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | ΣC | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Business version of the concept map |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) |
title | ΣT | 0..1 | string | Name for this concept map (human friendly) |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | T | 0..1 | markdown | Natural language description of the concept map |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this concept map is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the ConceptMap was approved by publisher | |
lastReviewDate | 0..1 | date | When the ConceptMap was last reviewed by the publisher | |
effectivePeriod | Σ | 0..1 | Period | When the ConceptMap is expected to be used |
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) |
author | 0..* | ContactDetail | Who authored the ConceptMap | |
editor | 0..* | ContactDetail | Who edited the ConceptMap | |
reviewer | 0..* | ContactDetail | Who reviewed the ConceptMap | |
endorser | 0..* | ContactDetail | Who endorsed the ConceptMap | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
property | ΣC | 0..* | BackboneElement | Additional properties of the mapping + Rule: If the property type is code, a system SHALL be specified |
code | Σ | 1..1 | code | Identifies the property on the mappings, and when referred to in the $translate operation |
uri | Σ | 0..1 | uri | Formal identifier for the property |
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys |
type | ΣC | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | code Binding: ConceptMap Property Type (Required) |
system | ΣC | 0..1 | canonical(CodeSystem) | The CodeSystem from which code values come |
additionalAttribute | Σ | 0..* | BackboneElement | Definition of an additional attribute to act as a data source or target |
code | Σ | 1..1 | code | Identifies this additional attribute through this resource |
uri | Σ | 0..1 | uri | Formal identifier for the data element referred to in this attribte |
description | Σ | 0..1 | string | Why the additional attribute is defined, and/or what the data element it refers to is |
type | Σ | 1..1 | code | code | Coding | string | boolean | Quantity Binding: ConceptMap Attribute Type (Required) |
sourceScope[x] | Σ | 0..1 | The source value set that contains the concepts that are being mapped | |
sourceScopeUri | uri | |||
sourceScopeCanonical | canonical(ValueSet) | |||
targetScope[x] | Σ | 0..1 | The target value set which provides context for the mappings | |
targetScopeUri | uri | |||
targetScopeCanonical | canonical(ValueSet) | |||
group | 0..* | BackboneElement | Same source and target systems | |
source | 0..1 | canonical(CodeSystem) | Source system where concepts to be mapped are defined | |
target | 0..1 | canonical(CodeSystem) | Target system that the concepts are to be mapped to | |
element | C | 1..* | BackboneElement | Mappings for a concept from the source set + Rule: If noMap is present, target SHALL NOT be present + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Identifies element being mapped |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of concepts being mapped |
noMap | C | 0..1 | boolean | No mapping to a target concept for this source concept |
target | C | 0..* | BackboneElement | Concept in target system for element + Rule: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Code that identifies the target element |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of target concepts |
relationship | ?!C | 1..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
comment | C | 0..1 | string | Description of status/issues in mapping |
property | 0..* | BackboneElement | Property value for the source -> target mapping | |
code | 1..1 | code | Reference to ConceptMap.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueCode | code | |||
dependsOn | C | 0..* | BackboneElement | Other properties required for this mapping + Rule: One of value[x] or valueSet must exist, but not both. |
attribute | 1..1 | code | A reference to a mapping attribute defined in ConceptMap.additionalAttribute | |
value[x] | C | 0..1 | Value of the referenced data element | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueSet | C | 0..1 | canonical(ValueSet) | The mapping depends on a data element with a value from this value set |
product | 0..* | see dependsOn | Other data elements that this mapping also produces | |
unmapped | C | 0..1 | BackboneElement | What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true + Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both. + Rule: If the mode is 'other-map', a url for the other map must be provided + Rule: If the mode is not 'fixed', code, display and valueSet are not allowed + Rule: If the mode is not 'other-map', relationship must be provided + Rule: If the mode is not 'other-map', otherMap is not allowed |
mode | C | 1..1 | code | use-source-code | fixed | other-map Binding: Concept Map Group Unmapped Mode (Required) |
code | C | 0..1 | code | Fixed code when mode = fixed |
display | C | 0..1 | string | Display for the code |
valueSet | C | 0..1 | canonical(ValueSet) | Fixed code set when mode = fixed |
relationship | ?!C | 0..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
otherMap | C | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped |
Documentation for this format |
See the Extensions for this resource
XML Template
<ConceptMap xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the concept map --></identifier> <version value="[string]"/><!-- 0..1 Business version of the concept map --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this concept map (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this concept map (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the ConceptMap was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the ConceptMap was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the ConceptMap is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- 0..* ContactDetail Who authored the ConceptMap --></author> <editor><!-- 0..* ContactDetail Who edited the ConceptMap --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the ConceptMap --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the ConceptMap --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <property> <!-- 0..* Additional properties of the mapping --> <code value="[code]"/><!-- 1..1 Identifies the property on the mappings, and when referred to in the $translate operation --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the property --> <description value="[string]"/><!-- 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- I 1..1 Coding | string | integer | boolean | dateTime | decimal | code --> <system><!-- I 0..1 canonical(CodeSystem) The CodeSystem from which code values come --></system> </property> <additionalAttribute> <!-- 0..* Definition of an additional attribute to act as a data source or target --> <code value="[code]"/><!-- 1..1 Identifies this additional attribute through this resource --> <uri value="[uri]"/><!-- 0..1 Formal identifier for the data element referred to in this attribte --> <description value="[string]"/><!-- 0..1 Why the additional attribute is defined, and/or what the data element it refers to is --> <type value="[code]"/><!-- 1..1 code | Coding | string | boolean | Quantity --> </additionalAttribute> <sourceScope[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></sourceScope[x]> <targetScope[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></targetScope[x]> <group> <!-- 0..* Same source and target systems --> <source><!-- 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined --></source> <target><!-- 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to --></target> <element> <!-- 1..* Mappings for a concept from the source set --> <code value="[code]"/><!-- I 0..1 Identifies element being mapped --> <display value="[string]"/><!-- 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of concepts being mapped --></valueSet> <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept --> <target> <!-- I 0..* Concept in target system for element --> <code value="[code]"/><!-- I 0..1 Code that identifies the target element --> <display value="[string]"/><!-- 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of target concepts --></valueSet> <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to --> <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping --> <property> <!-- 0..* Property value for the source -> target mapping --> <code value="[code]"/><!-- 1..1 Reference to ConceptMap.property.code --> <value[x]><!-- 1..1 Coding|string|integer|boolean|dateTime|decimal|code Value of the property for this concept --></value[x]> </property> <dependsOn> <!-- 0..* Other properties required for this mapping --> <attribute value="[code]"/><!-- 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute --> <value[x]><!-- I 0..1 code|Coding|string|boolean|Quantity Value of the referenced data element --></value[x]> <valueSet><!-- I 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set --></valueSet> </dependsOn> <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other data elements that this mapping also produces --></product> </target> </element> <unmapped> <!-- 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true --> <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map --> <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed --> <display value="[string]"/><!-- I 0..1 Display for the code --> <valueSet><!-- I 0..1 canonical(ValueSet) Fixed code set when mode = fixed --></valueSet> <relationship value="[code]"/><!-- I 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to --> <otherMap><!-- I 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped --></otherMap> </unmapped> </group> </ConceptMap>
JSON Template
{ "resourceType" : "ConceptMap", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this concept map, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the concept map "version" : "<string>", // Business version of the concept map // versionAlgorithm[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", "versionAlgorithmCoding" : { Coding }, "name" : "<string>", // I Name for this concept map (computer friendly) "title" : "<string>", // Name for this concept map (human friendly) "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the concept map "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable) "purpose" : "<markdown>", // Why this concept map is defined "copyright" : "<markdown>", // Use and/or publishing restrictions "copyrightLabel" : "<string>", // Copyright holder and year(s) "approvalDate" : "<date>", // When the ConceptMap was approved by publisher "lastReviewDate" : "<date>", // When the ConceptMap was last reviewed by the publisher "effectivePeriod" : { Period }, // When the ConceptMap is expected to be used "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // Who authored the ConceptMap "editor" : [{ ContactDetail }], // Who edited the ConceptMap "reviewer" : [{ ContactDetail }], // Who reviewed the ConceptMap "endorser" : [{ ContactDetail }], // Who endorsed the ConceptMap "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "property" : [{ // Additional properties of the mapping "code" : "<code>", // R! Identifies the property on the mappings, and when referred to in the $translate operation "uri" : "<uri>", // Formal identifier for the property "description" : "<string>", // Why the property is defined, and/or what it conveys "type" : "<code>", // I R! Coding | string | integer | boolean | dateTime | decimal | code "system" : "<canonical(CodeSystem)>" // I The CodeSystem from which code values come }], "additionalAttribute" : [{ // Definition of an additional attribute to act as a data source or target "code" : "<code>", // R! Identifies this additional attribute through this resource "uri" : "<uri>", // Formal identifier for the data element referred to in this attribte "description" : "<string>", // Why the additional attribute is defined, and/or what the data element it refers to is "type" : "<code>" // R! code | Coding | string | boolean | Quantity }], // sourceScope[x]: The source value set that contains the concepts that are being mapped. One of these 2: "sourceScopeUri" : "<uri>", "sourceScopeCanonical" : "<canonical(ValueSet)>", // targetScope[x]: The target value set which provides context for the mappings. One of these 2: "targetScopeUri" : "<uri>", "targetScopeCanonical" : "<canonical(ValueSet)>", "group" : [{ // Same source and target systems "source" : "<canonical(CodeSystem)>", // Source system where concepts to be mapped are defined "target" : "<canonical(CodeSystem)>", // Target system that the concepts are to be mapped to "element" : [{ // R! Mappings for a concept from the source set "code" : "<code>", // I Identifies element being mapped "display" : "<string>", // Display for the code "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of concepts being mapped "noMap" : <boolean>, // I No mapping to a target concept for this source concept "target" : [{ // I Concept in target system for element "code" : "<code>", // I Code that identifies the target element "display" : "<string>", // Display for the code "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of target concepts "relationship" : "<code>", // I R! related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to "comment" : "<string>", // I Description of status/issues in mapping "property" : [{ // Property value for the source -> target mapping "code" : "<code>", // R! Reference to ConceptMap.property.code // value[x]: Value of the property for this concept. One of these 7: "valueCoding" : { Coding }, "valueString" : "<string>", "valueInteger" : <integer>, "valueBoolean" : <boolean>, "valueDateTime" : "<dateTime>", "valueDecimal" : <decimal>, "valueCode" : "<code>" }], "dependsOn" : [{ // Other properties required for this mapping "attribute" : "<code>", // R! A reference to a mapping attribute defined in ConceptMap.additionalAttribute // value[x]: Value of the referenced data element. One of these 5: "valueCode" : "<code>", "valueCoding" : { Coding }, "valueString" : "<string>", "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueSet" : "<canonical(ValueSet)>" // I The mapping depends on a data element with a value from this value set }], "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other data elements that this mapping also produces }] }], "unmapped" : { // What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true "mode" : "<code>", // I R! use-source-code | fixed | other-map "code" : "<code>", // I Fixed code when mode = fixed "display" : "<string>", // I Display for the code "valueSet" : "<canonical(ValueSet)>", // I Fixed code set when mode = fixed "relationship" : "<code>", // I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to "otherMap" : "<canonical(ConceptMap)>" // I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:ConceptMap; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the concept map fhir:version [ string ] ; # 0..1 Business version of the concept map # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:string ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this concept map (computer friendly) fhir:title [ string ] ; # 0..1 Name for this concept map (human friendly) fhir:status [ code ] ; # 1..1 I draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the concept map fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for concept map (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this concept map is defined fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the ConceptMap was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the ConceptMap was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the ConceptMap is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the ConceptMap fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the ConceptMap fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the ConceptMap fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the ConceptMap fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:property ( [ # 0..* Additional properties of the mapping fhir:code [ code ] ; # 1..1 Identifies the property on the mappings, and when referred to in the $translate operation fhir:uri [ uri ] ; # 0..1 Formal identifier for the property fhir:description [ string ] ; # 0..1 Why the property is defined, and/or what it conveys fhir:type [ code ] ; # 1..1 I Coding | string | integer | boolean | dateTime | decimal | code fhir:system [ canonical(CodeSystem) ] ; # 0..1 I The CodeSystem from which code values come ] ... ) ; fhir:additionalAttribute ( [ # 0..* Definition of an additional attribute to act as a data source or target fhir:code [ code ] ; # 1..1 Identifies this additional attribute through this resource fhir:uri [ uri ] ; # 0..1 Formal identifier for the data element referred to in this attribte fhir:description [ string ] ; # 0..1 Why the additional attribute is defined, and/or what the data element it refers to is fhir:type [ code ] ; # 1..1 code | Coding | string | boolean | Quantity ] ... ) ; # sourceScope[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2 fhir:sourceScope [ a fhir:uri ; uri ] fhir:sourceScope [ a fhir:canonical ; canonical(ValueSet) ] # targetScope[x] : 0..1 The target value set which provides context for the mappings. One of these 2 fhir:targetScope [ a fhir:uri ; uri ] fhir:targetScope [ a fhir:canonical ; canonical(ValueSet) ] fhir:group ( [ # 0..* Same source and target systems fhir:source [ canonical(CodeSystem) ] ; # 0..1 Source system where concepts to be mapped are defined fhir:target [ canonical(CodeSystem) ] ; # 0..1 Target system that the concepts are to be mapped to fhir:element ( [ # 1..* Mappings for a concept from the source set fhir:code [ code ] ; # 0..1 I Identifies element being mapped fhir:display [ string ] ; # 0..1 Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of concepts being mapped fhir:noMap [ boolean ] ; # 0..1 I No mapping to a target concept for this source concept fhir:target ( [ # 0..* I Concept in target system for element fhir:code [ code ] ; # 0..1 I Code that identifies the target element fhir:display [ string ] ; # 0..1 Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of target concepts fhir:relationship [ code ] ; # 1..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to fhir:comment [ string ] ; # 0..1 I Description of status/issues in mapping fhir:property ( [ # 0..* Property value for the source -> target mapping fhir:code [ code ] ; # 1..1 Reference to ConceptMap.property.code # value[x] : 1..1 Value of the property for this concept. One of these 7 fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:integer ; integer ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:dateTime ; dateTime ] fhir:value [ a fhir:decimal ; decimal ] fhir:value [ a fhir:code ; code ] ] ... ) ; fhir:dependsOn ( [ # 0..* Other properties required for this mapping fhir:attribute [ code ] ; # 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute # value[x] : 0..1 I Value of the referenced data element. One of these 5 fhir:value [ a fhir:code ; code ] fhir:value [ a fhir:Coding ; Coding ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I The mapping depends on a data element with a value from this value set ] ... ) ; fhir:product ( [ See ConceptMap.group.element.target.dependsOn ] ... ) ; # 0..* Other data elements that this mapping also produces ] ... ) ; ] ... ) ; fhir:unmapped [ # 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true fhir:mode [ code ] ; # 1..1 I use-source-code | fixed | other-map fhir:code [ code ] ; # 0..1 I Fixed code when mode = fixed fhir:display [ string ] ; # 0..1 I Display for the code fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Fixed code set when mode = fixed fhir:relationship [ code ] ; # 0..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to fhir:otherMap [ canonical(ConceptMap) ] ; # 0..1 I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped ] ; ] ... ) ; ]
Changes from both R4 and R4B
ConceptMap | |
ConceptMap.identifier |
|
ConceptMap.versionAlgorithm[x] |
|
ConceptMap.copyrightLabel |
|
ConceptMap.approvalDate |
|
ConceptMap.lastReviewDate |
|
ConceptMap.effectivePeriod |
|
ConceptMap.topic |
|
ConceptMap.author |
|
ConceptMap.editor |
|
ConceptMap.reviewer |
|
ConceptMap.endorser |
|
ConceptMap.relatedArtifact |
|
ConceptMap.property |
|
ConceptMap.property.code |
|
ConceptMap.property.uri |
|
ConceptMap.property.description |
|
ConceptMap.property.type |
|
ConceptMap.property.system |
|
ConceptMap.additionalAttribute |
|
ConceptMap.additionalAttribute.code |
|
ConceptMap.additionalAttribute.uri |
|
ConceptMap.additionalAttribute.description |
|
ConceptMap.additionalAttribute.type |
|
ConceptMap.sourceScope[x] |
|
ConceptMap.targetScope[x] |
|
ConceptMap.group.source |
|
ConceptMap.group.target |
|
ConceptMap.group.element.valueSet |
|
ConceptMap.group.element.noMap |
|
ConceptMap.group.element.target.valueSet |
|
ConceptMap.group.element.target.relationship |
|
ConceptMap.group.element.target.property |
|
ConceptMap.group.element.target.property.code |
|
ConceptMap.group.element.target.property.value[x] |
|
ConceptMap.group.element.target.dependsOn.attribute |
|
ConceptMap.group.element.target.dependsOn.value[x] |
|
ConceptMap.group.element.target.dependsOn.valueSet |
|
ConceptMap.group.unmapped.mode |
|
ConceptMap.group.unmapped.valueSet |
|
ConceptMap.group.unmapped.relationship |
|
ConceptMap.group.unmapped.otherMap |
|
ConceptMap.source[x] |
|
ConceptMap.target[x] |
|
ConceptMap.group.sourceVersion |
|
ConceptMap.group.targetVersion |
|
ConceptMap.group.element.target.equivalence |
|
ConceptMap.group.element.target.dependsOn.system |
|
ConceptMap.group.element.target.dependsOn.display |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
ConceptMap.versionAlgorithm[x] | VersionAlgorithm | Extensible | Indicates the mechanism used to compare versions to determine which is more current. |
ConceptMap.status | PublicationStatus | Required | The lifecycle status of an artifact. |
ConceptMap.jurisdiction | JurisdictionValueSet | Extensible | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) . |
ConceptMap.topic | DefinitionTopic | Example | High-level categorization of the definition, used for searching, sorting, and filtering. |
ConceptMap.property.type | ConceptMapPropertyType | Required | The type of a ConceptMap mapping property value. |
ConceptMap.additionalAttribute.type | ConceptMapAttributeType | Required | The type of a ConceptMap mapping attribute value. |
ConceptMap.group.element.target.relationship | ConceptMapRelationship | Required | The relationship between concepts. |
ConceptMap.group.unmapped.mode | ConceptMapGroupUnmappedMode | Required | Defines which action to take if there is no match in the group. |
ConceptMap.group.unmapped.relationship | ConceptMapRelationship | Required | The relationship between concepts. |
UniqueKey | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') |
cnl-1 | Warning | ConceptMap.url | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$') |
cmd-1 | Rule | ConceptMap.group.element.target | If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' | comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to')) |
cmd-2 | Rule | ConceptMap.group.unmapped | If the mode is 'fixed', either a code or valueSet must be provided, but not both. | (mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())) |
cmd-3 | Rule | ConceptMap.group.unmapped | If the mode is 'other-map', a url for the other map must be provided | (mode = 'other-map') implies otherMap.exists() |
cmd-4 | Rule | ConceptMap.group.element | If noMap is present, target SHALL NOT be present | (noMap.exists() and noMap=true) implies target.empty() |
cmd-5 | Rule | ConceptMap.group.element | Either code or valueSet SHALL be present but not both. | (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()) |
cmd-6 | Rule | ConceptMap.group.element.target.dependsOn | One of value[x] or valueSet must exist, but not both. | (value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists()) |
cmd-7 | Rule | ConceptMap.group.element.target | Either code or valueSet SHALL be present but not both. | (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()) |
cmd-8 | Rule | ConceptMap.group.unmapped | If the mode is not 'fixed', code, display and valueSet are not allowed | (mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty()) |
cmd-9 | Rule | ConceptMap.group.unmapped | If the mode is not 'other-map', relationship must be provided | (mode != 'other-map') implies relationship.exists() |
cmd-10 | Rule | ConceptMap.group.unmapped | If the mode is not 'other-map', otherMap is not allowed | (mode != 'other-map') implies otherMap.empty() |
cmd-11 | Rule | ConceptMap.property | If the property type is code, a system SHALL be specified | type = 'code' implies system.exists() |
system
, version
and code
elements are the same as used by the Coding data typeelement
for each source concept. if there is more than one, then just as one element
can have multiple targets,
multiple occurrences of element
with the same element.code
simply aggregate their target
elements as if there was only one element
The concept mappings in element
are arranged into groups that share common source/target systems.
These groups have no semantic significance; they exist to make the representation more concise. Concept maps
may contain more than one group with the same source and target - this would be a less concise representation
but may be useful in order to maintain a fixed order for the concepts that are mapped.
Concepts that are labeled as 'unmatched' are considered to be unmatched in the target value set,
irrespective of whether they are contained in a group with a stated target system or not. Groups
that contain no target system may only contained 'unmatched' concepts. There is no difference in
the meaning of an unmatched
target whether or not there is a stated target system.
In the simple case, a mapping is made from one code to another. E.g. from "home address" in one code system to "address - home" in another. But in other cases, the mapping is not a simple one to one mapping. A typical example might be mapping between EHR diagnosis codes whose interpretation depends on the field they occur in in the source data: diagnosis, history, or family history. Furthermore, the target EHR might distinguish diagnosis codes depending on the subject: patient or family. In this case, it is not possible to map just from one code to another. Instead, the mapping might contain entries like this:
Source Concept Details | Relationship | Target Concept Details | ||||
Code from http://example.com/ehr/codes | field (dependsOn) | Code from http://snomed.info/sct | subject (product) | |||
diab | Diabetes | diagnosis | is equivalent to | 73211009 | Diabetes mellitus | patient |
diab | Diabetes | history | is equivalent to | 161445009 | H/O: diabetes mellitus | patient |
diab | Diabetes | family | is equivalent to | 161445009 | H/O: Diabetes mellitus | family |
When attempting to translate the source to the target, an application SHOULD also provide a value for the element(s)
identified in dependsOn.property
so that the correct mapping can be performed.
All dependsOn and product values are included in the output of $translate.
Interpretation and use of these values is based on the definition of the associated property.
The use of valueCode implies the CodeSystem is known from the property definition.
To see real examples of mappings with dependencies, check Specimen Type Mapping and Message ADT A04 to Bundle Mapping.
If there is no explicit mapping for a code - that is, the engine processing the ConceptMap
finds
a group with a matching source system, but not matching element for the code it is translating, processing
proceeds to the unmapped
element that specifies what should happen.
The unmapped element can specify one of the following different actions to take if there is no mapping for a concept:
provided | Use the code source as provided in the $translate request. This is especially useful for translations between versions of the same code system, where only a few codes have changed |
fixed | Use the code (and display) explicitly provided in the group.unmapped . This is useful when there's a fall back general code - especially for classifications |
other-map | Use the map identified by the canonical URL in otherMap . This is useful when a published concept map needs to be varied for a few specific cases on an institutional basis - the
institution can create a simple concept that expresses their special cases, and then refer to the general purpose mappings |
Note that this element is not used when there is an element with a matching code value, and a relationship value of not-related-to.
Implicit concept maps are defined in a specification which references the underlying code system structures or other release data, and includes a prescribed URI pattern to identify the concept map. For example, there are some implicit concept map URI patterns defined for SNOMED CT.
Implicit concept maps allow the URI to serve as the basis for the ConceptMap $translate operation without the need to create a ConceptMap resource instance.
Some advantages of using implicit concept maps are that they may be used:
If there is an explicit concept map resource with the same URI as a known implicit concept map, it SHALL conform the pattern described in the definition of the implicit concept map. It is up to the discretion of the server how to handle explicit instances when it is also able to process requests for the implicit concept map.
Implementation Note: If the relevant server(s) support implicit concept maps, implementers are discouraged from creating their own explicit concept maps with the same URI, as their existence may create confusion.
Implicit concept map URIs can be used anywhere a concept map URI can be used. Support for implicit concept map URI patterns varies across terminology servers. Code system publishers may define implicit concept map URI patterns. FHIR terminology servers might or might not support any or all of these URI patterns. Caution should be exercised when using concept map URI patterns that have not been defined by HL7 or the code system publisher.
The following link describes the currently defined FHIR implicit concept map URL patterns for SNOMED CT:
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
context | token | A use context assigned to the concept map | (ConceptMap.useContext.value.ofType(CodeableConcept)) | 30 Resources |
context-quantity | quantity | A quantity- or range-valued use context assigned to the concept map | (ConceptMap.useContext.value.ofType(Quantity)) | (ConceptMap.useContext.value.ofType(Range)) | 30 Resources |
context-type | token | A type of use context assigned to the concept map | ConceptMap.useContext.code | 30 Resources |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the concept map | On ConceptMap.useContext: context-type: code context-quantity: value.ofType(Quantity) | value.ofType(Range) |
30 Resources |
context-type-value | composite | A use context type and value assigned to the concept map | On ConceptMap.useContext: context-type: code context: value.ofType(CodeableConcept) |
30 Resources |
date | date | The concept map publication date | ConceptMap.date | 30 Resources |
derived-from | reference | A resource that the ConceptMap is derived from | ConceptMap.relatedArtifact.where(type='derived-from').resource (Any) |
10 Resources |
description | string | The description of the concept map | ConceptMap.description | 28 Resources |
effective | date | The time during which the ConceptMap is intended to be in use | ConceptMap.effectivePeriod | 12 Resources |
identifier | token | External identifier for the concept map | ConceptMap.identifier | 36 Resources |
jurisdiction | token | Intended jurisdiction for the concept map | ConceptMap.jurisdiction | 26 Resources |
mapping-property | uri | Other properties required for this mapping | ConceptMap.property.uri | |
name | string | Computationally friendly name of the concept map | ConceptMap.name | 27 Resources |
other-map | reference | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | ConceptMap.group.unmapped.otherMap (ConceptMap) |
|
predecessor | reference | The predecessor of the ConceptMap | ConceptMap.relatedArtifact.where(type='predecessor').resource (Any) |
10 Resources |
publisher | string | Name of the publisher of the concept map | ConceptMap.publisher | 30 Resources |
source-code | token | Identifies elements being mapped | ConceptMap.group.element.code | |
source-group-system | reference | Source system where concepts to be mapped are defined | ConceptMap.group.source (CodeSystem) |
|
source-scope | reference | The source value set that contains the concepts that are being mapped | (ConceptMap.sourceScope as canonical) (ValueSet) |
|
source-scope-uri | uri | The URI for the source value set that contains the concepts being mapped | (ConceptMap.sourceScope as uri) | |
status | token | The current status of the concept map | ConceptMap.status | 36 Resources |
target-code | token | Code that identifies the target element | ConceptMap.group.element.target.code | |
target-group-system | reference | Target system that the concepts are to be mapped to | ConceptMap.group.target (CodeSystem) |
|
target-scope | reference | The target value set which provides context for the mappings | (ConceptMap.targetScope as canonical) (ValueSet) |
|
target-scope-uri | uri | The URI for the target value set that contains the concepts being mapped. | (ConceptMap.targetScope as uri) | |
title | string | The human-friendly name of the concept map | ConceptMap.title | 27 Resources |
topic | token | Topics associated with the ConceptMap | ConceptMap.topic | 10 Resources |
url | uri | The URI that identifies the concept map | ConceptMap.url | 35 Resources |
version | token | The business version of the concept map | ConceptMap.version | 31 Resources |