Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

4.10 Resource ConceptMap - Content

Vocabulary icon Work Group Maturity Level : 3 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

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

4.10.1 Scope and Usage

ConceptMap will have significant changes in R5. The R5 CI build version of ConceptMap can be found here: http://build.fhir.org/conceptmap.html.  

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 for a concept from the a source concept to a target system concept includes an equivalence a relationship property that specifies how similar element describing the mapping is semantic correspondence between the two (or, in some cases, that there is no valid mapping). There If none of the relationships in ConceptMapRelationship is one precise enough, then a ConceptMap.group.element.target.product data element can be used with a child property value of http://hl7.org/fhir/conceptmap-properties#relationshipRefinement (from the ConceptMap Properties code system) and a child valueCode or valueCoding value to indicate the precise relationship. In this case, well-known relationships, such as those from the Simple Knowledge Organization System (SKOS) icon, should be used where possible.

There can be an element for each concept or field in the source sourceScope value set or group.source code system that needs to be mapped. Each source concept may have multiple targets:

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

The mapping applies to all members of the expansion of the group.element.valueSet which are also within the scope of sourceScope if specified.

The meaning associated with the use of group.element.valueSet is the same as having individual group.element.code mappings for each concept in the expansion of the group.element.valueSet .

The mapping applies to all members of the expansion of the group.element.target.valueSet which are also within the scope of targetScope if specified.

The meaning associated with the use of group.element.target.valueSet is the same as having individual group.element.target.code mappings for each concept in the expansion of the group.element.target.valueSet .

The expansion of the group.unmapped.valueSet value set provides the set of fixed codes to use when the mode = 'fixed'. All unmapped source codes are then mapped to each of these fixed codes.

There SHOULD be at least one target for each element, but some incomplete concept maps might not have a target for each concept.

A key concept for the ConceptMap resource is the $translate operation . This operation is a formal definition of an API by which a terminology server can allow clients to ask for a translation to be done based on the content in the ConceptMap resource. As such it also provides useful perspective on the operational use of ConceptMap resources in any context.

4.10.2 Boundaries and Relationships

While ConceptMap resources are not referred to directly from any other resource, they may be included and used in ImplementationGuide resources, and provide background knowledge that is useful in many contexts, including operations defined in this specification.

In addition to ConceptMap , there is also the StructureMap resource. The ConceptMap resource defines relationships between concepts in their own right, along with grading of their equivalencies, while the StructureMap defines an executable transform for instances that conform to a known structure.

Both Code System supplements and Concept Maps may be used to define relationships between concepts in different systems. ConceptMaps are assertions of the relationships between different concepts that are associated with particular contexts of use, while CodeSystem supplements are used to define inherent properties and semantics of the concepts in the code system

4.10.3 Background and Context

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

4.10.4 References to this Resource

This resource is referenced by itself. This resource does not implement any patterns.

4.10.5 Resource Content

Structure

uri Display
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . ConceptMap TU DomainResource A map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

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

. . . version Σ 0..1 string Business version of the concept map
. . . 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 ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher 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 Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this concept map is defined
. . . copyright T 0..1 markdown Use and/or publishing restrictions
. . source[x] . approvalDate 0..1 date When the ConceptMap was approved by publisher
... lastReviewDate 0..1 date When the ConceptMap was last reviewed
... effectivePeriod Σ 0..1 Period The source value set that contains When the concepts that are being mapped ConceptMap is expected to be used
. . sourceUri . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
DefinitionTopic ( Example )

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

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

. . . reviewer sourceCanonical 0..* ContactDetail Who reviewed the ConceptMap
canonical
. . . endorser ( ValueSet ) 0..* ContactDetail Who endorsed the ConceptMap

... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.

. . . target[x] sourceScope[x] Σ 0..1 The target source value set which provides context for that contains the mappings concepts that are being mapped
. . . . targetUri sourceScopeUri uri
. . . . targetCanonical sourceScopeCanonical canonical ( ValueSet )
. . group . targetScope[x] Σ 0..* 0..1 BackboneElement Same source and The target systems value set which provides context for the mappings
. . . . source targetScopeUri uri
.... targetScopeCanonical canonical ( ValueSet )
... group 0..1 0..* uri BackboneElement Source system where concepts to be mapped are defined Same source and target systems

. . . sourceVersion . source 0..1 string canonical ( CodeSystem ) Specific version of the code Source system where concepts to be mapped are defined
. . . . target 0..1 uri canonical ( CodeSystem ) Target system that the concepts are to be mapped to
. . . targetVersion . element C 0..1 1..* string BackboneElement Specific version of Mappings for a concept from the source set
+ Rule: If noMap is present, target SHALL NOT be present
+ Rule: Either code system or valueSet SHALL be present but not both.

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

. . . . . . code 0..1 code Code that identifies the target element
. . . . . . display 0..1 string Display for the code
. . . . . . valueSet 0..1 canonical ( ValueSet ) Identifies the set of target elements
. . . . . . equivalence relationship ?! 1..1 code relatedto related-to | equivalent | equal | wider | subsumes | narrower | specializes | inexact source-is-narrower-than-target | unmatched source-is-broader-than-target | disjoint not-related-to
ConceptMapEquivalence ConceptMapRelationship ( Required )
. . . . . . comment I C 0..1 string Description of status/issues in mapping
. . . . . . dependsOn C 0..* BackboneElement Other elements properties required for this mapping (from context)
+ Rule: One of value[x] or valueSet must exist, but not both.

