R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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

4.10 Resource ConceptMap - Content

Terminology Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any 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.

4.10.1 Scope and Usage

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.product data element can be used with a child property value of http://hl7.org/fhir/conceptmap-properties#relationshipRefinement (from the ConceptMap Properties code system) and a child valueCode or valueCoding value to indicate the precise relationship. In this case, well-known relationships, such as those from the Simple Knowledge Organization System (SKOS) icon, should be used where possible.

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:

  • because there are multiple possible mappings (e.g., ambiguous)
  • to specify a correct map, and specify other mappings as invalid
  • when there are multiple mappings depending on the values of other elements (dependsOn)

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.

4.10.2 Boundaries and Relationships

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

4.10.3 Background and Context

Further discussion of the issues involved in mapping between concept definition systems can be found in the HL7 v3 Core Principles icon document and the functionality described in the OMG CTS 2 icon specification.

4.10.4 References to this Resource

4.10.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap TUDomainResourceA 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the concept map

... version Σ0..1stringBusiness version of the concept map
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this concept map (computer friendly)
... title ΣT0..1stringName for this concept map (human friendly)
... status ?!ΣC1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this concept map is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the ConceptMap is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the ConceptMap

... editor 0..*ContactDetailWho edited the ConceptMap

... reviewer 0..*ContactDetailWho reviewed the ConceptMap

... endorser 0..*ContactDetailWho endorsed the ConceptMap

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc

... property ΣC0..*BackboneElementAdditional properties of the mapping
+ Rule: If the property type is code, a system SHALL be specified

.... code Σ1..1codeIdentifies the property on the mappings, and when referred to in the $translate operation
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type ΣC1..1codeCoding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMap Property Type (Required)
.... system ΣC0..1canonical(CodeSystem)The CodeSystem from which code values come
... additionalAttribute Σ0..*BackboneElementDefinition of an additional attribute to act as a data source or target

