DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). 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 6.23 Resource ConceptMap - Content

Vocabulary Work Group Maturity Level : 2 Compartments : Not linked to any defined compartments

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

6.15.1 6.23.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 one way - from the concept source to the destination. In many cases, the reverse mappings are valid, but this cannot be assumed to be the case.

Mappings between code systems are only defined in the context of the specified source and destination value sets - they are specific to a particular context of use. 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. Note that all code systems have value sets that include the entire code system, and these value sets can be used for mappings that are valid in all contexts.

Each mapping for a concept from source to target includes an equivalence property that specifies how similar the mapping is (or, in some cases, that there is no valid mapping). There is one element for each concept or field in the source 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)

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

6.15.2 6.23.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 6.23.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
.. ConceptMap DomainResource A map from one set of concepts to one or more other concepts
... url Σ 0..1 uri Globally unique logical id for concept map
... identifier Σ 0..1 Identifier Additional identifier for the concept map
... version Σ 0..1 string Logical id for this version of the concept map
... name Σ 0..1 string Informal name for this concept map
... status ?! Σ 1..1 code draft | active | retired
ConformanceResourceStatus ( Required )
... experimental Σ 0..1 boolean If for testing purposes, not real usage
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* BackboneElement Contact details of the publisher
.... name Σ 0..1 string Name of a individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or publisher
... date Σ 0..1 dateTime Date for given status
... description Σ 0..1 string Human language description of the concept map
... useContext Σ 0..* CodeableConcept Content intends to support these contexts
Context of Use ValueSet ( Extensible )
... requirements 0..1 string Why needed
... copyright 0..1 string Use and/or publishing restrictions
... source[x] Σ 1..1 Identifies the source of the concepts which are being mapped
.... sourceUri uri
.... sourceReference Reference ( ValueSet | StructureDefinition )
... target[x] Σ 1..1 Provides context to the mappings
.... targetUri uri
.... targetReference Reference ( ValueSet | StructureDefinition )
... element 0..* BackboneElement Mappings for a concept from the source set
.... codeSystem 0..1 uri Code System (if value set crosses code systems)
.... code 0..1 code Identifies element being mapped
.... target I 0..* BackboneElement Concept in target system for element
If the map is narrower or inexact, there SHALL be some comments
..... codeSystem 0..1 uri System of the target (if necessary)
..... code 0..1 code Code that identifies the target element
..... equivalence ?! 1..1 code equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence ( Required )
..... comments I 0..1 string Description of status/issues in mapping
..... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
...... element 1..1 uri Reference to element/field/ValueSet mapping depends on
...... codeSystem 1..1 uri Code System (if necessary)
...... code 1..1 string Value of the referenced element
..... product 0..* see dependsOn Other concepts that this mapping also produces

doco Documentation for this format

UML Diagram

