This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.15 Resource ConceptMap - Content

A statement of relationships from one set of concepts to one or more other concept systems.

6.15.1 Scope and Usage

A concept map defines a mapping from a concept defined in one system to one or more concepts defined in other systems. Mappings are always framed within the concept of value sets - they are specific to a context of use.

6.15.2 Background and Context

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

6.15.3 Resource Content

ConceptMap (Resource)The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)identifier : string 0..1The 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 profile author manually and the value should be a timestampversion : string 0..1A free text natural language name describing the concept mapname : string 1..1The name of the individual or organization that published the concept mappublisher : string 0..1Contacts of the publisher to assist a user in finding and communicating with the publishertelecom : Contact 0..*A free text natural language description of the use of the concept map - reason for definition, conditions of use, etcdescription : string 0..1A copyright statement relating to the concept map and/or its contentscopyright : string 0..1The status of the concept map (this element modifies the meaning of other elements)status : code 1..1 <<The lifecycle status of a Value Set or Concept MapValueSetStatus>>This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usageexperimental : boolean 0..1The date that the concept map status was last changeddate : dateTime 0..1The source value set that specifies the concepts that are being mappedsource : Resource(ValueSet) 1..1The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are madetarget : Resource(ValueSet) 1..1ConceptSystem that defines the concept being mappedsystem : uri 1..1Identifies concept being mappedcode : code 0..1OtherConceptA reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definitionconcept : uri 1..1System for a concept in the referenced conceptsystem : uri 1..1Code for a concept in the referenced conceptcode : code 1..1MapSystem of the targetsystem : uri 0..1Code that identifies the target conceptcode : code 0..1equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)equivalence : code 1..1 <<The degree of equivalence between conceptsConceptMapEquivalence>>Description of status/issues in mappingcomments : string 0..1A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified valuedependsOn0..*A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied onproduct0..*A concept from the target value set that this concept maps tomap0..*Mappings for a concept from the source valuesetconcept0..*
<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: extension, modifierExtension, language, text, and contained -->
 <identifier value="[string]"/><!-- 0..1 Logical id to reference this concept map § -->
 <version value="[string]"/><!-- 0..1 Logical id for this version of the concept map § -->
 <name value="[string]"/><!-- 1..1 Informal name for this concept map § -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) § -->
 <telecom><!-- 0..* Contact Contact information of the publisher § --></telecom>
 <description value="[string]"/><!-- 0..1 Human language description of the concept map § -->
 <copyright value="[string]"/><!-- 0..1 About the concept map or its content -->
 <status value="[code]"/><!-- 1..1 draft | active | retired § -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage § -->
 <date value="[dateTime]"/><!-- 0..1 Date for given status § -->
 <source><!-- 1..1 Resource(ValueSet) Identifies the source value set which is being mapped § --></source>
 <target><!-- 1..1 Resource(ValueSet) Provides context to the mappings § --></target>
 <concept>  <!-- 0..* Mappings for a concept from the source valueset -->
  <system value="[uri]"/><!-- 1..1 System that defines the concept being mapped -->
  <code value="[code]"/><!-- 0..1 Identifies concept being mapped -->
  <dependsOn>  <!-- 0..* Other concepts required for this mapping (from context) -->
   <concept value="[uri]"/><!-- 1..1 Reference to element/field/valueset provides the context -->
   <system value="[uri]"/><!-- 1..1 System for a concept in the referenced concept -->
   <code value="[code]"/><!-- 1..1 Code for a concept in the referenced concept -->
  </dependsOn>
  <map>  <!-- 0..* A concept from the target value set that this concept maps to -->
   <system value="[uri]"/><!-- ?? 0..1 System of the target -->
   <code value="[code]"/><!-- 0..1 Code that identifies the target concept -->
   <equivalence value="[code]"/><!-- 1..1 equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint -->
   <comments value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
   <product><!-- 0..* Content as for ConceptMap.concept.dependsOn Other concepts that this mapping also produces --></product>
  </map>
 </concept>
</ConceptMap>

Alternate definitions: Schema/Schematron, Resource Profile

6.15.3.1 Terminology Bindings

PathDefinitionTypeReference
ConceptMap.status The lifecycle status of a Value Set or Concept MapFixedhttp://hl7.org/fhir/valueset-status
ConceptMap.concept.map.equivalence The degree of equivalence between conceptsFixedhttp://hl7.org/fhir/concept-equivalence

6.15.3.2 Constraints

6.15.4 Notes

6.15.5 Concept Translation

An application may offer to provide concept translation services for other applications. In this case, the standard way for an application to ask for concept translation is to perform a search on the value set with _query=translate:

  GET [service-url]/ConceptMap/?_query=translate&identity=:valueSet&system=:system&version=:version&code=:code&...

The identifier is the ValueSet.identifier of the value set used when the concept (system/code pair) was chosen. If an identifier is provided, the application performing the translation can locate a concept map for a matching value set; if no value set is identified, the application must look for a code equivalence assertion in a concept map where the value set the provides context matches the entire code system. The values for system, version, and code are those from the Coding data type. Version is optional, and code and system are mandatory. Alternatively, the parameter "coding" or "codeableconcept" can be used - the value of these parameters is a URL encoded XML or JSON representation of the two data types respectively.

The result of this query is an Operation Outcome with an extension http://hl7.org/fhir/Profile/general-extensions#translation, which is a codeableConcept that expresses the translation, if one could be found, or an error if one could not be found. The Operation Outcome may include warnings about how the translation was made.

6.15.6 Search Parameters

Search parameters for this resource. The standard parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
_idtokenThe logical resource id associated with the resource (must be supported by all servers)
_languagetokenThe language of the resource
datedateThe concept map publication dateConceptMap.date
dependsontokenReference to element/field/valueset provides the contextConceptMap.concept.dependsOn.concept
descriptionstringText search in the description of the concept mapConceptMap.description
identifiertokenThe identifier of the concept mapConceptMap.identifier
namestringName of the concept mapConceptMap.name
producttokenReference to element/field/valueset provides the contextConceptMap.concept.map.product.concept
publisherstringName of the publisher of the concept mapConceptMap.publisher
sourcereferenceThe system for any concepts mapped by this concept mapConceptMap.source
(ValueSet)
statustokenStatus of the concept mapConceptMap.status
systemtokenThe system for any destination concepts mapped by this mapConceptMap.concept.map.system
targetreferenceProvides context to the mappingsConceptMap.target
(ValueSet)
versiontokenThe version identifier of the concept mapConceptMap.version

comments powered by Disqus