.... code Σ1..1codeIdentifies this additional attribute through this resource
.... uri Σ0..1uriFormal identifier for the data element referred to in this attribte
.... description Σ0..1stringWhy the additional attribute is defined, and/or what the data element it refers to is
.... type Σ1..1codecode | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type (Required)
... sourceScope[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceScopeUriuri
.... sourceScopeCanonicalcanonical(ValueSet)
... targetScope[x] Σ0..1The target value set which provides context for the mappings
.... targetScopeUriuri
.... targetScopeCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems

.... source 0..1canonical(CodeSystem)Source system where concepts to be mapped are defined
.... target 0..1canonical(CodeSystem)Target system that the concepts are to be mapped to
.... element C1..*BackboneElementMappings 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 C0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... valueSet C0..1canonical(ValueSet)Identifies elements being mapped
..... noMap C0..1booleanNo mapping to a target concept for this source concept
..... target C0..*BackboneElementConcept 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 C0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... valueSet C0..1canonical(ValueSet)Identifies the set of target elements
...... relationship ?!C1..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (Required)
...... comment C0..1stringDescription of status/issues in mapping
...... property 0..*BackboneElementProperty value for the source -> target mapping

....... code 1..1codeReference to ConceptMap.property.code
....... value[x] 1..1Value of the property for this concept
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
........ valueCodecode
...... dependsOn C0..*BackboneElementOther properties required for this mapping
+ Rule: One of value[x] or valueSet must exist, but not both.

....... attribute 1..1codeA reference to a mapping attribute defined in ConceptMap.additionalAttribute
....... value[x] C0..1Value of the referenced data element
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueBooleanboolean
........ valueQuantityQuantity
....... valueSet C0..1canonical(ValueSet)The mapping depends on a data element with a value from this value set
...... product 0..*see dependsOnOther data elements that this mapping also produces

.... unmapped C0..1BackboneElementWhat to do when there is no mapping target for the source concept
+ 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 C1..1codeuse-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode (Required)
..... code C0..1codeFixed code when mode = fixed
..... display C0..1stringDisplay for the code
..... valueSet C0..1canonical(ValueSet)Fixed code set when mode = fixed
..... relationship ?!C0..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (Required)
..... otherMap C0..1canonical(ConceptMap)canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ConceptMap (DomainResource) +MetadataResourceAn 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 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 serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which ConceptMap is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the concept maptitle : string [0..1]The status of this concept map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! » « This element has or is affected by some invariantsC »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 usageexperimental : boolean [0..1]The date (and optionally time) when the concept map was last significantly changed. 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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the concept map from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instancesuseContext : UsageContext [0..*]A legal or geographic region in which the concept map is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this concept map is needed and why it has been designed as it haspurpose : markdown [0..1]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 mapcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the ConceptMap content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the ConceptMapauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the ConceptMapeditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMapreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value setsourceScope[x] : PrimitiveType [0..1] « uri|canonical(ValueSet) »Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value settargetScope[x] : PrimitiveType [0..1] « uri|canonical(ValueSet) »PropertyA code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operationcode : code [1..1]Reference to the formal meaning of the propertyuri : uri [0..1]A description of the property - why it is defined, and how its value might be useddescription : string [0..1]The type of the property valuetype : code [1..1] « null (Strength=Required)ConceptMapPropertyType! » « This element has or is affected by some invariantsC »The CodeSystem that defines the codes from which values of type ```code``` in property valuessystem : canonical [0..1] « CodeSystem » « This element has or is affected by some invariantsC »AdditionalAttributeA code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attributecode : code [1..1]Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}uri : uri [0..1]A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data elementdescription : string [0..1]The type of the source data contained in this concept map for this data elementtype : code [1..1] « null (Strength=Required)ConceptMapAttributeType! »GroupAn absolute URI that identifies the source system where the concepts to be mapped are definedsource : canonical [0..1] « CodeSystem »An absolute URI that identifies the target system that the concepts will be mapped totarget : canonical [0..1] « CodeSystem »SourceElementIdentity (code or path) or the element/item being mappedcode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The set of codes being mappedvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »If noMap = true this indicates that no mapping to a target concept exists for this source conceptnoMap : boolean [0..1] « This element has or is affected by some invariantsC »TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The set of codes that the map refers tovalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target) (this element modifies the meaning of other elements)relationship : code [1..1] « null (Strength=Required)ConceptMapRelationship! » « This element has or is affected by some invariantsC »A description of status/issues in mapping that conveys additional information not represented in the structured datacomment : string [0..1] « This element has or is affected by some invariantsC »MappingPropertyA reference to a mapping property defined in ConceptMap.propertycode : code [1..1]The value of this propertyvalue[x] : DataType [1..1] « Coding|string|integer|boolean|dateTime| decimal|code »OtherElementA reference to the additional attribute that holds a value the map depends onattribute : code [1..1]Data element value that the map depends on / producesvalue[x] : DataType [0..1] « code|Coding|string|boolean|Quantity » « This element has or is affected by some invariantsC »This mapping applies if the data element value is a code from this value setvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »UnmappedDefines 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 source 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)mode : code [1..1] « null (Strength=Required)ConceptMapGroupUnmappedMode! » « This element has or is affected by some invariantsC »The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed codecode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1] « This element has or is affected by some invariantsC »The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codesvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code' (this element modifies the meaning of other elements)relationship : code [0..1] « null (Strength=Required)ConceptMapRelationship! » « This element has or is affected by some invariantsC »The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source conceptotherMap : canonical [0..1] « ConceptMap » « This element has or is affected by some invariantsC »A property defines a slot through which additional information can be provided about a map from source -> targetproperty[0..*]An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa)additionalAttribute[0..*]A property value for this source -> target mappingproperty[0..*]A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified valuedependsOn[0..*]Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target dataproduct[0..*]A concept from the target value set that this concept maps totarget[0..*]Mappings for an individual concept in the source to one or more concepts in the targetelement[1..*]What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-tounmapped[0..1]A group of mappings that all have the same source and target systemgroup[0..*]

XML Template

<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- 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 elements 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 elements --></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 -->
   <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