ConceptMap ( Resource DomainResource ) The identifier An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should instance. This SHALL be a URL, SHOULD be globally unique OID, UUID, unique, and SHOULD be an address at which this concept map is (or will be) published url : uri [0..1] Formal identifier that is used to identify this concept map when it is represented in other formats, or URI) referenced in a specification, model, design or an instance identifier : string Identifier 0..1 [0..1] 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 profile author manually and the value should be a timestamp version : string 0..1 [0..1] A free text natural language name describing the concept map name : string 1..1 [0..1] The 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 Map. (Strength=Required) ConformanceResourceStatus ! » This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage experimental : boolean [0..1] The name of the individual or organization that published the concept map publisher : string 0..1 [0..1] Contacts The date this version of the publisher to assist a user in finding concept map was published. The date must change when the business version changes, if it does, and communicating with it must change if the publisher status code changes. In addition, it should change when the substantive content of the concept map changes telecom date : Contact dateTime 0..* [0..1] A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc description : string 0..1 [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of concept map instances useContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible) Context of Use ValueSet + » Explains why this concept map is needed and why it has been constrained as it has requirements : string [0..1] A copyright statement relating to the concept map and/or its contents copyright : string [0..1] The source value set that specifies the concepts that are being mapped source[x] : Type [1..1] « uri | Reference ( ValueSet | StructureDefinition ) » The 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 made target[x] : Type [1..1] « uri | Reference ( ValueSet | StructureDefinition ) » Contact The name of an individual to contact regarding the concept map name : string [0..1] Contact details for individual (if a name was provided) or the publisher telecom : ContactPoint [0..*] SourceElement An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system) codeSystem : uri [0..1] Identity (code or path) or the element/item being mapped code : code [0..1] TargetElement An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems) codeSystem : uri [0..1] Identity (code or path) or the element/item that the map refers to code : code [0..1] The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source) (this element modifies the meaning of other elements) equivalence : code [1..1] « The degree of equivalence between concepts. (Strength=Required) ConceptMapEquivalence ! » A description of status/issues in mapping that conveys additional information not represented in the structured data comments : string [0..1] OtherElement A 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. HL7 v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition element : uri [1..1] An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems) codeSystem : uri [1..1] Identity (code or path) or the element/item/ValueSet that the map depends on / refers to code : string [1..1] Contacts to assist a user in finding and communicating with the publisher contact [0..*] A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value dependsOn [0..*] A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element 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 on 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 [0..*]

XML Template 


<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Globally unique logical id for concept map -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Logical id for this version of the concept map -->
 <name value="[string]"/><!-- 0..1 Informal name for this concept map -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of a individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <date value="[dateTime]"/><!-- 0..1 Date for given status -->
 <description value="[string]"/><!-- 0..1 Human language description of the concept map -->
 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>
 <requirements value="[string]"/><!-- 0..1 Why needed -->
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <source[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Provides context to the mappings --></target[x]>
 <element>  <!-- 0..* Mappings for a concept from the source set -->
  <codeSystem value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) -->
  <code value="[code]"/><!-- 0..1 Identifies element being mapped -->
  <target>  <!-- 0..* Concept in target system for element -->
   <codeSystem value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
   <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
   <equivalence value="[code]"/><!-- 1..1 equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
   <comments value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
   <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
    <element value="[uri]"/><!-- 1..1 Reference to element/field/ValueSet mapping depends on -->
    <codeSystem value="[uri]"/><!-- 1..1 Code System (if necessary) -->
    <code value="[string]"/><!-- 1..1 Value of the referenced element -->
   </dependsOn>
   <product><!-- 0..* Content as for ConceptMap.element.target.dependsOn Other concepts that this mapping also produces --></product>
  </target>
 </element>
</ConceptMap>

JSON Template 


{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Globally unique logical id for concept map
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Logical id for this version of the concept map
  "name" : "<string>", // Informal name for this concept map
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "date" : "<dateTime>", // Date for given status
  "description" : "<string>", // Human language description of the concept map
  "useContext" : [{ CodeableConcept }], // Content intends to support these contexts
  "requirements" : "<string>", // Why needed
  "copyright" : "<string>", // Use and/or publishing restrictions
  // source[x]: Identifies the source of the concepts which are being mapped. One of these 2:

  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet|StructureDefinition) },
  // target[x]: Provides context to the mappings. One of these 2:

  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet|StructureDefinition) },
  "element" : [{ // Mappings for a concept from the source set
    "codeSystem" : "<uri>", // Code System (if value set crosses code systems)
    "code" : "<code>", // Identifies element being mapped
    "target" : [{ // Concept in target system for element
      "codeSystem" : "<uri>", // System of the target (if necessary)
      "code" : "<code>", // Code that identifies the target element
      "equivalence" : "<code>", // R!  equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
      "comments" : "<string>", // C? Description of status/issues in mapping
      "dependsOn" : [{ // Other elements required for this mapping (from context)
        "element" : "<uri>", // R!  Reference to element/field/ValueSet mapping depends on
        "codeSystem" : "<uri>", // R!  Code System (if necessary)
        "code" : "<string>" // R!  Value of the referenced element
      }],
      "product" : [{ Content as for ConceptMap.element.target.dependsOn }] // Other concepts that this mapping also produces
    }]
  }]
}