. . . . . . . property 1..1 uri Reference A reference to a property that may be required to refine the mapping depends on
. . . . . . system . value[x] 0..1 canonical ( CodeSystem ) Code System (if necessary) Value of the referenced property
. . . . . . . . value valueCode code
. . . . . . . . valueCoding Coding
. . . . . . . . valueString 1..1 string
. . . . . . . . valueInteger integer
........ valueBoolean Value of the referenced element boolean
. . . . . . . . display valueDateTime dateTime
. . . . . . . . valueDecimal decimal
. . . . . . . . valueUri uri
........ valueId id
....... valueSet 0..1 string canonical ( ValueSet ) Display for the code (if value is The mapping depends on a code) property with a value from this value set
. . . . . . product 0..* see dependsOn Other concepts properties that this mapping also produces

. . . . unmapped I C 0..1 BackboneElement What to do when there is no mapping target for the source concept
+ Rule: If the mode is 'fixed', either a code or valueSet must be provided provided, but not both.
+ Rule: If the mode is 'other-map', a url for the other map must be provided
+ Rule: If the mode is not 'fixed', code, display and valueSet are not allowed
+ Rule: If the mode is not 'other-map', relationship must be provided
+ Rule: If the mode is not 'other-map', otherMap is not allowed
. . . . . mode 1..1 code provided use-source-code | fixed | other-map
ConceptMapGroupUnmappedMode ( Required )
. . . . . code 0..1 code Fixed code when mode = fixed
. . . . . display 0..1 string Display for the code
. . . . . url valueSet 0..1 canonical ( ValueSet ) Fixed code set when mode = fixed
..... relationship ?! 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
ConceptMapRelationship ( Required )
..... otherMap 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 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..1] [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] 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 ! » A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The date (and optionally time) when the concept map was published. 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 that published 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 is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet 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 restrictions on the use and publishing of the concept map copyright : markdown [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 primarily responsible for review of some aspect of the ConceptMap reviewer : ContactDetail [0..*] An individual or organization 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 relatedArtifact : RelatedArtifact [0..*] Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set source[x] sourceScope[x] : Element PrimitiveType [0..1] « uri | canonical ( ValueSet ) » The target value set provides context Identifier for the mappings. Note that the mapping is made between concepts, not between value sets, but the target value set that provides important context about how the concept mapping choices are made made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set target[x] targetScope[x] : Element PrimitiveType [0..1] « uri | canonical ( ValueSet ) » Group An absolute URI that identifies the source system where the concepts to be mapped are defined source : uri canonical [0..1] The specific version of the code system, as determined by the code system authority sourceVersion : string « CodeSystem [0..1] » An absolute URI that identifies the target system that the concepts will be mapped to target : uri canonical [0..1] The specific version of the code system, as determined by the code system authority targetVersion : string « CodeSystem [0..1] » SourceElement Identity (code or path) or the element/item being mapped code : code [0..1] 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 codes being mapped valueSet : canonical [0..1] « ValueSet » If noMap = true this indicates that no mapping to a target concept exists for this source concept noMap : boolean [0..1] TargetElement Identity (code or path) or the element/item that the map refers to code : code [0..1] The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The equivalence set of codes that the map refers to valueSet : canonical [0..1] « ValueSet » The relationship between the source and target concepts (counting for the dependencies and products). concepts. The equivalence relationship is read from target to source (e.g. the to target is 'wider' than the source) (e.g. source-is-narrower-than-target) (this element modifies the meaning of other elements) equivalence relationship : code [1..1] « null (Strength=Required) ConceptMapEquivalence ConceptMapRelationship ! » A description of status/issues in mapping that conveys additional information not represented in the structured data comment : string [0..1] « This element has or is affected by some invariants C » OtherElement A reference to an element a property that holds a coded value that corresponds the map depends on. This value can be supplied to a code system property. The idea is that the information model carries an element somewhere that is labeled $translate operation to correspond with a code system property select the appropriate targets property : uri [1..1] An absolute URI that identifies the code system of the dependency code (if the source/dependency is a Property value set that crosses code systems) the map depends on system value[x] : canonical DataType [0..1] « CodeSystem code » | Coding | string | integer | boolean | Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to value dateTime : string | decimal [1..1] | uri | id » The display for This mapping applies if the code. The display property value is only provided to help editors when editing the concept map a code from this value set display valueSet : string canonical [0..1] « ValueSet » 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 ! » The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code code : code [0..1] 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 fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes valueSet : canonical [0..1] « ValueSet » 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 ! » 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 url otherMap : canonical [0..1] « ConceptMap » A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element property can be resolved, and it has the specified value dependsOn [0..*] A set Product is the output of a ConceptMap that provides additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped values relevant to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but interpretation of the equivalence cannot be relied on mapping target 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 for to a target concept from the source concept. "Unmapped" does not include codes that are unmatched, and This provides the unmapped "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored in if a code is specified to have equivalence relationship = unmatched not-related-to 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 -->
 <
 <</identifier>

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

 <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]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <
 <

 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <</source[x]>
 <</target[x]>

 <approvalDate value="[date]"/><!-- 0..1 When the ConceptMap was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the ConceptMap was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the ConceptMap is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the ConceptMap --></author>
 <editor><!-- 0..* ContactDetail Who edited the ConceptMap --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the ConceptMap --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the ConceptMap --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <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]"/><!-- 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <valueSet><!-- 0..1 canonical(ValueSet) Identifies elements being mapped --></valueSet>
   <noMap value="[boolean]"/><!-- 0..1 No mapping to a target concept for this source concept -->

   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <
    <
    <
     <
     <</system>
     <
     <

    <valueSet><!-- 0..1 canonical(ValueSet) Identifies the set of target elements --></valueSet>
    <relationship value="[code]"/><!-- 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
    <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other properties required for this mapping -->
     <property value="[uri]"/><!-- 1..1 A reference to a property that may be required to refine the mapping -->
     <value[x]><!-- 0..1 code|Coding|string|integer|boolean|dateTime|decimal|uri|
       id Value of the referenced property --></value[x]>

     <valueSet><!-- 0..1 canonical(ValueSet) The mapping depends on a property with a value from this value set --></valueSet>

    </dependsOn>
    <</product>

    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other properties that this mapping also produces --></product>

   </target>
  </element>
  <
   <

  <unmapped>  <!-- 0..1 What to do when there is no mapping target for the source concept -->
   <mode value="[code]"/><!-- 1..1 use-source-code | fixed | other-map -->

   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <</url>

   <valueSet><!-- 0..1 canonical(ValueSet) Fixed code set when mode = fixed --></valueSet>
   <relationship value="[code]"/><!-- 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
   <otherMap><!-- 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
  "

  "name" : "<string>", // I Name for this concept map (computer friendly)

  "title" : "<string>", // Name for this concept map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "
  "

  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
  "purpose" : "<markdown>", // Why this concept map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  
  ">",
  " },
  
  ">",
  " },

  "approvalDate" : "<date>", // When the ConceptMap was approved by publisher
  "lastReviewDate" : "<date>", // When the ConceptMap was last reviewed
  "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.
  // 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>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "valueSet" : "<canonical(ValueSet)>", // Identifies elements being mapped
      "noMap" : <boolean>, // No mapping to a target concept for this source concept

      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "
        "
        "
          "
          "
          "
          "

        "valueSet" : "<canonical(ValueSet)>", // Identifies the set of target elements
        "relationship" : "<code>", // R!  related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        "comment" : "<string>", // I Description of status/issues in mapping
        "dependsOn" : [{ // Other properties required for this mapping
          "property" : "<uri>", // R!  A reference to a property that may be required to refine the mapping
          // value[x]: Value of the referenced property. One of these 9:

          "valueCode" : "<code>",
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueInteger" : <integer>,
          "valueBoolean" : <boolean>,
          "valueDateTime" : "<dateTime>",
          "valueDecimal" : <decimal>,
          "valueUri" : "<uri>",
          "valueId" : "<id>",
          "valueSet" : "<canonical(ValueSet)>" // The mapping depends on a property with a value from this value set

        }],
        "

        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other properties that this mapping also produces

      }]
    }],
    "
      "

    "unmapped" : { // What to do when there is no mapping target for the source concept
      "mode" : "<code>", // R!  use-source-code | fixed | other-map

      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "

      "valueSet" : "<canonical(ValueSet)>", // Fixed code set when mode = fixed
      "relationship" : "<code>", // related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
      "otherMap" : "<canonical(ConceptMap)>" // canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

    }
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConceptMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:

  fhir:ConceptMap.url [ uri ]; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique)
  fhir:ConceptMap.identifier [ Identifier ], ... ; # 0..* Additional identifier for the concept map

  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:

  fhir:ConceptMap.name [ string ]; # 0..1 I Name for this concept map (computer friendly)

  fhir:ConceptMap.title [ string ]; # 0..1 Name for this concept map (human friendly)
  fhir:ConceptMap.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:
  fhir:

  fhir:ConceptMap.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)

  fhir:ConceptMap.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConceptMap.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for concept map (if applicable)
  fhir:ConceptMap.purpose [ markdown ]; # 0..1 Why this concept map is defined
  fhir:ConceptMap.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  # . One of these 2
    fhir: ]
    fhir:) ]
  # . One of these 2
    fhir: ]
    fhir:) ]

  fhir:ConceptMap.approvalDate [ date ]; # 0..1 When the ConceptMap was approved by publisher
  fhir:ConceptMap.lastReviewDate [ date ]; # 0..1 When the ConceptMap was last reviewed
  fhir:ConceptMap.effectivePeriod [ Period ]; # 0..1 When the ConceptMap is expected to be used
  fhir:ConceptMap.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:ConceptMap.author [ ContactDetail ], ... ; # 0..* Who authored the ConceptMap
  fhir:ConceptMap.editor [ ContactDetail ], ... ; # 0..* Who edited the ConceptMap
  fhir:ConceptMap.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the ConceptMap
  fhir:ConceptMap.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the ConceptMap
  fhir:ConceptMap.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  # ConceptMap.sourceScope[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2
    fhir:ConceptMap.sourceScopeUri [ uri ]
    fhir:ConceptMap.sourceScopeCanonical [ canonical(ValueSet) ]
  # ConceptMap.targetScope[x] : 0..1 The target value set which provides context for the mappings. One of these 2
    fhir:ConceptMap.targetScopeUri [ uri ]
    fhir:ConceptMap.targetScopeCanonical [ canonical(ValueSet) ]

  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:
    fhir:
    fhir:
    fhir:

    fhir:ConceptMap.group.source [ canonical(CodeSystem) ]; # 0..1 Source system where concepts to be mapped are defined
    fhir:ConceptMap.group.target [ canonical(CodeSystem) ]; # 0..1 Target system that the concepts are to be mapped to

    fhir:ConceptMap.group.element [ # 1..* Mappings for a concept from the source set
      fhir:ConceptMap.group.element.code [ code ]; # 0..1 Identifies element being mapped
      fhir:ConceptMap.group.element.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.element.valueSet [ canonical(ValueSet) ]; # 0..1 Identifies elements being mapped
      fhir:ConceptMap.group.element.noMap [ boolean ]; # 0..1 No mapping to a target concept for this source concept

      fhir:ConceptMap.group.element.target [ # 0..* Concept in target system for element
        fhir:ConceptMap.group.element.target.code [ code ]; # 0..1 Code that identifies the target element
        fhir:ConceptMap.group.element.target.display [ string ]; # 0..1 Display for the code
        fhir:
        fhir:
        fhir:
          fhir:
          fhir:
          fhir:
          fhir:

        fhir:ConceptMap.group.element.target.valueSet [ canonical(ValueSet) ]; # 0..1 Identifies the set of target elements
        fhir:ConceptMap.group.element.target.relationship [ code ]; # 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 I Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other properties required for this mapping
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 A reference to a property that may be required to refine the mapping
          # ConceptMap.group.element.target.dependsOn.value[x] : 0..1 Value of the referenced property. One of these 9
            fhir:ConceptMap.group.element.target.dependsOn.valueCode [ code ]
            fhir:ConceptMap.group.element.target.dependsOn.valueCoding [ Coding ]
            fhir:ConceptMap.group.element.target.dependsOn.valueString [ string ]
            fhir:ConceptMap.group.element.target.dependsOn.valueInteger [ integer ]
            fhir:ConceptMap.group.element.target.dependsOn.valueBoolean [ boolean ]
            fhir:ConceptMap.group.element.target.dependsOn.valueDateTime [ dateTime ]
            fhir:ConceptMap.group.element.target.dependsOn.valueDecimal [ decimal ]
            fhir:ConceptMap.group.element.target.dependsOn.valueUri [ uri ]
            fhir:ConceptMap.group.element.target.dependsOn.valueId [ id ]
          fhir:ConceptMap.group.element.target.dependsOn.valueSet [ canonical(ValueSet) ]; # 0..1 The mapping depends on a property with a value from this value set

        ], ...;
        fhir:

        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other properties that this mapping also produces

      ], ...;
    ], ...;
    fhir:
      fhir:

    fhir:ConceptMap.group.unmapped [ # 0..1 What to do when there is no mapping target for the source concept
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 use-source-code | fixed | other-map

      fhir:ConceptMap.group.unmapped.code [ code ]; # 0..1 Fixed code when mode = fixed
      fhir:ConceptMap.group.unmapped.display [ string ]; # 0..1 Display for the code
      fhir:

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

    ];
  ], ...;
]