{doco
  "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 elements 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 elements
        "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
      "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/> .doco


[ 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 elements 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 elements
        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
      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 since R4

ConceptMap
ConceptMap.identifier
  • Max Cardinality changed from 1 to *
ConceptMap.versionAlgorithm[x]
  • Added Element
ConceptMap.copyrightLabel
  • Added Element
ConceptMap.approvalDate
  • Added Element
ConceptMap.lastReviewDate
  • Added Element
ConceptMap.effectivePeriod
  • Added Element
ConceptMap.topic
  • Added Element
ConceptMap.author
  • Added Element
ConceptMap.editor
  • Added Element
ConceptMap.reviewer
  • Added Element
ConceptMap.endorser
  • Added Element
ConceptMap.relatedArtifact
  • Added Element
ConceptMap.property
  • Added Element
ConceptMap.property.code
  • Added Mandatory Element
ConceptMap.property.uri
  • Added Element
ConceptMap.property.description
  • Added Element
ConceptMap.property.type
  • Added Mandatory Element
ConceptMap.property.system
  • Added Element
ConceptMap.additionalAttribute
  • Added Element
ConceptMap.additionalAttribute.code
  • Added Mandatory Element
ConceptMap.additionalAttribute.uri
  • Added Element
ConceptMap.additionalAttribute.description
  • Added Element
ConceptMap.additionalAttribute.type
  • Added Mandatory Element
ConceptMap.sourceScope[x]
  • Added Element
ConceptMap.targetScope[x]
  • Added Element
ConceptMap.group.source
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.target
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.element.valueSet
  • Added Element
ConceptMap.group.element.noMap
  • Added Element
ConceptMap.group.element.target.valueSet
  • Added Element
ConceptMap.group.element.target.relationship
  • Added Mandatory Element
ConceptMap.group.element.target.property
  • Added Element
ConceptMap.group.element.target.property.code
  • Added Mandatory Element
ConceptMap.group.element.target.property.value[x]
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.attribute
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.value[x]
  • Added Element
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Added Element
ConceptMap.source[x]
  • deleted
ConceptMap.target[x]
  • deleted
ConceptMap.group.sourceVersion
  • deleted
ConceptMap.group.targetVersion
  • deleted
ConceptMap.group.element.target.equivalence
  • deleted
ConceptMap.group.element.target.dependsOn.property
  • deleted
ConceptMap.group.element.target.dependsOn.system
  • deleted
ConceptMap.group.element.target.dependsOn.value
  • deleted
ConceptMap.group.element.target.dependsOn.display
  • deleted
ConceptMap.group.unmapped.url
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and 4 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap TUDomainResourceA 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the concept map

... version Σ0..1stringBusiness version of the concept map
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this concept map (computer friendly)
... title ΣT0..1stringName for this concept map (human friendly)
... status ?!ΣC1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this concept map is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the ConceptMap is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the ConceptMap

... editor 0..*ContactDetailWho edited the ConceptMap

... reviewer 0..*ContactDetailWho reviewed the ConceptMap

... endorser 0..*ContactDetailWho endorsed the ConceptMap

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc

... property ΣC0..*BackboneElementAdditional properties of the mapping
+ Rule: If the property type is code, a system SHALL be specified

.... code Σ1..1codeIdentifies the property on the mappings, and when referred to in the $translate operation
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type ΣC1..1codeCoding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMap Property Type (Required)
.... system ΣC0..1canonical(CodeSystem)The CodeSystem from which code values come
... additionalAttribute Σ0..*BackboneElementDefinition of an additional attribute to act as a data source or target

.... code Σ1..1codeIdentifies this additional attribute through this resource
.... uri Σ0..1uriFormal identifier for the data element referred to in this attribte
.... description Σ0..1stringWhy the additional attribute is defined, and/or what the data element it refers to is
.... type Σ1..1codecode | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type (Required)
... sourceScope[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceScopeUriuri
.... sourceScopeCanonicalcanonical(ValueSet)
... targetScope[x] Σ0..1The target value set which provides context for the mappings
.... targetScopeUriuri
.... targetScopeCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems

.... source 0..1canonical(CodeSystem)Source system where concepts to be mapped are defined
.... target 0..1canonical(CodeSystem)Target system that the concepts are to be mapped to
.... element C1..*BackboneElementMappings 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 C0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... valueSet C0..1canonical(ValueSet)Identifies elements being mapped
..... noMap C0..1booleanNo mapping to a target concept for this source concept
..... target C0..*BackboneElementConcept 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 C0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... valueSet C0..1canonical(ValueSet)Identifies the set of target elements
...... relationship ?!C1..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (Required)
...... comment C0..1stringDescription of status/issues in mapping
...... property 0..*BackboneElementProperty value for the source -> target mapping

....... code 1..1codeReference to ConceptMap.property.code
....... value[x] 1..1Value of the property for this concept
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
........ valueCodecode
...... dependsOn C0..*BackboneElementOther properties required for this mapping
+ Rule: One of value[x] or valueSet must exist, but not both.

....... attribute 1..1codeA reference to a mapping attribute defined in ConceptMap.additionalAttribute
....... value[x] C0..1Value of the referenced data element
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueBooleanboolean
........ valueQuantityQuantity
....... valueSet C0..1canonical(ValueSet)The mapping depends on a data element with a value from this value set
...... product 0..*see dependsOnOther data elements that this mapping also produces

.... unmapped C0..1BackboneElementWhat to do when there is no mapping target for the source concept
+ 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 C1..1codeuse-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode (Required)
..... code C0..1codeFixed code when mode = fixed
..... display C0..1stringDisplay for the code
..... valueSet C0..1canonical(ValueSet)Fixed code set when mode = fixed
..... relationship ?!C0..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (Required)
..... otherMap C0..1canonical(ConceptMap)canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ConceptMap (DomainResource) +MetadataResourceAn 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 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 serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which ConceptMap is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the concept maptitle : string [0..1]The status of this concept map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! » « This element has or is affected by some invariantsC »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 usageexperimental : boolean [0..1]The date (and optionally time) when the concept map was last significantly changed. 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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the concept map from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instancesuseContext : UsageContext [0..*]A legal or geographic region in which the concept map is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this concept map is needed and why it has been designed as it haspurpose : markdown [0..1]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 mapcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the ConceptMap content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the ConceptMapauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the ConceptMapeditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMapreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value setsourceScope[x] : PrimitiveType [0..1] « uri|canonical(ValueSet) »Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value settargetScope[x] : PrimitiveType [0..1] « uri|canonical(ValueSet) »PropertyA code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operationcode : code [1..1]Reference to the formal meaning of the propertyuri : uri [0..1]A description of the property - why it is defined, and how its value might be useddescription : string [0..1]The type of the property valuetype : code [1..1] « null (Strength=Required)ConceptMapPropertyType! » « This element has or is affected by some invariantsC »The CodeSystem that defines the codes from which values of type ```code``` in property valuessystem : canonical [0..1] « CodeSystem » « This element has or is affected by some invariantsC »AdditionalAttributeA code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attributecode : code [1..1]Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}uri : uri [0..1]A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data elementdescription : string [0..1]The type of the source data contained in this concept map for this data elementtype : code [1..1] « null (Strength=Required)ConceptMapAttributeType! »GroupAn absolute URI that identifies the source system where the concepts to be mapped are definedsource : canonical [0..1] « CodeSystem »An absolute URI that identifies the target system that the concepts will be mapped totarget : canonical [0..1] « CodeSystem »SourceElementIdentity (code or path) or the element/item being mappedcode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The set of codes being mappedvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »If noMap = true this indicates that no mapping to a target concept exists for this source conceptnoMap : boolean [0..1] « This element has or is affected by some invariantsC »TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The set of codes that the map refers tovalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target) (this element modifies the meaning of other elements)relationship : code [1..1] « null (Strength=Required)ConceptMapRelationship! » « This element has or is affected by some invariantsC »A description of status/issues in mapping that conveys additional information not represented in the structured datacomment : string [0..1] « This element has or is affected by some invariantsC »MappingPropertyA reference to a mapping property defined in ConceptMap.propertycode : code [1..1]The value of this propertyvalue[x] : DataType [1..1] « Coding|string|integer|boolean|dateTime| decimal|code »OtherElementA reference to the additional attribute that holds a value the map depends onattribute : code [1..1]Data element value that the map depends on / producesvalue[x] : DataType [0..1] « code|Coding|string|boolean|Quantity » « This element has or is affected by some invariantsC »This mapping applies if the data element value is a code from this value setvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »UnmappedDefines 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 source 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)mode : code [1..1] « null (Strength=Required)ConceptMapGroupUnmappedMode! » « This element has or is affected by some invariantsC »The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed codecode : code [0..1] « This element has or is affected by some invariantsC »The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1] « This element has or is affected by some invariantsC »The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codesvalueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariantsC »The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code' (this element modifies the meaning of other elements)relationship : code [0..1] « null (Strength=Required)ConceptMapRelationship! » « This element has or is affected by some invariantsC »The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source conceptotherMap : canonical [0..1] « ConceptMap » « This element has or is affected by some invariantsC »A property defines a slot through which additional information can be provided about a map from source -> targetproperty[0..*]An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa)additionalAttribute[0..*]A property value for this source -> target mappingproperty[0..*]A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified valuedependsOn[0..*]Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target dataproduct[0..*]A concept from the target value set that this concept maps totarget[0..*]Mappings for an individual concept in the source to one or more concepts in the targetelement[1..*]What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-tounmapped[0..1]A group of mappings that all have the same source and target systemgroup[0..*]