Structure

Name Flags Card. Type Description & Constraints doco
.. ConceptMap DomainResource A map from one set of concepts to one or more other concepts
... url Σ 0..1 uri Globally unique logical id for concept map
... identifier Σ 0..1 Identifier Additional identifier for the concept map
... version Σ 0..1 string Logical id for this version of the concept map
... name Σ 0..1 string Informal name for this concept map
... status ?! Σ 1..1 code draft | active | retired
ConformanceResourceStatus ( Required )
... experimental Σ 0..1 boolean If for testing purposes, not real usage
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* BackboneElement Contact details of the publisher
.... name Σ 0..1 string Name of a individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or publisher
... date Σ 0..1 dateTime Date for given status
... description Σ 0..1 string Human language description of the concept map
... useContext Σ 0..* CodeableConcept Content intends to support these contexts
Context of Use ValueSet ( Extensible )
... requirements 0..1 string Why needed
... copyright 0..1 string Use and/or publishing restrictions
... source[x] Σ 1..1 Identifies the source of the concepts which are being mapped
.... sourceUri uri
.... sourceReference Reference ( ValueSet | StructureDefinition )
... target[x] Σ 1..1 Provides context to the mappings
.... targetUri uri
.... targetReference Reference ( ValueSet | StructureDefinition )
... element 0..* BackboneElement Mappings for a concept from the source set
.... codeSystem 0..1 uri Code System (if value set crosses code systems)
.... code 0..1 code Identifies element being mapped
.... target I 0..* BackboneElement Concept in target system for element
If the map is narrower or inexact, there SHALL be some comments
..... codeSystem 0..1 uri System of the target (if necessary)
..... code 0..1 code Code that identifies the target element
..... equivalence ?! 1..1 code equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence ( Required )
..... comments I 0..1 string Description of status/issues in mapping
..... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
...... element 1..1 uri Reference to element/field/ValueSet mapping depends on
...... codeSystem 1..1 uri Code System (if necessary)
...... code 1..1 string Value of the referenced element
..... product 0..* see dependsOn Other concepts that this mapping also produces

doco Documentation for this format

UML Diagram