Changes since R4

ConceptMap
ConceptMap.identifier
  • No Changes Max Cardinality changed from 1 to *
  • Max Cardinality changed from 1 to *
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.sourceScope[x]
  • Added Element
ConceptMap.targetScope[x]
  • Added Element
ConceptMap.group.source
  • Type changed from uri to canonical(CodeSystem)
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.target
  • Type changed from uri to canonical(CodeSystem)
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.element.valueSet
  • Added Element
ConceptMap.group.element.noMap
  • Added Element
ConceptMap.group.element.target.valueSet
  • Added Element
ConceptMap.group.element.target.relationship
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.value[x]
  • Added Element
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Added Element
ConceptMap.source[x]
  • deleted
ConceptMap.target[x]
  • deleted
ConceptMap.group.sourceVersion
  • deleted
ConceptMap.group.targetVersion
  • deleted
ConceptMap.group.element.target.equivalence
  • deleted
ConceptMap.group.element.target.dependsOn.system
  • deleted
ConceptMap.group.element.target.dependsOn.value
  • deleted
ConceptMap.group.element.target.dependsOn.display
  • deleted
ConceptMap.group.unmapped.url
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

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

Structure

uri Display
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . ConceptMap TU DomainResource A map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

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

. . . version Σ 0..1 string Business version of the concept map
. . . 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 ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher 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 Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this concept map is defined
. . . copyright T 0..1 markdown Use and/or publishing restrictions
. . source[x] . approvalDate 0..1 date When the ConceptMap was approved by publisher
... lastReviewDate 0..1 date When the ConceptMap was last reviewed
... effectivePeriod Σ 0..1 Period The source value set that contains When the concepts that are being mapped ConceptMap is expected to be used
. . sourceUri . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
DefinitionTopic ( Example )

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

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

