R6 Ballot (3rd Draft) FHIR CI-Build

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). The current version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.10 Resource ConceptMap - Content

Responsible Owner: Terminology Infrastructure icon Work Group Maturity Level : 3   Trial Use Normative Security Category : Anonymous Compartments : No defined compartments

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

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.property data element can be used with

  • a child code value corresponding to the http://hl7.org/fhir/conceptmap-properties#relationshipRefinement concept (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.

Implementation Note: This resource has undergone an extensive redesign between Release 4 and Release 5. Key changes:

  • A number of metadata fields have been added (same as CodeSystem and ValueSet )
  • source and target were renamed to sourceScope and targetScope for clarity
  • ConceptMap.group.element.target.equivalence has been renamed to ConceptMap.group.element.target.relationship for clarity, and the set of relationship codes has simplified, and the code umatched has been moved to the noMap element
  • ConceptMap.group.element.target.property has been added to support providing additional details about the relationship between source and target. Like with CodeSystem and ValueSet , properties are defined using ConceptMap.property
  • ConceptMap.group.element.target.dependsOn.property was renamed to ConceptMap.group.element.target.dependsOn.attribute to clarify that these are not properties of the mapping, but additional attributes of the source or target content. The data type was changed from url to code which references ConceptMap.additionalAttribute to allow for a more concise representation, along with documentation
  • ConceptMap.group.element.valueSet was added to facilitate mapping all concepts from a source value set
  • ConceptMap.group.element.target.valueSet has been added to facilitate mapping to each concept in a target value set
  • relationship and valueSet have been added to the unmapped element and some other clarifications have been made

4.10.4 References to this Resource

4.10.5 Resource Content

Structure

Intended jurisdiction for Use and/or publishing XD Description of status/issues in
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . ConceptMap TU N DomainResource A map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the concept map