ConceptMap ( DomainResource ) An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published url : uri [0..1] 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] 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 profile author manually and the value should be a timestamp version : string [0..1] A free text natural language name describing the concept map name : string [0..1] The status of the concept map (this element modifies the meaning of other elements) status : code 1..1 << [1..1] « The lifecycle status of a Value Set or Concept Map Map. (Strength=Required) ValueSetStatus >> ConformanceResourceStatus ! » This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage experimental : boolean 0..1 [0..1] The name of the individual or organization that published the concept map publisher : string [0..1] The date that this version of the concept map status was last changed published. The date must change when the business version changes, if it does, 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 [0..1] A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc description : string [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of concept map instances useContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible) Context of Use ValueSet + » Explains why this concept map is needed and why it has been constrained as it has requirements : string [0..1] A copyright statement relating to the concept map and/or its contents copyright : string [0..1] The source value set that specifies the concepts that are being mapped source source[x] : Resource Type [1..1] « uri | Reference ( ValueSet | StructureDefinition ) 1..1 » The 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 made target target[x] : Resource Type [1..1] « uri | Reference ( ValueSet | StructureDefinition ) 1..1 » Concept Contact The name of an individual to contact regarding the concept map name : string [0..1] Contact details for individual (if a name was provided) or the publisher telecom : ContactPoint [0..*] SourceElement An absolute URI that identifies the Code System (if the source is a value set that defines crosses more than one code system) codeSystem : uri [0..1] Identity (code or path) or the concept element/item being mapped code : code [0..1] TargetElement An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems) codeSystem : uri 1..1 [0..1] Identifies concept being mapped Identity (code or path) or the element/item that the map refers to code : code 0..1 [0..1] OtherConcept The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source) (this element modifies the meaning of other elements) equivalence : code [1..1] « The degree of equivalence between concepts. (Strength=Required) ConceptMapEquivalence ! » A description of status/issues in mapping that conveys additional information not represented in the structured data comments : string [0..1] OtherElement A 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. HL7 v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition concept element : uri 1..1 [1..1] System for a concept in An absolute URI that identifies the referenced concept code system of the dependency code (if the source/dependency is a value set that crosses code systems) codeSystem : uri 1..1 [1..1] Code for a concept in Identity (code or path) or the referenced concept element/item/ValueSet that the map depends on / refers to code : code string 1..1 [1..1] Map System of the target system : uri 0..1 Code that identifies the target concept code : code 0..1 equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies Contacts to assist a user in finding and communicating with the meaning of other elements) publisher equivalence : code contact 1..1 << The degree of equivalence between concepts ConceptMapEquivalence >> Description of status/issues in mapping comments : string 0..1 [0..*] A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept element can be resolved, and it has the specified value dependsOn 0..* [0..*] A set of additional outcomes from this mapping to other value sets. elements. To properly execute this mapping, the specified value set element 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 on product 0..* [0..*] A concept from the target value set that this concept maps to map target 0..* [0..*] Mappings for a an individual concept from in the source valueset to one or more concepts in the target concept element 0..* [0..*]
< <!-- from --> < < < < <</telecom> < < < < < <</source> <</target> < < < < < < < </dependsOn> < < < < < <</product> </map> </concept>

XML Template 


<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Globally unique logical id for concept map -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Logical id for this version of the concept map -->
 <name value="[string]"/><!-- 0..1 Informal name for this concept map -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of a individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <date value="[dateTime]"/><!-- 0..1 Date for given status -->
 <description value="[string]"/><!-- 0..1 Human language description of the concept map -->
 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>
 <requirements value="[string]"/><!-- 0..1 Why needed -->
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <source[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Provides context to the mappings --></target[x]>
 <element>  <!-- 0..* Mappings for a concept from the source set -->
  <codeSystem value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) -->
  <code value="[code]"/><!-- 0..1 Identifies element being mapped -->
  <target>  <!-- 0..* Concept in target system for element -->
   <codeSystem value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
   <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
   <equivalence value="[code]"/><!-- 1..1 equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
   <comments value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
   <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
    <element value="[uri]"/><!-- 1..1 Reference to element/field/ValueSet mapping depends on -->
    <codeSystem value="[uri]"/><!-- 1..1 Code System (if necessary) -->
    <code value="[string]"/><!-- 1..1 Value of the referenced element -->
   </dependsOn>
   <product><!-- 0..* Content as for ConceptMap.element.target.dependsOn Other concepts that this mapping also produces --></product>
  </target>
 </element>

</ConceptMap>

JSON Template 


{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Globally unique logical id for concept map
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Logical id for this version of the concept map
  "name" : "<string>", // Informal name for this concept map
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "date" : "<dateTime>", // Date for given status
  "description" : "<string>", // Human language description of the concept map
  "useContext" : [{ CodeableConcept }], // Content intends to support these contexts
  "requirements" : "<string>", // Why needed
  "copyright" : "<string>", // Use and/or publishing restrictions
  // source[x]: Identifies the source of the concepts which are being mapped. One of these 2:

  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet|StructureDefinition) },
  // target[x]: Provides context to the mappings. One of these 2:

  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet|StructureDefinition) },
  "element" : [{ // Mappings for a concept from the source set
    "codeSystem" : "<uri>", // Code System (if value set crosses code systems)
    "code" : "<code>", // Identifies element being mapped
    "target" : [{ // Concept in target system for element
      "codeSystem" : "<uri>", // System of the target (if necessary)
      "code" : "<code>", // Code that identifies the target element
      "equivalence" : "<code>", // R!  equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
      "comments" : "<string>", // C? Description of status/issues in mapping
      "dependsOn" : [{ // Other elements required for this mapping (from context)
        "element" : "<uri>", // R!  Reference to element/field/ValueSet mapping depends on
        "codeSystem" : "<uri>", // R!  Code System (if necessary)
        "code" : "<string>" // R!  Value of the referenced element
      }],
      "product" : [{ Content as for ConceptMap.element.target.dependsOn }] // Other concepts that this mapping also produces
    }]
  }]
}

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