. . . reviewer sourceCanonical 0..* ContactDetail Who reviewed the ConceptMap
canonical
. . . endorser ( ValueSet ) 0..* ContactDetail Who endorsed the ConceptMap

... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.

. . . target[x] sourceScope[x] Σ 0..1 The target source value set which provides context for that contains the mappings concepts that are being mapped
. . . . targetUri sourceScopeUri uri
. . . . targetCanonical sourceScopeCanonical canonical ( ValueSet )
. . group . targetScope[x] Σ 0..* 0..1 BackboneElement Same source and The target systems value set which provides context for the mappings
. . . . source targetScopeUri uri
.... targetScopeCanonical canonical ( ValueSet )
... group 0..1 0..* uri BackboneElement Source system where concepts to be mapped are defined Same source and target systems

. . . sourceVersion . source 0..1 string canonical ( CodeSystem ) Specific version of the code Source system where concepts to be mapped are defined
. . . . target 0..1 uri canonical ( CodeSystem ) Target system that the concepts are to be mapped to
. . . targetVersion . element C 0..1 1..* string BackboneElement Specific version of Mappings for a concept from the source set
+ Rule: If noMap is present, target SHALL NOT be present
+ Rule: Either code system or valueSet SHALL be present but not both.

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

. . . . . . code 0..1 code Code that identifies the target element
. . . . . . display 0..1 string Display for the code
. . . . . . valueSet 0..1 canonical ( ValueSet ) Identifies the set of target elements
. . . . . . equivalence relationship ?! 1..1 code relatedto related-to | equivalent | equal | wider | subsumes | narrower | specializes | inexact source-is-narrower-than-target | unmatched source-is-broader-than-target | disjoint not-related-to
ConceptMapEquivalence ConceptMapRelationship ( Required )
. . . . . . comment I C 0..1 string Description of status/issues in mapping
. . . . . . dependsOn C 0..* BackboneElement Other elements properties required for this mapping (from context)
+ Rule: One of value[x] or valueSet must exist, but not both.