. . . version Σ 0..1 string Business version of the concept map
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this concept map (computer friendly)
. . . title Σ T 0..1 string Name for this concept map (human friendly)
. . . status ?! Σ C 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the concept map
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Jurisdiction of the authority that maintains the concept map (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . purpose T 0..1 markdown Why this concept map is defined
. . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the ConceptMap was approved by publisher
. . . lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the ConceptMap is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the ConceptMap

. . . editor 0..* ContactDetail Who edited the ConceptMap

. . . reviewer 0..* ContactDetail Who reviewed the ConceptMap

. . . endorser 0..* ContactDetail Who endorsed the ConceptMap

. . . relatedArtifact C 0..* RelatedArtifact Additional documentation, citations, etc
+ Rule: Related artifact can't be depends-on or composed-of

. . . property Σ C 0..* BackboneElement Additional properties of the mapping
+ Rule: If the property type is code, a system SHALL be specified

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

. . . . code Σ 1..1 code Identifies this additional attribute through this resource
. . . . uri Σ 0..1 uri Formal identifier for the data element referred to in this attribte attribute
. . . . description Σ 0..1 string Why the additional attribute is defined, and/or what the data element it refers to is
. . . . type Σ 1..1 code code | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type ( Required )
. . . sourceScope[x] Σ 0..1 The source value set that contains the concepts that are being mapped
. . . . sourceScopeUri uri
. . . . sourceScopeCanonical canonical ( ValueSet )
. . . targetScope[x] Σ 0..1 The target value set which provides context for the mappings
. . . . targetScopeUri uri
. . . . targetScopeCanonical canonical ( ValueSet )
. . . group 0..* BackboneElement Same source and target systems

. . . . source 0..1 canonical ( CodeSystem ) Source system where concepts to be mapped are defined
. . . . target 0..1 canonical ( CodeSystem ) Target system that the concepts are to be mapped to
. . . . element C 1..* BackboneElement Mappings for a concept from the source set
+ Rule: If noMap is present, present and has a value of 'true', target SHALL NOT be present
+ Rule: Either code or valueSet SHALL be present but not both.
+ Guideline: If ConceptMap.group.element.noMap is present and has a value of 'true', there SHOULD be some comments, unless the status is 'draft'

. . . . . code C 0..1 code Identifies element being mapped
. . . . . display 0..1 string Display for the code
. . . . . valueSet C 0..1 canonical ( ValueSet ) Identifies the set of concepts being mapped
. . . . . noMap C 0..1 boolean No mapping to a target concept for this source concept
. . . . . comment 0..1 string Comments related to the mapping of the source element
. . . . . target C 0..* BackboneElement Concept in target system for element
+ Rule: Guideline: If the map is source-is-broader-than-target or not-related-to, there SHALL SHOULD be some comments, unless the status is 'draft'
+ Rule: Either code or valueSet SHALL be present but not both.

. . . . . . code C 0..1 code Code that identifies the target element
. . . . . . display 0..1 string Display for the code
. . . . . . valueSet C 0..1 canonical ( ValueSet ) Identifies the set of target concepts
. . . . . . relationship ?! C 1..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship ( Required )
. . . . . . comment C 0..1 string Comments related to the mapping to the target element
. . . . . . property 0..* BackboneElement Property value for the source -> target mapping

. . . . . . . code 1..1 code Reference to ConceptMap.property.code
. . . . . . . value[x] 1..1 Value of the property for this concept
. . . . . . . . valueCoding Coding
. . . . . . . . valueString string
. . . . . . . . valueInteger integer
. . . . . . . . valueBoolean boolean
. . . . . . . . valueDateTime dateTime
. . . . . . . . valueDecimal decimal
. . . . . . . . valueCode code
. . . . . . dependsOn C 0..* BackboneElement Other properties required for this mapping
+ Rule: One of value[x] or valueSet must exist, but not both.

. . . . . . . attribute 1..1 code A reference to a mapping attribute defined in ConceptMap.additionalAttribute
. . . . . . . value[x] C 0..1 Value of the referenced data element
. . . . . . . . valueCode code
. . . . . . . . valueCoding Coding
. . . . . . . . valueString string
. . . . . . . . valueBoolean boolean
. . . . . . . . valueQuantity Quantity
. . . . . . . valueSet C 0..1 canonical ( ValueSet ) The mapping depends on a data element with a value from this value set
. . . . . . product 0..* see dependsOn Other data elements that this mapping also produces

. . . . unmapped C 0..1 BackboneElement What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
+ Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both.
+ Rule: If the mode is 'other-map', a url for the other map must be provided
+ Rule: If the mode is not 'fixed', code, display and valueSet are not allowed
+ Rule: If the mode is not 'other-map', relationship must be provided
+ Rule: If the mode is not 'other-map', otherMap is not allowed
+ Guideline: If ConceptMap.group.unmapped is present, there SHOULD be some comments, unless the status is 'draft'.
. . . . . mode C 1..1 code use-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode ( Required )
. . . . . code C 0..1 code Fixed code when mode = fixed
. . . . . display C 0..1 string Display for the code
. . . . . comment 0..1 string Comments related to the choice of how to handle unmapped elements
. . . . . valueSet C 0..1 canonical ( ValueSet ) Fixed code set when mode = fixed
. . . . . relationship ?! C 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship ( Required )
. . . . . otherMap C 0..1 canonical ( ConceptMap ) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

ConceptMap ( DomainResource ) + MetadataResource An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which ConceptMap is more current versionAlgorithm[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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the concept map title : 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 invariants C » A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage experimental : 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the concept map publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the concept map from a consumer's perspective description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the concept map authority that maintains the resource is intended to be used operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this concept map is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the concept map copyright : 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. restricted. (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 usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the ConceptMap content was or is planned to be in active use effectivePeriod : 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 searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the ConceptMap author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the ConceptMap editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts artifacts. If the type is `successor` or `predecessor`, the related resource must be a ConceptMap relatedArtifact : 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 set sourceScope[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 set targetScope[x] : PrimitiveType [0..1] « uri | canonical ( ValueSet ) » Property A 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 operation code : code [1..1] Reference to the formal meaning of the property uri : uri [0..1] A description of the property - why it is defined, and how its value might be used description : string [0..1] The type of the property value type : code [1..1] « null (Strength=Required) ConceptMapPropertyType ! » « This element has or is affected by some invariants C » The CodeSystem that defines the codes from which values of type ```code``` in property values system : canonical [0..1] « CodeSystem » « This element has or is affected by some invariants C » AdditionalAttribute A 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.attribute code : 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 element description : string [0..1] The type of the source data contained in this concept map for this data element type : code [1..1] « null (Strength=Required) ConceptMapAttributeType ! » Group An absolute URI that identifies the source system where the concepts to be mapped are defined source : canonical [0..1] « CodeSystem » An absolute URI that identifies the target system that the concepts will be mapped to target : canonical [0..1] « CodeSystem » SourceElement Identity (code or path) or the element/item being mapped code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » If noMap = true this indicates that no mapping to a target concept exists for this source concept noMap : boolean [0..1] « This element has or is affected by some invariants C » Comments related to the mapping of the source element, potentially including why there is no target comment : string [0..1] TargetElement Identity (code or path) or the element/item that the map refers to code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » 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 invariants C » A description of status/issues in Comments related to the mapping that conveys additional information not represented in to the structured data target element comment : string [0..1] « This element has or is affected by some invariants C » MappingProperty A reference to a mapping property defined in ConceptMap.property code : code [1..1] The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element and that ConceptMap.property element SHALL have a system element value[x] : DataType [1..1] « Coding | string | integer | boolean | dateTime | decimal | code » OtherElement A reference to the additional attribute that holds a value the map depends on attribute : code [1..1] Data element value that the map depends on / produces. If the data type is a code, that code SHALL come from the .group.source code system for .dependsOn.valueCode or from the .group.target code system for .product.valueCode value[x] : DataType [0..1] « code | Coding | string | boolean | Quantity » « This element has or is affected by some invariants C » This mapping applies if the data element value is a code from this value set valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » Unmapped Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped 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 invariants C » The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] « This element has or is affected by some invariants C » Comments related to the choice of how to handle unmapped elements comment : string [0..1] The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » 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 invariants C » The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept otherMap : canonical [0..1] « ConceptMap » « This element has or is affected by some invariants C » A property defines a slot through which additional information can be provided about a map from source -> target property [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 mapping property [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 value dependsOn [0..*] Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data product [0..*] A concept from the target value set that this concept maps to target [0..*] Mappings for an individual concept in the source to one or more concepts in the target element [1..*] What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty unmapped [0..1] A group of mappings that all have the same source and target system group [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 only - never for 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>

 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the concept map (if applicable) icon --></jurisdiction>

 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <
 <

 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <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>

 <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 attribute -->

  <description value="[string]"/><!-- 0..1 Why the additional attribute is defined, and/or what the data element it refers to is -->
  <type value="[code]"/><!-- 1..1 code | Coding | string | boolean | Quantity -->
 </additionalAttribute>
 <sourceScope[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></sourceScope[x]>
 <targetScope[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></targetScope[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source><!-- 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined --></source>
  <target><!-- 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to --></target>
  <element>  <!-- 1..* Mappings for a concept from the source set -->
   <code value="[code]"/><!-- I 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of concepts being mapped --></valueSet>
   <
   <

   <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept -->
   <comment value="[string]"/><!-- 0..1 Comments related to the mapping of the source element -->
   <target>  <!-- I 0..* Concept in target system for element -->

    <code value="[code]"/><!-- I 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of target concepts --></valueSet>
    <
    <

    <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
    <comment value="[string]"/><!-- I 0..1 Comments related to the mapping to the target element -->

    <property>  <!-- 0..* Property value for the source -> target mapping -->
     <code value="[code]"/><!-- 1..1 Reference to ConceptMap.property.code -->
     <value[x]><!-- 1..1 Coding|string|integer|boolean|dateTime|decimal|code Value of the property for this concept --></value[x]>
    </property>
    <dependsOn>  <!-- 0..* Other properties required for this mapping -->
     <attribute value="[code]"/><!-- 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute -->
     <value[x]><!-- I 0..1 code|Coding|string|boolean|Quantity Value of the referenced data element --></value[x]>
     <valueSet><!-- I 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set --></valueSet>
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other data elements that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true -->
   <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map -->
   <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <comment value="[string]"/><!-- 0..1 Comments related to the choice of how to handle unmapped elements -->

   <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 only - never for 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 }], // Jurisdiction of the authority that maintains the concept map (if applicable) icon

  "purpose" : "<markdown>", // Why this concept map is defined
  "
  "

  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "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 attribute

    "description" : "<string>", // Why the additional attribute is defined, and/or what the data element it refers to is
    "type" : "<code>" // R!  code | Coding | string | boolean | Quantity
  }],
  // sourceScope[x]: The source value set that contains the concepts that are being mapped. One of these 2:
  "sourceScopeUri" : "<uri>",
  "sourceScopeCanonical" : "<canonical(ValueSet)>",
  // targetScope[x]: The target value set which provides context for the mappings. One of these 2:
  "targetScopeUri" : "<uri>",
  "targetScopeCanonical" : "<canonical(ValueSet)>",
  "group" : [{ // Same source and target systems
    "source" : "<canonical(CodeSystem)>", // Source system where concepts to be mapped are defined
    "target" : "<canonical(CodeSystem)>", // Target system that the concepts are to be mapped to
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // I Identifies element being mapped
      "display" : "<string>", // Display for the code
      "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of concepts being mapped
      "
      "

      "noMap" : <boolean>, // I No mapping to a target concept for this source concept
      "comment" : "<string>", // Comments related to the mapping of the source element
      "target" : [{ // I Concept in target system for element

        "code" : "<code>", // I Code that identifies the target element
        "display" : "<string>", // Display for the code
        "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of target concepts
        "
        "

        "relationship" : "<code>", // I R!  related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        "comment" : "<string>", // I Comments related to the mapping to the target element

        "property" : [{ // Property value for the source -> target mapping
          "code" : "<code>", // R!  Reference to ConceptMap.property.code
          // value[x]: Value of the property for this concept. One of these 7:
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueInteger" : <integer>,
          "valueBoolean" : <boolean>,
          "valueDateTime" : "<dateTime>",
          "valueDecimal" : <decimal>,
          "valueCode" : "<code>"
        }],
        "dependsOn" : [{ // Other properties required for this mapping
          "attribute" : "<code>", // R!  A reference to a mapping attribute defined in ConceptMap.additionalAttribute
          // value[x]: Value of the referenced data element. One of these 5:
          "valueCode" : "<code>",
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueBoolean" : <boolean>,
          "valueQuantity" : { Quantity },
          "valueSet" : "<canonical(ValueSet)>" // I The mapping depends on a data element with a value from this value set
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other data elements that this mapping also produces
      }]
    }],
    "unmapped" : { // What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
      "mode" : "<code>", // I R!  use-source-code | fixed | other-map
      "code" : "<code>", // I Fixed code when mode = fixed
      "display" : "<string>", // I Display for the code
      "comment" : "<string>", // Comments related to the choice of how to handle unmapped elements

      "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 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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: ]

    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:

  fhir:status [ code ] ; # 1..1 I draft | active | retired | unknown

  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for 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:

  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the concept map (if applicable)

  fhir:purpose [ markdown ] ; # 0..1 Why this concept map is defined
  fhir:
  fhir:

  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  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:

  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:

    fhir:uri [ uri ] ; # 0..1 Formal identifier for the data element referred to in this attribute

    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: ]
    fhir:) ]

    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: ]
    fhir:) ]

    fhir:targetScope [  a fhir:Uri ; uri ]
    fhir:targetScope [  a fhir:Canonical ; canonical(ValueSet) ]

  fhir:group ( [ # 0..* Same source and target systems
    fhir:source [ canonical(CodeSystem) ] ; # 0..1 Source system where concepts to be mapped are defined
    fhir:target [ canonical(CodeSystem) ] ; # 0..1 Target system that the concepts are to be mapped to
    fhir:element ( [ # 1..* Mappings for a concept from the source set
      fhir:code [ code ] ; # 0..1 I Identifies element being mapped
      fhir:display [ string ] ; # 0..1 Display for the code
      fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of concepts being mapped
      fhir:
      fhir:

      fhir:noMap [ boolean ] ; # 0..1 I No mapping to a target concept for this source concept
      fhir:comment [ string ] ; # 0..1 Comments related to the mapping of the source element
      fhir:target ( [ # 0..* I Concept in target system for element

        fhir:code [ code ] ; # 0..1 I Code that identifies the target element
        fhir:display [ string ] ; # 0..1 Display for the code
        fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of target concepts
        fhir:
        fhir:

        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 Comments related to the mapping to the target element

        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: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]

            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: ]

            fhir:value [  a fhir:Code ; code ]

            fhir:value [  a fhir:Coding ; Coding ]
            fhir: ]
            fhir: ]

            fhir:value [  a fhir:String ; string ]
            fhir:value [  a fhir:Boolean ; boolean ]

            fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I The mapping depends on a data element with a value from this value set
        ] ... ) ;
        fhir:product  ( [ See ConceptMap.group.element.target.dependsOn ] ... ) ; # 0..* Other data elements that this mapping also produces
      ] ... ) ;
    ] ... ) ;
    fhir:unmapped [ # 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
      fhir:mode [ code ] ; # 1..1 I use-source-code | fixed | other-map
      fhir:code [ code ] ; # 0..1 I Fixed code when mode = fixed
      fhir:display [ string ] ; # 0..1 I Display for the code
      fhir:comment [ string ] ; # 0..1 Comments related to the choice of how to handle unmapped elements

      fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Fixed code set when mode = fixed
      fhir:relationship [ code ] ; # 0..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
      fhir:otherMap [ canonical(ConceptMap) ] ; # 0..1 I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    ] ;
  ] ... ) ;
]