XML Template

<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- 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 elements 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 elements --></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 -->
   <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

{doco
  "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 elements 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 elements
        "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
      "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/> .doco


[ 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 elements 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 elements
        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
      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 since Release 4

ConceptMap
ConceptMap.identifier
  • Max Cardinality changed from 1 to *
ConceptMap.versionAlgorithm[x]
  • Added Element
ConceptMap.copyrightLabel
  • Added Element
ConceptMap.approvalDate
  • Added Element
ConceptMap.lastReviewDate
  • Added Element
ConceptMap.effectivePeriod
  • Added Element
ConceptMap.topic
  • Added Element
ConceptMap.author
  • Added Element
ConceptMap.editor
  • Added Element
ConceptMap.reviewer
  • Added Element
ConceptMap.endorser
  • Added Element
ConceptMap.relatedArtifact
  • Added Element
ConceptMap.property
  • Added Element
ConceptMap.property.code
  • Added Mandatory Element
ConceptMap.property.uri
  • Added Element
ConceptMap.property.description
  • Added Element
ConceptMap.property.type
  • Added Mandatory Element
ConceptMap.property.system
  • Added Element
ConceptMap.additionalAttribute
  • Added Element
ConceptMap.additionalAttribute.code
  • Added Mandatory Element
ConceptMap.additionalAttribute.uri
  • Added Element
ConceptMap.additionalAttribute.description
  • Added Element
ConceptMap.additionalAttribute.type
  • Added Mandatory Element
ConceptMap.sourceScope[x]
  • Added Element
ConceptMap.targetScope[x]
  • Added Element
ConceptMap.group.source
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.target
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.element.valueSet
  • Added Element
ConceptMap.group.element.noMap
  • Added Element
ConceptMap.group.element.target.valueSet
  • Added Element
ConceptMap.group.element.target.relationship
  • Added Mandatory Element
ConceptMap.group.element.target.property
  • Added Element
ConceptMap.group.element.target.property.code
  • Added Mandatory Element
ConceptMap.group.element.target.property.value[x]
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.attribute
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.value[x]
  • Added Element
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Added Element
ConceptMap.source[x]
  • deleted
ConceptMap.target[x]
  • deleted
ConceptMap.group.sourceVersion
  • deleted
ConceptMap.group.targetVersion
  • deleted
ConceptMap.group.element.target.equivalence
  • deleted
ConceptMap.group.element.target.dependsOn.property
  • deleted
ConceptMap.group.element.target.dependsOn.system
  • deleted
ConceptMap.group.element.target.dependsOn.value
  • deleted
ConceptMap.group.element.target.dependsOn.display
  • deleted
ConceptMap.group.unmapped.url
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and 4 r3 resources are invalid (0 errors).)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

4.10.5.1 Terminology Bindings

PathValueSetTypeDocumentation
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 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
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.

4.10.5.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning ConceptMap.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img cmd-1Rule ConceptMap.group.element.targetIf 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'))
img cmd-2Rule ConceptMap.group.unmappedIf 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()))
img cmd-3Rule ConceptMap.group.unmappedIf the mode is 'other-map', a url for the other map must be provided(mode = 'other-map') implies otherMap.exists()
img cmd-4Rule ConceptMap.group.elementIf noMap is present, target SHALL NOT be present(noMap.exists() and target.empty()) or noMap.empty()
img cmd-5Rule ConceptMap.group.elementEither code or valueSet SHALL be present but not both.(code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
img cmd-6Rule ConceptMap.group.element.target.dependsOnOne of value[x] or valueSet must exist, but not both.(value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())
img cmd-7Rule ConceptMap.group.element.targetEither code or valueSet SHALL be present but not both.(code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
img cmd-8Rule ConceptMap.group.unmappedIf the mode is not 'fixed', code, display and valueSet are not allowed(mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())
img cmd-9Rule ConceptMap.group.unmappedIf the mode is not 'other-map', relationship must be provided(mode != 'other-map') implies relationship.exists()
img cmd-10Rule ConceptMap.group.unmappedIf the mode is not 'other-map', otherMap is not allowed(mode != 'other-map') implies otherMap.empty()
img cmd-11Rule ConceptMap.propertyIf the property type is code, a system SHALL be specifiedtype = 'code' implies system.exists()

4.10.6 Notes

  • The value of the system, version and code elements are the same as used by the Coding data type
  • When a mapping relationship is characterized as "source-is-broader-than-target", some explanation of the scope difference SHALL be provided in the comments
  • The concept map is a statement of mapping in a single direction. The existence of a matching mapping in the reverse direction cannot be assumed to exist automatically, but only through human review.
  • For simplicity, it is better if is only one element 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

4.10.7 Grouping Mappings

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.

4.10.8 target.dependsOn and target.product

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 DetailsRelationshipTarget Concept Details
Code from http://example.com/ehr/codesfield (dependsOn)Code from http://snomed.info/sctsubject (product)
diabDiabetesdiagnosisis equivalent to73211009Diabetes mellituspatient
diabDiabeteshistoryis equivalent to161445009H/O: diabetes mellituspatient
diabDiabetesfamilyis equivalent to161445009H/O: Diabetes mellitusfamily

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.

4.10.9 Handling Unmapped Codes

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:

providedUse 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
fixedUse 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-mapUse 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.

4.10.10 Implicit Concept Maps

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:

  • To enable the use of concept maps defined in a code system distribution (e.g., SNOMED CT)
  • To provide a convenient way, in the definition of a ConceptMap to reference another concept map provided in a code system distribution

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:

4.10.11 Search Parameters

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.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the concept map(ConceptMap.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the concept map(ConceptMap.useContext.value.ofType(Quantity)) | (ConceptMap.useContext.value.ofType(Range))30 Resources
context-typetokenA type of use context assigned to the concept mapConceptMap.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the concept mapOn ConceptMap.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		30 Resources
context-type-valuecompositeA use context type and value assigned to the concept mapOn ConceptMap.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		30 Resources
datedateThe concept map publication dateConceptMap.date30 Resources
derived-fromreferenceA resource that the ConceptMap is derived fromConceptMap.relatedArtifact.where(type='derived-from').resource
(Any)		10 Resources
descriptionstringThe description of the concept mapConceptMap.description28 Resources
effectivedateThe time during which the ConceptMap is intended to be in useConceptMap.effectivePeriod12 Resources
identifiertokenExternal identifier for the concept mapConceptMap.identifier33 Resources
jurisdictiontokenIntended jurisdiction for the concept mapConceptMap.jurisdiction26 Resources
mapping-propertyuriOther properties required for this mappingConceptMap.property.uri
namestringComputationally friendly name of the concept mapConceptMap.name26 Resources
other-mapreferencecanonical reference to an additional ConceptMap to use for mapping if the source concept is unmappedConceptMap.group.unmapped.otherMap
(ConceptMap)
predecessorreferenceThe predecessor of the ConceptMapConceptMap.relatedArtifact.where(type='predecessor').resource
(Any)		10 Resources
publisherstringName of the publisher of the concept mapConceptMap.publisher30 Resources
source-codetokenIdentifies elements being mappedConceptMap.group.element.code
source-group-systemreferenceSource system where concepts to be mapped are definedConceptMap.group.source
(CodeSystem)
source-scopereferenceThe source value set that contains the concepts that are being mapped(ConceptMap.sourceScope as canonical)
(ValueSet)
source-scope-uriuriThe URI for the source value set that contains the concepts being mapped(ConceptMap.sourceScope as uri)
statustokenThe current status of the concept mapConceptMap.status34 Resources
target-codetokenCode that identifies the target elementConceptMap.group.element.target.code
target-group-systemreferenceTarget system that the concepts are to be mapped toConceptMap.group.target
(CodeSystem)
target-scopereferenceThe target value set which provides context for the mappings(ConceptMap.targetScope as canonical)
(ValueSet)
target-scope-uriuriThe URI for the target value set that contains the concepts being mapped.(ConceptMap.targetScope as uri)
titlestringThe human-friendly name of the concept mapConceptMap.title27 Resources
topictokenTopics associated with the ConceptMapConceptMap.topic10 Resources
urluriThe URI that identifies the concept mapConceptMap.url33 Resources
versiontokenThe business version of the concept mapConceptMap.version30 Resources