. . . . . . . property 1..1 uri Reference A reference to a property that may be required to refine the mapping depends on
. . . . . . system . value[x] 0..1 canonical ( CodeSystem ) Code System (if necessary) Value of the referenced property
. . . . . . . . value valueCode code
. . . . . . . . valueCoding Coding
. . . . . . . . valueString 1..1 string
. . . . . . . . valueInteger integer
........ valueBoolean Value of the referenced element boolean
. . . . . . . . display valueDateTime dateTime
. . . . . . . . valueDecimal decimal
. . . . . . . . valueUri uri
........ valueId id
....... valueSet 0..1 string canonical ( ValueSet ) Display for the code (if value is The mapping depends on a code) property with a value from this value set
. . . . . . product 0..* see dependsOn Other concepts properties that this mapping also produces

. . . . unmapped I C 0..1 BackboneElement What to do when there is no mapping target for the source concept
+ Rule: If the mode is 'fixed', either a code or valueSet must be provided provided, but not both.
+ Rule: If the mode is 'other-map', a url for the other map must be provided
+ Rule: If the mode is not 'fixed', code, display and valueSet are not allowed
+ Rule: If the mode is not 'other-map', relationship must be provided
+ Rule: If the mode is not 'other-map', otherMap is not allowed
. . . . . mode 1..1 code provided use-source-code | fixed | other-map
ConceptMapGroupUnmappedMode ( Required )
. . . . . code 0..1 code Fixed code when mode = fixed
. . . . . display 0..1 string Display for the code
. . . . . url valueSet 0..1 canonical ( ValueSet ) Fixed code set when mode = fixed
..... relationship ?! 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
ConceptMapRelationship ( Required )
..... otherMap 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 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..1] [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] 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 ! » A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The date (and optionally time) when the concept map was published. 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 that published 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 is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet 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 restrictions on the use and publishing of the concept map copyright : markdown [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 primarily responsible for review of some aspect of the ConceptMap reviewer : ContactDetail [0..*] An individual or organization 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 relatedArtifact : RelatedArtifact [0..*] Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set source[x] sourceScope[x] : Element PrimitiveType [0..1] « uri | canonical ( ValueSet ) » The target value set provides context Identifier for the mappings. Note that the mapping is made between concepts, not between value sets, but the target value set that provides important context about how the concept mapping choices are made made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set target[x] targetScope[x] : Element PrimitiveType [0..1] « uri | canonical ( ValueSet ) » Group An absolute URI that identifies the source system where the concepts to be mapped are defined source : uri canonical [0..1] The specific version of the code system, as determined by the code system authority sourceVersion : string « CodeSystem [0..1] » An absolute URI that identifies the target system that the concepts will be mapped to target : uri canonical [0..1] The specific version of the code system, as determined by the code system authority targetVersion : string « CodeSystem [0..1] » SourceElement Identity (code or path) or the element/item being mapped code : code [0..1] 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 codes being mapped valueSet : canonical [0..1] « ValueSet » If noMap = true this indicates that no mapping to a target concept exists for this source concept noMap : boolean [0..1] TargetElement Identity (code or path) or the element/item that the map refers to code : code [0..1] The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] The equivalence set of codes that the map refers to valueSet : canonical [0..1] « ValueSet » The relationship between the source and target concepts (counting for the dependencies and products). concepts. The equivalence relationship is read from target to source (e.g. the to target is 'wider' than the source) (e.g. source-is-narrower-than-target) (this element modifies the meaning of other elements) equivalence relationship : code [1..1] « null (Strength=Required) ConceptMapEquivalence ConceptMapRelationship ! » A description of status/issues in mapping that conveys additional information not represented in the structured data comment : string [0..1] « This element has or is affected by some invariants C » OtherElement A reference to an element a property that holds a coded value that corresponds the map depends on. This value can be supplied to a code system property. The idea is that the information model carries an element somewhere that is labeled $translate operation to correspond with a code system property select the appropriate targets property : uri [1..1] An absolute URI that identifies the code system of the dependency code (if the source/dependency is a Property value set that crosses code systems) the map depends on system value[x] : canonical DataType [0..1] « CodeSystem code » | Coding | string | integer | boolean | Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to value dateTime : string | decimal [1..1] | uri | id » The display for This mapping applies if the code. The display property value is only provided to help editors when editing the concept map a code from this value set display valueSet : string canonical [0..1] « ValueSet » 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 ! » The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code code : code [0..1] 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 fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes valueSet : canonical [0..1] « ValueSet » 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 ! » 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 url otherMap : canonical [0..1] « ConceptMap » A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element property can be resolved, and it has the specified value dependsOn [0..*] A set Product is the output of a ConceptMap that provides additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped values relevant to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but interpretation of the equivalence cannot be relied on mapping target 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 for to a target concept from the source concept. "Unmapped" does not include codes that are unmatched, and This provides the unmapped "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored in if a code is specified to have equivalence relationship = unmatched not-related-to 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 -->
 <
 <</identifier>

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

 <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]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <
 <

 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <</source[x]>
 <</target[x]>

 <approvalDate value="[date]"/><!-- 0..1 When the ConceptMap was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the ConceptMap was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the ConceptMap is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the ConceptMap --></author>
 <editor><!-- 0..* ContactDetail Who edited the ConceptMap --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the ConceptMap --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the ConceptMap --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <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]"/><!-- 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <valueSet><!-- 0..1 canonical(ValueSet) Identifies elements being mapped --></valueSet>
   <noMap value="[boolean]"/><!-- 0..1 No mapping to a target concept for this source concept -->

   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <
    <
    <
     <
     <</system>
     <
     <

    <valueSet><!-- 0..1 canonical(ValueSet) Identifies the set of target elements --></valueSet>
    <relationship value="[code]"/><!-- 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
    <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other properties required for this mapping -->
     <property value="[uri]"/><!-- 1..1 A reference to a property that may be required to refine the mapping -->
     <value[x]><!-- 0..1 code|Coding|string|integer|boolean|dateTime|decimal|uri|
       id Value of the referenced property --></value[x]>

     <valueSet><!-- 0..1 canonical(ValueSet) The mapping depends on a property with a value from this value set --></valueSet>

    </dependsOn>
    <</product>

    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other properties that this mapping also produces --></product>

   </target>
  </element>
  <
   <

  <unmapped>  <!-- 0..1 What to do when there is no mapping target for the source concept -->
   <mode value="[code]"/><!-- 1..1 use-source-code | fixed | other-map -->

   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <</url>

   <valueSet><!-- 0..1 canonical(ValueSet) Fixed code set when mode = fixed --></valueSet>
   <relationship value="[code]"/><!-- 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to -->
   <otherMap><!-- 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
  "

  "name" : "<string>", // I Name for this concept map (computer friendly)

  "title" : "<string>", // Name for this concept map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "
  "

  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
  "purpose" : "<markdown>", // Why this concept map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  
  ">",
  " },
  
  ">",
  " },

  "approvalDate" : "<date>", // When the ConceptMap was approved by publisher
  "lastReviewDate" : "<date>", // When the ConceptMap was last reviewed
  "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.
  // 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>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "valueSet" : "<canonical(ValueSet)>", // Identifies elements being mapped
      "noMap" : <boolean>, // No mapping to a target concept for this source concept

      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "
        "
        "
          "
          "
          "
          "

        "valueSet" : "<canonical(ValueSet)>", // Identifies the set of target elements
        "relationship" : "<code>", // R!  related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        "comment" : "<string>", // I Description of status/issues in mapping
        "dependsOn" : [{ // Other properties required for this mapping
          "property" : "<uri>", // R!  A reference to a property that may be required to refine the mapping
          // value[x]: Value of the referenced property. One of these 9:

          "valueCode" : "<code>",
          "valueCoding" : { Coding },
          "valueString" : "<string>",
          "valueInteger" : <integer>,
          "valueBoolean" : <boolean>,
          "valueDateTime" : "<dateTime>",
          "valueDecimal" : <decimal>,
          "valueUri" : "<uri>",
          "valueId" : "<id>",
          "valueSet" : "<canonical(ValueSet)>" // The mapping depends on a property with a value from this value set

        }],
        "

        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other properties that this mapping also produces

      }]
    }],
    "
      "

    "unmapped" : { // What to do when there is no mapping target for the source concept
      "mode" : "<code>", // R!  use-source-code | fixed | other-map

      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "

      "valueSet" : "<canonical(ValueSet)>", // Fixed code set when mode = fixed
      "relationship" : "<code>", // related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
      "otherMap" : "<canonical(ConceptMap)>" // canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

    }
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConceptMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:

  fhir:ConceptMap.url [ uri ]; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique)
  fhir:ConceptMap.identifier [ Identifier ], ... ; # 0..* Additional identifier for the concept map

  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:

  fhir:ConceptMap.name [ string ]; # 0..1 I Name for this concept map (computer friendly)

  fhir:ConceptMap.title [ string ]; # 0..1 Name for this concept map (human friendly)
  fhir:ConceptMap.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:
  fhir:

  fhir:ConceptMap.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)

  fhir:ConceptMap.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConceptMap.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for concept map (if applicable)
  fhir:ConceptMap.purpose [ markdown ]; # 0..1 Why this concept map is defined
  fhir:ConceptMap.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  # . One of these 2
    fhir: ]
    fhir:) ]
  # . One of these 2
    fhir: ]
    fhir:) ]

  fhir:ConceptMap.approvalDate [ date ]; # 0..1 When the ConceptMap was approved by publisher
  fhir:ConceptMap.lastReviewDate [ date ]; # 0..1 When the ConceptMap was last reviewed
  fhir:ConceptMap.effectivePeriod [ Period ]; # 0..1 When the ConceptMap is expected to be used
  fhir:ConceptMap.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:ConceptMap.author [ ContactDetail ], ... ; # 0..* Who authored the ConceptMap
  fhir:ConceptMap.editor [ ContactDetail ], ... ; # 0..* Who edited the ConceptMap
  fhir:ConceptMap.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the ConceptMap
  fhir:ConceptMap.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the ConceptMap
  fhir:ConceptMap.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  # ConceptMap.sourceScope[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2
    fhir:ConceptMap.sourceScopeUri [ uri ]
    fhir:ConceptMap.sourceScopeCanonical [ canonical(ValueSet) ]
  # ConceptMap.targetScope[x] : 0..1 The target value set which provides context for the mappings. One of these 2
    fhir:ConceptMap.targetScopeUri [ uri ]
    fhir:ConceptMap.targetScopeCanonical [ canonical(ValueSet) ]

  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:
    fhir:
    fhir:
    fhir:

    fhir:ConceptMap.group.source [ canonical(CodeSystem) ]; # 0..1 Source system where concepts to be mapped are defined
    fhir:ConceptMap.group.target [ canonical(CodeSystem) ]; # 0..1 Target system that the concepts are to be mapped to

    fhir:ConceptMap.group.element [ # 1..* Mappings for a concept from the source set
      fhir:ConceptMap.group.element.code [ code ]; # 0..1 Identifies element being mapped
      fhir:ConceptMap.group.element.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.element.valueSet [ canonical(ValueSet) ]; # 0..1 Identifies elements being mapped
      fhir:ConceptMap.group.element.noMap [ boolean ]; # 0..1 No mapping to a target concept for this source concept

      fhir:ConceptMap.group.element.target [ # 0..* Concept in target system for element
        fhir:ConceptMap.group.element.target.code [ code ]; # 0..1 Code that identifies the target element
        fhir:ConceptMap.group.element.target.display [ string ]; # 0..1 Display for the code
        fhir:
        fhir:
        fhir:
          fhir:
          fhir:
          fhir:
          fhir:

        fhir:ConceptMap.group.element.target.valueSet [ canonical(ValueSet) ]; # 0..1 Identifies the set of target elements
        fhir:ConceptMap.group.element.target.relationship [ code ]; # 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 I Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other properties required for this mapping
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 A reference to a property that may be required to refine the mapping
          # ConceptMap.group.element.target.dependsOn.value[x] : 0..1 Value of the referenced property. One of these 9
            fhir:ConceptMap.group.element.target.dependsOn.valueCode [ code ]
            fhir:ConceptMap.group.element.target.dependsOn.valueCoding [ Coding ]
            fhir:ConceptMap.group.element.target.dependsOn.valueString [ string ]
            fhir:ConceptMap.group.element.target.dependsOn.valueInteger [ integer ]
            fhir:ConceptMap.group.element.target.dependsOn.valueBoolean [ boolean ]
            fhir:ConceptMap.group.element.target.dependsOn.valueDateTime [ dateTime ]
            fhir:ConceptMap.group.element.target.dependsOn.valueDecimal [ decimal ]
            fhir:ConceptMap.group.element.target.dependsOn.valueUri [ uri ]
            fhir:ConceptMap.group.element.target.dependsOn.valueId [ id ]
          fhir:ConceptMap.group.element.target.dependsOn.valueSet [ canonical(ValueSet) ]; # 0..1 The mapping depends on a property with a value from this value set

        ], ...;
        fhir:

        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other properties that this mapping also produces

      ], ...;
    ], ...;
    fhir:
      fhir:

    fhir:ConceptMap.group.unmapped [ # 0..1 What to do when there is no mapping target for the source concept
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 use-source-code | fixed | other-map

      fhir:ConceptMap.group.unmapped.code [ code ]; # 0..1 Fixed code when mode = fixed
      fhir:ConceptMap.group.unmapped.display [ string ]; # 0..1 Display for the code
      fhir:

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

    ];
  ], ...;
]