Changes from both R4 and R4B

ConceptMap
ConceptMap.identifier
  • Max Cardinality changed from 1 to *
ConceptMap.versionAlgorithm[x]
  • Added Element
ConceptMap.jurisdiction
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.comment
  • 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
  • Renamed from property to attribute
  • Type changed from uri to code
ConceptMap.group.element.target.dependsOn.value[x]
  • Renamed from value to value[x]
  • Min Cardinality changed from 1 to 0
  • Add Types code, Coding, boolean, Quantity
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.mode
  • Remove code provided
  • Add code use-source-code
ConceptMap.group.unmapped.comment
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Renamed from url to otherMap
ConceptMap.source[x]
  • Deleted
ConceptMap.target[x]
  • Deleted
ConceptMap.group.sourceVersion
  • Deleted (-> canonical version in .group.source)
ConceptMap.group.targetVersion
  • Deleted (-> canonical version in .group.target)
ConceptMap.group.element.target.equivalence
  • Deleted (-> relationship)
ConceptMap.group.element.target.dependsOn.system
  • Deleted (-> value as Coding)
ConceptMap.group.element.target.dependsOn.display
  • Deleted (-> value as Coding)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

Intended jurisdiction for Use and/or publishing XD Description of status/issues in
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . ConceptMap TU N DomainResource A map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the concept map