6.15.3.1 6.23.3.1 Terminology Bindings

Path Definition Type Reference
ConceptMap.status The lifecycle status of a Value Set or Concept Map Map. Fixed Required http://hl7.org/fhir/valueset-status ConformanceResourceStatus
ConceptMap.useContext Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. Extensible Context of Use ValueSet
ConceptMap.concept.map.equivalence ConceptMap.element.target.equivalence The degree of equivalence between concepts concepts. Fixed Required http://hl7.org/fhir/concept-equivalence ConceptMapEquivalence

6.15.3.2 6.23.3.2 Constraints

  • Inv-1 cmd-1 : On ConceptMap.concept.map: ConceptMap.element.target: If the map is narrower, narrower or inexact, there SHALL be some comments (xpath on f:ConceptMap/f:concept/f:map: f:ConceptMap/f:element/f:target: exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')) )
    • Inv-2 : On ConceptMap.concept.map: If a code is provided, a system SHALL be provided (xpath on f:ConceptMap/f:concept/f:map: exists(f:system) or not(exists(f:code)) )

6.15.4 6.23.4 Notes

  • The value of the system and code element are the same as used by the Coding data type
  • When a mapping equivalence is characterized as "narrower", 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 review.
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 6.23.5 Search Parameters

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

Name Type Description Paths
_id context token The logical resource id associated with A use context assigned to the resource (must be supported by all servers) _language token concept map The language of the resource ConceptMap.useContext
date date The concept map publication date ConceptMap.date
dependson token uri Reference to element/field/valueset provides the context element/field/ValueSet mapping depends on ConceptMap.concept.dependsOn.concept ConceptMap.element.target.dependsOn.element
description string Text search in the description of the concept map ConceptMap.description
identifier token The Additional identifier of for the concept map ConceptMap.identifier
name string Name of the concept map ConceptMap.name
product token uri Reference to element/field/valueset provides the context element/field/ValueSet mapping depends on ConceptMap.concept.map.product.concept ConceptMap.element.target.product.element
publisher string Name of the publisher of the concept map ConceptMap.publisher
source reference The system for any Identifies the source of the concepts which are being mapped by this concept map ConceptMap.source ConceptMap.sourceReference
( ValueSet , StructureDefinition )
status sourcecode token Status Identifies element being mapped ConceptMap.element.code
sourcesystem uri Code System (if value set crosses code systems) ConceptMap.element.codeSystem
sourceuri reference Identifies the source of the concept map concepts which are being mapped ConceptMap.status ConceptMap.sourceUri
( ValueSet , StructureDefinition )
system status token The system for any destination concepts mapped by this Status of the concept map ConceptMap.concept.map.system ConceptMap.status
target reference Provides context to the mappings ConceptMap.target ConceptMap.target[x]
( ValueSet , StructureDefinition )
targetcode token Code that identifies the target element ConceptMap.element.target.code
targetsystem uri System of the target (if necessary) ConceptMap.element.target.codeSystem
url uri The URL of the concept map ConceptMap.url
version token The version identifier of the concept map ConceptMap.version
var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-676355-1']); _gaq.push(['_setDomainName', '.hl7.org']); _gaq.push(['_trackPageview']); (function()