Changes since Release 4

ConceptMap
ConceptMap.identifier
  • No Changes Max Cardinality changed from 1 to *
  • Max Cardinality changed from 1 to *
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.sourceScope[x]
  • Added Element
ConceptMap.targetScope[x]
  • Added Element
ConceptMap.group.source
  • Type changed from uri to canonical(CodeSystem)
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.target
  • Type changed from uri to canonical(CodeSystem)
  • Type changed from uri to canonical(CodeSystem)
ConceptMap.group.element.valueSet
  • Added Element
ConceptMap.group.element.noMap
  • Added Element
ConceptMap.group.element.target.valueSet
  • Added Element
ConceptMap.group.element.target.relationship
  • Added Mandatory Element
ConceptMap.group.element.target.dependsOn.value[x]
  • Added Element
ConceptMap.group.element.target.dependsOn.valueSet
  • Added Element
ConceptMap.group.unmapped.valueSet
  • Added Element
ConceptMap.group.unmapped.relationship
  • Added Element
ConceptMap.group.unmapped.otherMap
  • Added Element
ConceptMap.source[x]
  • deleted
ConceptMap.target[x]
  • deleted
ConceptMap.group.sourceVersion
  • deleted
ConceptMap.group.targetVersion
  • deleted
ConceptMap.group.element.target.equivalence
  • deleted