. . . version Σ 0..1 string Business version of the concept map
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this concept map (computer friendly)
. . . title Σ T 0..1 string Name for this concept map (human friendly)
. . . status ?! Σ C 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the concept map
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Jurisdiction of the authority that maintains the concept map (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . purpose T 0..1 markdown Why this concept map is defined
. . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the ConceptMap was approved by publisher
. . . lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the ConceptMap is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the ConceptMap

. . . editor 0..* ContactDetail Who edited the ConceptMap

. . . reviewer 0..* ContactDetail Who reviewed the ConceptMap

. . . endorser 0..* ContactDetail Who endorsed the ConceptMap

. . . relatedArtifact C 0..* RelatedArtifact Additional documentation, citations, etc
+ Rule: Related artifact can't be depends-on or composed-of

. . . property Σ C 0..* BackboneElement Additional properties of the mapping
+ Rule: If the property type is code, a system SHALL be specified

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

. . . . code Σ 1..1 code Identifies this additional attribute through this resource
. . . . uri Σ 0..1 uri Formal identifier for the data element referred to in this attribte attribute
. . . . description Σ 0..1 string Why the additional attribute is defined, and/or what the data element it refers to is
. . . . type Σ 1..1 code code | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type ( Required )
. . . sourceScope[x] Σ 0..1 The source value set that contains the concepts that are being mapped
. . . . sourceScopeUri uri
. . . . sourceScopeCanonical canonical ( ValueSet )
. . . targetScope[x] Σ 0..1 The target value set which provides context for the mappings
. . . . targetScopeUri uri
. . . . targetScopeCanonical canonical ( ValueSet )
. . . group 0..* BackboneElement Same source and target systems

. . . . source 0..1 canonical ( CodeSystem ) Source system where concepts to be mapped are defined
. . . . target 0..1 canonical ( CodeSystem ) Target system that the concepts are to be mapped to
. . . . element C 1..* BackboneElement Mappings for a concept from the source set
+ Rule: If noMap is present, present and has a value of 'true', target SHALL NOT be present
+ Rule: Either code or valueSet SHALL be present but not both.
+ Guideline: If ConceptMap.group.element.noMap is present and has a value of 'true', there SHOULD be some comments, unless the status is 'draft'

. . . . . code C 0..1 code Identifies element being mapped
. . . . . display 0..1 string Display for the code
. . . . . valueSet C 0..1 canonical ( ValueSet ) Identifies the set of concepts being mapped
. . . . . noMap C 0..1 boolean No mapping to a target concept for this source concept
. . . . . comment 0..1 string Comments related to the mapping of the source element
. . . . . target C 0..* BackboneElement Concept in target system for element
+ Rule: Guideline: If the map is source-is-broader-than-target or not-related-to, there SHALL SHOULD be some comments, unless the status is 'draft'
+ Rule: Either code or valueSet SHALL be present but not both.

. . . . . . code C 0..1 code Code that identifies the target element
. . . . . . display 0..1 string Display for the code
. . . . . . valueSet C 0..1 canonical ( ValueSet ) Identifies the set of target concepts
. . . . . . relationship ?! C 1..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship ( Required )
. . . . . . comment C 0..1 string Comments related to the mapping to the target element
. . . . . . property 0..* BackboneElement Property value for the source -> target mapping

. . . . . . . code 1..1 code Reference to ConceptMap.property.code
. . . . . . . value[x] 1..1 Value of the property for this concept
. . . . . . . . valueCoding Coding
. . . . . . . . valueString string
. . . . . . . . valueInteger integer
. . . . . . . . valueBoolean boolean
. . . . . . . . valueDateTime dateTime
. . . . . . . . valueDecimal decimal
. . . . . . . . valueCode code
. . . . . . dependsOn C 0..* BackboneElement Other properties required for this mapping
+ Rule: One of value[x] or valueSet must exist, but not both.

. . . . . . . attribute 1..1 code A reference to a mapping attribute defined in ConceptMap.additionalAttribute
. . . . . . . value[x] C 0..1 Value of the referenced data element
. . . . . . . . valueCode code
. . . . . . . . valueCoding Coding
. . . . . . . . valueString string
. . . . . . . . valueBoolean boolean
. . . . . . . . valueQuantity Quantity
. . . . . . . valueSet C 0..1 canonical ( ValueSet ) The mapping depends on a data element with a value from this value set
. . . . . . product 0..* see dependsOn Other data elements that this mapping also produces

. . . . unmapped C 0..1 BackboneElement What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
+ Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both.
+ Rule: If the mode is 'other-map', a url for the other map must be provided
+ Rule: If the mode is not 'fixed', code, display and valueSet are not allowed
+ Rule: If the mode is not 'other-map', relationship must be provided
+ Rule: If the mode is not 'other-map', otherMap is not allowed
+ Guideline: If ConceptMap.group.unmapped is present, there SHOULD be some comments, unless the status is 'draft'.
. . . . . mode C 1..1 code use-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode ( Required )
. . . . . code C 0..1 code Fixed code when mode = fixed
. . . . . display C 0..1 string Display for the code
. . . . . comment 0..1 string Comments related to the choice of how to handle unmapped elements
. . . . . valueSet C 0..1 canonical ( ValueSet ) Fixed code set when mode = fixed
. . . . . relationship ?! C 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship ( Required )
. . . . . otherMap C 0..1 canonical ( ConceptMap ) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

ConceptMap ( DomainResource ) + MetadataResource An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which ConceptMap is more current versionAlgorithm[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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the concept map title : 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 invariants C » A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage experimental : 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the concept map publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the concept map from a consumer's perspective description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the concept map authority that maintains the resource is intended to be used operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this concept map is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the concept map copyright : 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. restricted. (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 usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the ConceptMap content was or is planned to be in active use effectivePeriod : 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 searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the ConceptMap author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the ConceptMap editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts artifacts. If the type is `successor` or `predecessor`, the related resource must be a ConceptMap relatedArtifact : 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 set sourceScope[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 set targetScope[x] : PrimitiveType [0..1] « uri | canonical ( ValueSet ) » Property A 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 operation code : code [1..1] Reference to the formal meaning of the property uri : uri [0..1] A description of the property - why it is defined, and how its value might be used description : string [0..1] The type of the property value type : code [1..1] « null (Strength=Required) ConceptMapPropertyType ! » « This element has or is affected by some invariants C » The CodeSystem that defines the codes from which values of type ```code``` in property values system : canonical [0..1] « CodeSystem » « This element has or is affected by some invariants C » AdditionalAttribute A 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.attribute code : 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 element description : string [0..1] The type of the source data contained in this concept map for this data element type : code [1..1] « null (Strength=Required) ConceptMapAttributeType ! » Group An absolute URI that identifies the source system where the concepts to be mapped are defined source : canonical [0..1] « CodeSystem » An absolute URI that identifies the target system that the concepts will be mapped to target : canonical [0..1] « CodeSystem » SourceElement Identity (code or path) or the element/item being mapped code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » If noMap = true this indicates that no mapping to a target concept exists for this source concept noMap : boolean [0..1] « This element has or is affected by some invariants C » Comments related to the mapping of the source element, potentially including why there is no target comment : string [0..1] TargetElement Identity (code or path) or the element/item that the map refers to code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » 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 invariants C » A description of status/issues in Comments related to the mapping that conveys additional information not represented in to the structured data target element comment : string [0..1] « This element has or is affected by some invariants C » MappingProperty A reference to a mapping property defined in ConceptMap.property code : code [1..1] The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element and that ConceptMap.property element SHALL have a system element value[x] : DataType [1..1] « Coding | string | integer | boolean | dateTime | decimal | code » OtherElement A reference to the additional attribute that holds a value the map depends on attribute : code [1..1] Data element value that the map depends on / produces. If the data type is a code, that code SHALL come from the .group.source code system for .dependsOn.valueCode or from the .group.target code system for .product.valueCode value[x] : DataType [0..1] « code | Coding | string | boolean | Quantity » « This element has or is affected by some invariants C » This mapping applies if the data element value is a code from this value set valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » Unmapped Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped 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 invariants C » The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code code : code [0..1] « This element has or is affected by some invariants C » The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] « This element has or is affected by some invariants C » Comments related to the choice of how to handle unmapped elements comment : string [0..1] The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes valueSet : canonical [0..1] « ValueSet » « This element has or is affected by some invariants C » 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 invariants C » The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept otherMap : canonical [0..1] « ConceptMap » « This element has or is affected by some invariants C » A property defines a slot through which additional information can be provided about a map from source -> target property [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 mapping property [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 value dependsOn [0..*] Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data product [0..*] A concept from the target value set that this concept maps to target [0..*] Mappings for an individual concept in the source to one or more concepts in the target element [1..*] What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty unmapped [0..1] A group of mappings that all have the same source and target system group [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 only - never for 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>

 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the concept map (if applicable) icon --></jurisdiction>

 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <
 <

 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <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>

 <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 attribute -->

  <description value="[string]"/><!-- 0..1 Why the additional attribute is defined, and/or what the data element it refers to is -->
  <type value="[code]"/><!-- 1..1 code | Coding | string | boolean | Quantity -->
 </additionalAttribute>
 <sourceScope[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></sourceScope[x]>
 <targetScope[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></targetScope[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source><!-- 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined --></source>
  <target><!-- 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to --></target>
  <element>  <!-- 1..* Mappings for a concept from the source set -->
   <code value="[code]"/><!-- I 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of concepts being mapped --></valueSet>
   <
   <

   <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept -->
   <comment value="[string]"/><!-- 0..1 Comments related to the mapping of the source element -->
   <target>  <!-- I 0..* Concept in target system for element -->

    <code value="[code]"/><!-- I 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <valueSet><!-- I 0..1 canonical(ValueSet) Identifies the set of target concepts --></valueSet>
    <
    <

    <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
    <comment value="[string]"/><!-- I 0..1 Comments related to the mapping to the target element -->

    <property>  <!-- 0..* Property value for the source -> target mapping -->
     <code value="[code]"/><!-- 1..1 Reference to ConceptMap.property.code -->
     <value[x]><!-- 1..1 Coding|string|integer|boolean|dateTime|decimal|code Value of the property for this concept --></value[x]>
    </property>
    <dependsOn>  <!-- 0..* Other properties required for this mapping -->
     <attribute value="[code]"/><!-- 1..1 A reference to a mapping attribute defined in ConceptMap.additionalAttribute -->
     <value[x]><!-- I 0..1 code|Coding|string|boolean|Quantity Value of the referenced data element --></value[x]>
     <valueSet><!-- I 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set --></valueSet>
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other data elements that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true -->
   <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map -->
   <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <comment value="[string]"/><!-- 0..1 Comments related to the choice of how to handle unmapped elements -->

   <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 only - never for 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 }], // Jurisdiction of the authority that maintains the concept map (if applicable) icon

  "purpose" : "<markdown>", // Why this concept map is defined
  "
  "

  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "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 attribute

    "description" : "<string>", // Why the additional attribute is defined, and/or what the data element it refers to is
    "type" : "<code>" // R!  code | Coding | string | boolean | Quantity
  }],
  // sourceScope[x]: The source value set that contains the concepts that are being mapped. One of these 2:
  "sourceScopeUri" : "<uri>",
  "sourceScopeCanonical" : "<canonical(ValueSet)>",
  // targetScope[x]: The target value set which provides context for the mappings. One of these 2:
  "targetScopeUri" : "<uri>",
  "targetScopeCanonical" : "<canonical(ValueSet)>",
  "group" : [{ // Same source and target systems
    "source" : "<canonical(CodeSystem)>", // Source system where concepts to be mapped are defined
    "target" : "<canonical(CodeSystem)>", // Target system that the concepts are to be mapped to
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // I Identifies element being mapped
      "display" : "<string>", // Display for the code
      "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of concepts being mapped
      "
      "

      "noMap" : <boolean>, // I No mapping to a target concept for this source concept
      "comment" : "<string>", // Comments related to the mapping of the source element
      "target" : [{ // I Concept in target system for element

        "code" : "<code>", // I Code that identifies the target element
        "display" : "<string>", // Display for the code
        "valueSet" : "<canonical(ValueSet)>", // I Identifies the set of target concepts
        "
        "

        "relationship" : "<code>", // I R!  related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        "comment" : "<string>", // I Comments related to the mapping to the target element

        "property" : [{ // Property value for the source -> target mapping
          "code" : "<code>", // R!  Reference to ConceptMap.property.code
          // value[x]: Value of the property for this concept. One of these 7:
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueInteger" : <integer>,
          "valueBoolean" : <boolean>,
          "valueDateTime" : "<dateTime>",
          "valueDecimal" : <decimal>,
          "valueCode" : "<code>"
        }],
        "dependsOn" : [{ // Other properties required for this mapping
          "attribute" : "<code>", // R!  A reference to a mapping attribute defined in ConceptMap.additionalAttribute
          // value[x]: Value of the referenced data element. One of these 5:
          "valueCode" : "<code>",
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueBoolean" : <boolean>,
          "valueQuantity" : { Quantity },
          "valueSet" : "<canonical(ValueSet)>" // I The mapping depends on a data element with a value from this value set
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other data elements that this mapping also produces
      }]
    }],
    "unmapped" : { // What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
      "mode" : "<code>", // I R!  use-source-code | fixed | other-map
      "code" : "<code>", // I Fixed code when mode = fixed
      "display" : "<string>", // I Display for the code
      "comment" : "<string>", // Comments related to the choice of how to handle unmapped elements

      "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 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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: ]

    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:

  fhir:status [ code ] ; # 1..1 I draft | active | retired | unknown

  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for 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:

  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the concept map (if applicable)

  fhir:purpose [ markdown ] ; # 0..1 Why this concept map is defined
  fhir:
  fhir:

  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  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:

  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:

    fhir:uri [ uri ] ; # 0..1 Formal identifier for the data element referred to in this attribute

    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: ]
    fhir:) ]

    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: ]
    fhir:) ]

    fhir:targetScope [  a fhir:Uri ; uri ]
    fhir:targetScope [  a fhir:Canonical ; canonical(ValueSet) ]

  fhir:group ( [ # 0..* Same source and target systems
    fhir:source [ canonical(CodeSystem) ] ; # 0..1 Source system where concepts to be mapped are defined
    fhir:target [ canonical(CodeSystem) ] ; # 0..1 Target system that the concepts are to be mapped to
    fhir:element ( [ # 1..* Mappings for a concept from the source set
      fhir:code [ code ] ; # 0..1 I Identifies element being mapped
      fhir:display [ string ] ; # 0..1 Display for the code
      fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of concepts being mapped
      fhir:
      fhir:

      fhir:noMap [ boolean ] ; # 0..1 I No mapping to a target concept for this source concept
      fhir:comment [ string ] ; # 0..1 Comments related to the mapping of the source element
      fhir:target ( [ # 0..* I Concept in target system for element

        fhir:code [ code ] ; # 0..1 I Code that identifies the target element
        fhir:display [ string ] ; # 0..1 Display for the code
        fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Identifies the set of target concepts
        fhir:
        fhir:

        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 Comments related to the mapping to the target element

        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: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]

            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: ]

            fhir:value [  a fhir:Code ; code ]

            fhir:value [  a fhir:Coding ; Coding ]
            fhir: ]
            fhir: ]

            fhir:value [  a fhir:String ; string ]
            fhir:value [  a fhir:Boolean ; boolean ]

            fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I The mapping depends on a data element with a value from this value set
        ] ... ) ;
        fhir:product  ( [ See ConceptMap.group.element.target.dependsOn ] ... ) ; # 0..* Other data elements that this mapping also produces
      ] ... ) ;
    ] ... ) ;
    fhir:unmapped [ # 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
      fhir:mode [ code ] ; # 1..1 I use-source-code | fixed | other-map
      fhir:code [ code ] ; # 0..1 I Fixed code when mode = fixed
      fhir:display [ string ] ; # 0..1 I Display for the code
      fhir:comment [ string ] ; # 0..1 Comments related to the choice of how to handle unmapped elements

      fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 I Fixed code set when mode = fixed
      fhir:relationship [ code ] ; # 0..1 I related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
      fhir:otherMap [ canonical(ConceptMap) ] ; # 0..1 I canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    ] ;
  ] ... ) ;
]

Changes from both R4 and R4B

ConceptMap
ConceptMap.identifier
  • Max Cardinality changed from 1 to *
ConceptMap.versionAlgorithm[x]
  • Added Element
ConceptMap.jurisdiction
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.comment
  • 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
  • Renamed from property to attribute
  • Type changed from uri to code
ConceptMap.group.element.target.dependsOn.value[x]
  • Renamed from value to value[x]
  • Min Cardinality changed from 1 to 0
  • Add Types code, Coding, boolean, Quantity
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.mode
  • Remove code provided
  • Add code use-source-code
ConceptMap.group.unmapped.comment
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Renamed from url to otherMap
ConceptMap.source[x]
  • Deleted
ConceptMap.target[x]
  • Deleted
ConceptMap.group.sourceVersion
  • Deleted (-> canonical version in .group.source)
ConceptMap.group.targetVersion
  • Deleted (-> canonical version in .group.target)
ConceptMap.group.element.target.equivalence
  • Deleted (-> relationship)
ConceptMap.group.element.target.dependsOn.system
  • Deleted (-> value as Coding)
ConceptMap.group.element.target.dependsOn.display
  • Deleted (-> value as Coding)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

 

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

4.10.5.1 Terminology Bindings

Path ValueSet Type Documentation
ConceptMap.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