ConceptMap.group.element.target.dependsOn.system
  • deleted
ConceptMap.group.element.target.dependsOn.value
  • deleted
ConceptMap.group.element.target.dependsOn.display
  • deleted
ConceptMap.group.unmapped.url
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

4.10.5.1 Terminology Bindings

ConceptMap.group.element.target.equivalence
Path Definition Type Reference
ConceptMap.status

The lifecycle status of an artifact.

Required PublicationStatus
ConceptMap.jurisdiction

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.

 Extensible Jurisdiction ValueSet JurisdictionValueSet
ConceptMap.topic

High-level categorization of the definition, used for searching, sorting, and filtering.

Example DefinitionTopic
ConceptMap.group.element.target.relationship

The relationship between concepts.

Required ConceptMapEquivalence ConceptMapRelationship
ConceptMap.group.unmapped.mode

Defines which action to take if there is no match in the group.

Required ConceptMapGroupUnmappedMode
ConceptMap.group.unmapped.relationship

The relationship between concepts.

Required ConceptMapRelationship

4.10.5.2 Constraints

id UniqueKey Level Location Description Expression
cmd-0 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_]){0,254}') name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
cmd-1 img  cnl-1 Warning ConceptMap.url URL should not contain | or # - these characters make processing canonical references problematic url.matches('([^|#])*')
img  cmd-1 Rule ConceptMap.group.element.target If the map is narrower source-is-broader-than-target or inexact, not-related-to, there SHALL be some comments comments, unless the status is 'draft' comment.exists() or equivalence.empty() (status = draft) or ((equivalence relationship.empty() or ((relationship != 'narrower') 'source-is-broader-than-target') and (equivalence (relationship != 'inexact')) 'not-related-to'))
cmd-2 img  cmd-2 Rule ConceptMap.group.unmapped If the mode is 'fixed', either a code or valueSet must be provided provided, but not both. (mode = 'fixed') implies code.exists() ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
cmd-3 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 url.exists() otherMap.exists()
img  cmd-4 Rule ConceptMap.group.element If noMap is present, target SHALL NOT be present (noMap.exists() and target.empty()) or noMap.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()

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 equivalence relationship is characterized as "narrower", "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 Mapping Dependencies 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 a radiology imaging request that has 2 elements: modality, and body site, and another radiology imaging request that pre-coordinates both of these into a single code modality+body site. 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 DependsOn.property Relationship DependsOn Target Concept Details
Code from http://example.com/ehr/codes Target Concept field (dependsOn) Code from http://snomed.info/sct subject (product)
diab Diabetes X-Ray diagnosis Bodysite is equivalent to 73211009 Diabetes mellitus Chest patient
diab Diabetes Chest-XRay 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 must SHOULD also provide a value for the element element(s) identified in dependsOn.property so that the correct mapping can be performed. To support the reverse operation,

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

Interpretation and works in reverse. 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 a real example examples of a mapping mappings with dependencies, check the 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 url otherMap . This is useful when a published concept map needs to be varied for a few specific cases on an institutional bass 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 an equivalence a relationship value of unmatched (or disjoint). not-related-to .

4.10.10 Implicit Code Systems

The ConceptMap resource is intended to map between concepts defined in a code system. It can also be useful to use the ConceptMap resource to define relationships between concepts defined in other kinds of resources. Here are some common kind of conceptual maps:

Though these resources are not explicitly defining code systems, they do define 'concept's that can still usefully be treated as code systems for the sake of subsetting (e.g. ValueSet ) and defining relationships (e.g. ConceptMap ). See Implicit Code Systems for further information.

Note that this is different from StructureMap because that is intended to define an executional transform between structures, not a conceptual model.

4.10.11 Implicit Concept Maps

Implicit concept maps are those whose specification can be predicted based on the grammar and/or content of the underlying code system, and the known structure of the URL that identifies them. This allows a single URL to serve as a concept map definition that defines a mapping between two sets of concepts, and which can serve as the basis for the $translate operation. If any ConceptMap resources exist with an identifier that conforms to the specified implicit concept map URL patterns, the content of the resource must conform to the template provided. Canonical references to ConceptMap resource instances are made using their URI.

Currently implicit concept map url patterns have been defined and documented for use with FHIR terminology services for only the SNOMED CT code system. Particular FHIR terminology servers might or might not support any or all of these URL patterns.

The following link describes the currently defined FHIR implicit concept map URL patterns for SNOMED CT:

4.10.12 Search Parameters

Search parameters for 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 as CodeableConcept) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the concept map (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) 30 Resources
context-type token A type of use context assigned to the concept map ConceptMap.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the concept map On ConceptMap.useContext:
  context-type: code
  context-quantity: value.as(Quantity) value.ofType(Quantity) | value.as(Range) value.ofType(Range) 		30 Resources
context-type-value composite A use context type and value assigned to the concept map On ConceptMap.useContext:
  context-type: code
  context: value.as(CodeableConcept) value.ofType(CodeableConcept) 		30 Resources
date date The concept map publication date ConceptMap.date 30 Resources
dependson uri Reference to property Other properties required for this mapping depends on ConceptMap.group.element.target.dependsOn.property
derived-from reference A resource that the ConceptMap is derived from ConceptMap.relatedArtifact.where(type='derived-from').resource
(Any) 		10 Resources
description string The description of the concept map ConceptMap.description 28 Resources
effective date The time during which the ConceptMap is intended to be in use ConceptMap.effectivePeriod 12 Resources
identifier token External identifier for the concept map ConceptMap.identifier 28 Resources
jurisdiction token Intended jurisdiction for the concept map ConceptMap.jurisdiction 26 Resources
name string Computationally friendly name of the concept map ConceptMap.name 26 Resources
other other-map reference canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped ConceptMap.group.unmapped.url ConceptMap.group.unmapped.otherMap
( ConceptMap )
product predecessor uri reference Reference to property mapping depends on The predecessor of the ConceptMap ConceptMap.group.element.target.product.property ConceptMap.relatedArtifact.where(type='predecessor').resource
(Any) 		10 Resources
publisher product string uri Name of the publisher of the concept map Other properties that this mapping also produces ConceptMap.publisher ConceptMap.group.element.target.product.property
source publisher reference string The source value set that contains Name of the concepts that are being mapped publisher of the concept map (ConceptMap.source as canonical) ( ValueSet ) ConceptMap.publisher 30 Resources
source-code token Identifies element elements being mapped ConceptMap.group.element.code
source-system source-group-system uri reference Source system where concepts to be mapped are defined ConceptMap.group.source
( CodeSystem )
source-uri source-scope reference The source value set that contains the concepts that are being mapped (ConceptMap.source (ConceptMap.sourceScope as uri) canonical)
( ValueSet )
status source-scope-uri token uri The current status of URI for the concept map source value set that contains the concepts being mapped ConceptMap.status (ConceptMap.sourceScope as uri)
target status reference token The target value set which provides context for current status of the mappings concept map (ConceptMap.target as canonical) ( ValueSet ) ConceptMap.status 34 Resources
target-code token Code that identifies the target element ConceptMap.group.element.target.code
target-system target-group-system uri reference Target system that the concepts are to be mapped to ConceptMap.group.target
( CodeSystem )
target-uri target-scope reference The target value set which provides context for the mappings (ConceptMap.target (ConceptMap.targetScope as uri) canonical)
( ValueSet )
target-scope-uri uri The URI for the target value set that contains the concepts being mapped. (ConceptMap.targetScope as uri)
title string The human-friendly name of the concept map ConceptMap.title 27 Resources
topic token Topics associated with the ConceptMap ConceptMap.topic 10 Resources
url uri The uri URI that identifies the concept map ConceptMap.url 33 Resources
version token The business version of the concept map ConceptMap.version 30 Resources