ConceptMap.status PublicationStatus Required

The lifecycle status of an artifact.

ConceptMap.jurisdiction JurisdictionValueSet icon 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

UniqueKey Level Location Description Expression
img  cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img  cnl-1 Warning ConceptMap.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
img  cmd-1 Rule Guideline ConceptMap.group.element.target If the map is source-is-broader-than-target or not-related-to, there SHALL SHOULD 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'))
This is (only) a best practice guideline because:

Encourage documentation when map is source-is-broader-than-target or not-related-to is true explaining the ramifications

img  cmd-2 Rule ConceptMap.group.unmapped If the mode is 'fixed', either a code or valueSet must be provided, but not both. (mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
img  cmd-3 Rule ConceptMap.group.unmapped If the mode is 'other-map', a url for the other map must be provided (mode = 'other-map') implies otherMap.exists()
img  cmd-4 Rule ConceptMap.group.element If noMap is present, present and has a value of 'true', target SHALL NOT be present (noMap.exists() and noMap=true) implies target.empty()
img  cmd-5 Rule ConceptMap.group.element Either code or valueSet SHALL be present but not both. (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
img  cmd-6 Rule ConceptMap.group.element.target.dependsOn One of value[x] or valueSet must exist, but not both. (value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())
img  cmd-7 Rule ConceptMap.group.element.target Either code or valueSet SHALL be present but not both. (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
img  cmd-8 Rule ConceptMap.group.unmapped If the mode is not 'fixed', code, display and valueSet are not allowed (mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())
img  cmd-9 Rule ConceptMap.group.unmapped If the mode is not 'other-map', relationship must be provided (mode != 'other-map') implies relationship.exists()
img  cmd-10 Rule ConceptMap.group.unmapped If the mode is not 'other-map', otherMap is not allowed (mode != 'other-map') implies otherMap.empty()
img  cmd-11 Rule ConceptMap.property If the property type is code, a system SHALL be specified type = 'code' implies system.exists()
img  cmd-12 Guideline ConceptMap.group.element If ConceptMap.group.element.noMap is present and has a value of 'true', there SHOULD be some comments, unless the status is 'draft' comment.exists() or (%resource.status = 'draft') or (noMap != true)
This is (only) a best practice guideline because:

Encourage documentation when noMap is true explaining why

img  cmd-13 Guideline ConceptMap.group.unmapped If ConceptMap.group.unmapped is present, there SHOULD be some comments, unless the status is 'draft'. comment.exists() or (%resource.status = 'draft')
This is (only) a best practice guideline because:

Encourage documentation when noMap is true explaining why

img  cmd-14 Rule ConceptMap.relatedArtifact Related artifact can't be depends-on or composed-of (type in ('depends-on' | 'composed-of')).not()

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 Details Relationship Target Concept Details
Code from http://example.com/ehr/codes field (dependsOn) Code from http://snomed.info/sct subject (product)
diab Diabetes diagnosis is equivalent to 73211009 Diabetes mellitus patient
diab Diabetes history is equivalent to 161445009 H/O: diabetes mellitus patient
diab Diabetes family is equivalent to 161445009 H/O: Diabetes mellitus family

When attempting to translate the source to the target, an application SHOULD also provide a value for the element(s) identified in dependsOn.property so that the correct mapping can be performed.

All dependsOn and product values are included in the output of $translate.

Interpretation and use of these values is based on the definition of the associated property.

The use of valueCode implies the CodeSystem is known from the property definition.

To see real examples of mappings with dependencies, check Specimen Type Mapping and Message ADT A04 to Bundle Mapping .

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:

provided Use the code source as provided in the $translate request. This is especially useful for translations between versions of the same code system, where only a few codes have changed
fixed Use the code (and display) explicitly provided in the group.unmapped . This is useful when there's a fall back general code - especially for classifications
other-map Use the map identified by the canonical URL in otherMap . This is useful when a published concept map needs to be varied for a few specific cases on an institutional basis - the institution can create a simple concept that expresses their special cases, and then refer to the general purpose mappings

Note that this element is not used when there is an element with a matching code value, and a relationship value of not-related-to .

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.

Name Type Description Expression In Common
context token A use context assigned to the concept map (ConceptMap.useContext.value.ofType(CodeableConcept)) 30 25 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the concept map (ConceptMap.useContext.value.ofType(Quantity)) | (ConceptMap.useContext.value.ofType(Range)) 30 25 Resources
context-type token A type of use context assigned to the concept map ConceptMap.useContext.code 30 25 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the concept map On ConceptMap.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range) 		30 25 Resources
context-type-value composite A use context type and value assigned to the concept map On ConceptMap.useContext:
  context-type: code
  context: value.ofType(CodeableConcept) 		30 25 Resources
date date The concept map publication date ConceptMap.date 31 26 Resources
derived-from reference A resource that the ConceptMap is derived from ConceptMap.relatedArtifact.where(type='derived-from').resource
(Any) 		9 Resources
description string The description of the concept map ConceptMap.description 29 24 Resources
effective date The time during which the ConceptMap is intended to be in use ConceptMap.effectivePeriod 12 10 Resources
experimental token Whether the ConceptMap is experimental ConceptMap.experimental
identifier token External identifier for the concept map ConceptMap.identifier 35 30 Resources
jurisdiction token Intended jurisdiction for Jurisdiction of the authority that maintains the the concept map ConceptMap.jurisdiction 27 22 Resources
mapping-property uri Other properties required for this mapping ConceptMap.property.uri
name string Computationally friendly name of the concept map ConceptMap.name 28 24 Resources
other-map reference canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped ConceptMap.group.unmapped.otherMap
( ConceptMap )
predecessor reference The predecessor of the ConceptMap ConceptMap.relatedArtifact.where(type='predecessor').resource
(Any) 		9 Resources
publisher string Name of the publisher of the concept map ConceptMap.publisher 31 26 Resources
source-code token Identifies elements being mapped ConceptMap.group.element.code
source-group-system reference Source system where concepts to be mapped are defined ConceptMap.group.source
( CodeSystem )
source-scope reference The source value set that contains the concepts that are being mapped (ConceptMap.sourceScope as canonical)
( ValueSet )
source-scope-uri uri The URI for the source value set that contains the concepts being mapped (ConceptMap.sourceScope as uri)
status token The current status of the concept map ConceptMap.status 35 30 Resources
target-code token Code that identifies the target element ConceptMap.group.element.target.code
target-group-system reference Target system that the concepts are to be mapped to ConceptMap.group.target
( CodeSystem )
target-scope reference The target value set which provides context for the mappings (ConceptMap.targetScope as canonical)
( ValueSet )
target-scope-uri uri The URI for the target value set that contains the concepts being mapped. (ConceptMap.targetScope as uri)
title string The human-friendly name of the concept map ConceptMap.title 28 24 Resources
topic token Topics associated with the ConceptMap ConceptMap.topic 10 Resources
url uri The URI that identifies the concept map ConceptMap.url 35 30 Resources
version token The business version of the concept map ConceptMap.version 32 27 Resources