DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 R3 R2

6.23 4.9 Resource ConceptMap - Content

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

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

A concept map defines a mapping from a concept set of concepts defined in one a code system to one or more concepts defined in other code systems. Mappings are one way - from the 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.

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 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 exectuable transform for instances that conform to a known structure.

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.

Structure

Globally unique logical id for Logical id for this Informal name If for Name of the publisher (organization or individual) contact Σ 0..* Σ Date for given status 0..1 Human language description of Content intends to support these contexts 1..1 1..1 Mappings for a concept from the System of Code that identifies 1..1
Name Flags Card. Type Description & Constraints doco
. . ConceptMap DomainResource A map from one set of concepts to one or more other concepts
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this concept map (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the concept map
. . . version Σ 0..1 string Business version of the concept map
. . . name Σ 0..1 string Name for this concept map (computer friendly)
. . . title Σ 0..1 string Name for this concept map (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
ConformanceResourceStatus PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . publisher . date Σ 0..1 string dateTime Date this was last changed
BackboneElement . . Contact details of the . publisher name Σ 0..1 string Name of a individual to contact the publisher (organization or individual)
. . telecom . contact Σ 0..* ContactPoint ContactDetail Contact details for individual or the publisher
. . date . description 0..1 dateTime markdown Natural language description of the concept map
. . description . useContext Σ 0..* string UsageContext Context the concept map content is intended to support
. . useContext . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Context of Use Jurisdiction ValueSet ( Extensible )
. . requirements . purpose 0..1 string markdown Why needed this concept map is defined
. . . copyright 0..1 string markdown Use and/or publishing restrictions
. . . source[x] Σ 0..1 Identifies the source of the concepts which are being mapped
. . . . sourceUri uri
. . . . sourceReference Reference ( ValueSet | StructureDefinition )
. . . target[x] Σ 0..1 Provides context to the mappings
. . . . targetUri uri
. . . . targetReference Reference ( ValueSet | StructureDefinition )
. . element . group 0..* BackboneElement Same source set and target systems
. . . codeSystem . source 0..1 uri Code System (if value set crosses code systems)
. . . . sourceVersion 0..1 string Specific version of the code system
.... target 0..1 uri System of the target (if necessary)
.... targetVersion 0..1 string Specific version of the code system
.... element 1..* BackboneElement Mappings for a concept from the source set
..... code 0..1 code Identifies element being mapped
. . . . . display 0..1 string Display for the code
..... target I 0..* BackboneElement Concept in target system for element
+ If the map is narrower or inexact, there SHALL be some comments
. . . . codeSystem . . code 0..1 uri code Code that identifies the target (if necessary) element
. . . . code . . display 0..1 code string Display for the target element code
. . . . . . equivalence ?! 0..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence ( Required )
. . . . comments . . comment I 0..1 string Description of status/issues in mapping
. . . . . . dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
. . . . . element . . property 1..1 uri Reference to element/field/ValueSet property mapping depends on
. . . . . codeSystem . . system 1..1 0..1 uri Code System (if necessary)
. . . . . . . code 1..1 string Value of the referenced element
. . . . . . . display 0..1 string Display for the code
...... product 0..* see dependsOn Other concepts that this mapping also produces
. . . . unmapped I 0..1 BackboneElement When no match in the mappings
+ If the mode is 'other-map', a code must be provided
+ If the mode is 'fixed', a code must be provided
..... mode 1..1 code provided | fixed | other-map
ConceptMapGroupUnmappedMode ( Required )
..... code 0..1 code Fixed code when mode = fixed
..... display 0..1 string Display for the code
..... url 0..1 uri Canonical URL for other concept map

doco Documentation for this format

UML Diagram ( Legend )

ConceptMap ( DomainResource ) An absolute URL URI 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 published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions) url : uri [0..1] Formal 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] 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 concept map author manually and the value should 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 free text natural language name describing identifying the concept map map. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the concept map title : string [0..1] The status of the this concept map map. Enables tracking the life-cycle of the content (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 PublicationStatus ! » This ConceptMap was 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 (this element modifies the meaning of other elements) experimental : boolean [0..1] The name of the individual or organization that published the concept map publisher : string [0..1] The date this version of (and optionally time) when the concept map was published. The date must change if and when the business version changes, if it does, 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 individual or organization that published 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 use of the concept map - reason for definition, conditions of use, etc from a consumer's perspective description : string markdown [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 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..*] « Indicates the countries, regions, disciplines Countries and other aspects of use regions within which this artifact is targeted for use. use (Strength=Extensible) Context of Use Jurisdiction ValueSet + » Explains Explaination of why this concept map is needed and why it has been constrained designed as it has requirements purpose : string markdown [0..1] A copyright statement relating to the concept map and/or its contents contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map copyright : string markdown [0..1] The source value set that specifies the concepts that are being mapped source[x] : Type [1..1] « [0..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] « [0..1] uri | Reference ( ValueSet | StructureDefinition ) » Contact Group The name of an individual to contact regarding An absolute URI that identifies the concept map Code System (if the source is a value set that crosses more than one code system) name source : string uri [0..1] Contact details for individual (if a name was provided) or The specific version of the publisher code system, as determined by the code system authority telecom sourceVersion : ContactPoint string [0..*] SourceElement [0..1] An absolute URI that identifies the Code System code system of the target code (if the source target is a value set that crosses more than one cross code system) systems) codeSystem target : uri [0..1] The specific version of the code system, as determined by the code system authority targetVersion : string [0..1] SourceElement 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 display for the target code. The display is a value set that cross code systems) only provided to help editors when editing the concept map codeSystem display : uri string [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 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] « [0..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 comment : string [0..1] OtherElement A reference to a specific concept an element that holds a coded value. This can be an element in a FHIR resource, or a specific reference value that corresponds to a data code system property. The idea is that the information model carries an element in a different specification (e.g. HL7 v2) or a general reference to a kind of data field, or a reference somwhere that is labeled to a value set correspond with an appropriately narrow definition a code system property element property : 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 system : uri [1..1] [0..1] Identity (code or path) or the element/item/ValueSet that the map depends on / refers to code : string [1..1] The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] Unmapped Contacts Defines which action to assist a user take if there is no match in finding the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and communicating with 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] Defines which action to take if there is no match in the publisher group. (Strength=Required) contact 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] [0..*] The canonical URL of the map to use if this map contains no mapping url : uri [0..1] 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 [1..*] What to do when there is no match in the mappings in the group 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>
 <
 <
 <
 <
 <
 <
  <
  <</telecom>
 </contact>
 <
 <
 <</useContext>
 <
 <
 <</source[x]>
 <</target[x]>
 <
  <
  <
  <
   <
   <
   <
   <
   <
    <
    <
    <
   </dependsOn>
   <</product>
  </target>
 </element>

 <url value="[uri]"/><!-- 0..1 Logical URI to reference this concept map (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the concept map -->
 <name value="[string]"/><!-- 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 this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (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 Context 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]><!-- 0..1 uri|Reference(ValueSet) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|Reference(ValueSet) Provides context to the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
  <targetVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <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 -->
   <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 -->
    <equivalence value="[code]"/><!-- 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comment value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
     <property value="[uri]"/><!-- 1..1 Reference to property mapping depends on -->
     <system value="[uri]"/><!-- 0..1 Code System (if necessary) -->
     <code value="[string]"/><!-- 1..1 Value of the referenced element -->
     <display value="[string]"/><!-- 0..1 Display for the code -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 When no match in the mappings -->
   <mode value="[code]"/><!-- 1..1 provided | fixed | other-map -->
   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <url value="[uri]"/><!-- 0..1 Canonical URL for other concept map -->
  </unmapped>
 </group>

</ConceptMap>

JSON Template

{
  "resourceType" : "",

{doco
  "resourceType" : "ConceptMap",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
  }],
  "
  "
  "
  "
  "

  "url" : "<uri>", // Logical URI to reference this concept map (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Business version of the concept map
  "name" : "<string>", // 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 this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // Context 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

  // source[x]: Identifies the source of the concepts which are being mapped. One of these 2:
  ">",
  " },

  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet) },

  // target[x]: Provides context to the mappings. One of these 2:
  ">",
  " },
  "
    "
    "
    "
      "
      "
      "
      "
      "
        "
        "
        "
      }],
      "
    }]

  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // Code System (if value set crosses code systems)
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // System of the target (if necessary)
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "equivalence" : "<code>", // relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comment" : "<string>", // C? Description of status/issues in mapping
        "dependsOn" : [{ // Other elements required for this mapping (from context)
          "property" : "<uri>", // R!  Reference to property mapping depends on
          "system" : "<uri>", // Code System (if necessary)
          "code" : "<string>", // R!  Value of the referenced element
          "display" : "<string>" // Display for the code
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }],
    "unmapped" : { // When no match in the mappings
      "mode" : "<code>", // R!  provided | fixed | other-map
      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "url" : "<uri>" // Canonical URL for other concept map
    }

  }]
}

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:ConceptMap.url [ uri ]; # 0..1 Logical URI to reference this concept map (globally unique)
  fhir:ConceptMap.identifier [ Identifier ]; # 0..1 Additional identifier for the concept map
  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:ConceptMap.name [ string ]; # 0..1 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:ConceptMap.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher (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..* Context 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
  # ConceptMap.source[x] : 0..1 Identifies the source of the concepts which are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceReference [ Reference(ValueSet) ]
  # ConceptMap.target[x] : 0..1 Provides context to the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetReference [ Reference(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 0..1 Code System (if value set crosses code systems)
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 System of the target (if necessary)
    fhir:ConceptMap.group.targetVersion [ string ]; # 0..1 Specific version of the  code system
    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.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:ConceptMap.group.element.target.equivalence [ code ]; # 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other elements required for this mapping (from context)
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 Reference to property mapping depends on
          fhir:ConceptMap.group.element.target.dependsOn.system [ uri ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.code [ string ]; # 1..1 Value of the referenced element
          fhir:ConceptMap.group.element.target.dependsOn.display [ string ]; # 0..1 Display for the code
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
    fhir:ConceptMap.group.unmapped [ # 0..1 When no match in the mappings
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 provided | 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:ConceptMap.group.unmapped.url [ uri ]; # 0..1 Canonical URL for other concept map
    ];
  ], ...;
]

Changes since DSTU2

ConceptMap
ConceptMap.title
  • Added Element
ConceptMap.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ConceptMap.experimental
  • Now marked as Modifier
ConceptMap.contact
  • Type changed from BackboneElement to ContactDetail
ConceptMap.description
  • Type changed from string to markdown
ConceptMap.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ConceptMap.jurisdiction
  • Renamed from useContext to jurisdiction
  • Change value set from http://hl7.org/fhir/ValueSet/use-context to http://hl7.org/fhir/ValueSet/jurisdiction
ConceptMap.purpose
  • Renamed from requirements to purpose
  • Type changed from string to markdown
ConceptMap.copyright
  • Type changed from string to markdown
ConceptMap.source[x]
  • Min Cardinality changed from 1 to 0
  • Remove Reference(StructureDefinition)
ConceptMap.target[x]
  • Min Cardinality changed from 1 to 0
  • Remove Reference(StructureDefinition)
ConceptMap.group
  • Added Element
ConceptMap.group.source
  • Added Element
ConceptMap.group.sourceVersion
  • Added Element
ConceptMap.group.target
  • Added Element
ConceptMap.group.targetVersion
  • Added Element
ConceptMap.group.element
  • Min Cardinality changed from 0 to 1
ConceptMap.group.element.display
  • Added Element
ConceptMap.group.element.target.display
  • Added Element
ConceptMap.group.element.target.equivalence
  • Min Cardinality changed from 1 to 0
  • Default Value "equivalent" added
ConceptMap.group.element.target.comment
  • Added Element
ConceptMap.group.element.target.dependsOn.property
  • Added Element
ConceptMap.group.element.target.dependsOn.system
  • Added Element
ConceptMap.group.element.target.dependsOn.display
  • Added Element
ConceptMap.group.unmapped
  • Added Element
ConceptMap.group.unmapped.mode
  • Added Element
ConceptMap.group.unmapped.code
  • Added Element
ConceptMap.group.unmapped.display
  • Added Element
ConceptMap.group.unmapped.url
  • Added Element
ConceptMap.contact.name
  • deleted
ConceptMap.contact.telecom
  • deleted
ConceptMap.element.codeSystem
  • deleted
ConceptMap.element.target.codeSystem
  • deleted
ConceptMap.element.target.comments
  • deleted
ConceptMap.element.target.dependsOn.element
  • deleted
ConceptMap.element.target.dependsOn.codeSystem
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

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

Structure

Globally unique logical id for Logical id for this Informal name If for Name of the publisher (organization or individual) contact Σ 0..* Σ Date for given status 0..1 Human language description of Content intends to support these contexts 1..1 1..1 Mappings for a concept from the System of Code that identifies 1..1
Name Flags Card. Type Description & Constraints doco
. . ConceptMap DomainResource A map from one set of concepts to one or more other concepts
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this concept map (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the concept map
. . . version Σ 0..1 string Business version of the concept map
. . . name Σ 0..1 string Name for this concept map (computer friendly)
. . . title Σ 0..1 string Name for this concept map (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
ConformanceResourceStatus PublicationStatus ( Required )
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . publisher . date Σ 0..1 string dateTime Date this was last changed
BackboneElement . . Contact details of the . publisher name Σ 0..1 string Name of a individual to contact the publisher (organization or individual)
. . telecom . contact Σ 0..* ContactPoint ContactDetail Contact details for individual or the publisher
. . date . description 0..1 dateTime markdown Natural language description of the concept map
. . description . useContext Σ 0..* string UsageContext Context the concept map content is intended to support
. . useContext . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Context of Use Jurisdiction ValueSet ( Extensible )
. . requirements . purpose 0..1 string markdown Why needed this concept map is defined
. . . copyright 0..1 string markdown Use and/or publishing restrictions
. . . source[x] Σ 0..1 Identifies the source of the concepts which are being mapped
. . . . sourceUri uri
. . . . sourceReference Reference ( ValueSet | StructureDefinition )
. . . target[x] Σ 0..1 Provides context to the mappings
. . . . targetUri uri
. . . . targetReference Reference ( ValueSet | StructureDefinition )
. . element . group 0..* BackboneElement Same source set and target systems
. . . codeSystem . source 0..1 uri Code System (if value set crosses code systems)
. . . . sourceVersion 0..1 string Specific version of the code system
.... target 0..1 uri System of the target (if necessary)
.... targetVersion 0..1 string Specific version of the code system
.... element 1..* BackboneElement Mappings for a concept from the source set
..... code 0..1 code Identifies element being mapped
. . . . . display 0..1 string Display for the code
..... target I 0..* BackboneElement Concept in target system for element
+ If the map is narrower or inexact, there SHALL be some comments
. . . . codeSystem . . code 0..1 uri code Code that identifies the target (if necessary) element
. . . . code . . display 0..1 code string Display for the target element code
. . . . . . equivalence ?! 0..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence ( Required )
. . . . comments . . comment I 0..1 string Description of status/issues in mapping
. . . . . . dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
. . . . . element . . property 1..1 uri Reference to element/field/ValueSet property mapping depends on
. . . . . codeSystem . . system 1..1 0..1 uri Code System (if necessary)
. . . . . . . code 1..1 string Value of the referenced element
. . . . . . . display 0..1 string Display for the code
...... product 0..* see dependsOn Other concepts that this mapping also produces
. . . . unmapped I 0..1 BackboneElement When no match in the mappings
+ If the mode is 'other-map', a code must be provided
+ If the mode is 'fixed', a code must be provided
..... mode 1..1 code provided | fixed | other-map
ConceptMapGroupUnmappedMode ( Required )
..... code 0..1 code Fixed code when mode = fixed
..... display 0..1 string Display for the code
..... url 0..1 uri Canonical URL for other concept map

doco Documentation for this format

UML Diagram ( Legend )

ConceptMap ( DomainResource ) An absolute URL URI 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 published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions) url : uri [0..1] Formal 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] 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 concept map author manually and the value should 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 free text natural language name describing identifying the concept map map. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the concept map title : string [0..1] The status of the this concept map map. Enables tracking the life-cycle of the content (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 PublicationStatus ! » This ConceptMap was 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 (this element modifies the meaning of other elements) experimental : boolean [0..1] The name of the individual or organization that published the concept map publisher : string [0..1] The date this version of (and optionally time) when the concept map was published. The date must change if and when the business version changes, if it does, 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 individual or organization that published 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 use of the concept map - reason for definition, conditions of use, etc from a consumer's perspective description : string markdown [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 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..*] « Indicates the countries, regions, disciplines Countries and other aspects of use regions within which this artifact is targeted for use. use (Strength=Extensible) Context of Use Jurisdiction ValueSet + » Explains Explaination of why this concept map is needed and why it has been constrained designed as it has requirements purpose : string markdown [0..1] A copyright statement relating to the concept map and/or its contents contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map copyright : string markdown [0..1] The source value set that specifies the concepts that are being mapped source[x] : Type [1..1] « [0..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] « [0..1] uri | Reference ( ValueSet | StructureDefinition ) » Contact Group The name of an individual to contact regarding An absolute URI that identifies the concept map Code System (if the source is a value set that crosses more than one code system) name source : string uri [0..1] Contact details for individual (if a name was provided) or The specific version of the publisher code system, as determined by the code system authority telecom sourceVersion : ContactPoint string [0..*] SourceElement [0..1] An absolute URI that identifies the Code System code system of the target code (if the source target is a value set that crosses more than one cross code system) systems) codeSystem target : uri [0..1] The specific version of the code system, as determined by the code system authority targetVersion : string [0..1] SourceElement 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 display for the target code. The display is a value set that cross code systems) only provided to help editors when editing the concept map codeSystem display : uri string [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 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] « [0..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 comment : string [0..1] OtherElement A reference to a specific concept an element that holds a coded value. This can be an element in a FHIR resource, or a specific reference value that corresponds to a data code system property. The idea is that the information model carries an element in a different specification (e.g. HL7 v2) or a general reference to a kind of data field, or a reference somwhere that is labeled to a value set correspond with an appropriately narrow definition a code system property element property : 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 system : uri [1..1] [0..1] Identity (code or path) or the element/item/ValueSet that the map depends on / refers to code : string [1..1] The display for the code. The display is only provided to help editors when editing the concept map display : string [0..1] Unmapped Contacts Defines which action to assist a user take if there is no match in finding the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and communicating with 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] Defines which action to take if there is no match in the publisher group. (Strength=Required) contact 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] [0..*] The canonical URL of the map to use if this map contains no mapping url : uri [0..1] 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 [1..*] What to do when there is no match in the mappings in the group 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>
 <
 <
 <
 <
 <
 <
  <
  <</telecom>
 </contact>
 <
 <
 <</useContext>
 <
 <
 <</source[x]>
 <</target[x]>
 <
  <
  <
  <
   <
   <
   <
   <
   <
    <
    <
    <
   </dependsOn>
   <</product>
  </target>
 </element>

 <url value="[uri]"/><!-- 0..1 Logical URI to reference this concept map (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the concept map -->
 <name value="[string]"/><!-- 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 this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (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 Context 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]><!-- 0..1 uri|Reference(ValueSet) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|Reference(ValueSet) Provides context to the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
  <targetVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <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 -->
   <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 -->
    <equivalence value="[code]"/><!-- 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comment value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
     <property value="[uri]"/><!-- 1..1 Reference to property mapping depends on -->
     <system value="[uri]"/><!-- 0..1 Code System (if necessary) -->
     <code value="[string]"/><!-- 1..1 Value of the referenced element -->
     <display value="[string]"/><!-- 0..1 Display for the code -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 When no match in the mappings -->
   <mode value="[code]"/><!-- 1..1 provided | fixed | other-map -->
   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <url value="[uri]"/><!-- 0..1 Canonical URL for other concept map -->
  </unmapped>
 </group>

</ConceptMap>

JSON Template

{
  "resourceType" : "",

{doco
  "resourceType" : "ConceptMap",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
  }],
  "
  "
  "
  "
  "

  "url" : "<uri>", // Logical URI to reference this concept map (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Business version of the concept map
  "name" : "<string>", // 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 this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // Context 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

  // source[x]: Identifies the source of the concepts which are being mapped. One of these 2:
  ">",
  " },

  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet) },

  // target[x]: Provides context to the mappings. One of these 2:
  ">",
  " },
  "
    "
    "
    "
      "
      "
      "
      "
      "
        "
        "
        "
      }],
      "
    }]

  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // Code System (if value set crosses code systems)
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // System of the target (if necessary)
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "equivalence" : "<code>", // relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comment" : "<string>", // C? Description of status/issues in mapping
        "dependsOn" : [{ // Other elements required for this mapping (from context)
          "property" : "<uri>", // R!  Reference to property mapping depends on
          "system" : "<uri>", // Code System (if necessary)
          "code" : "<string>", // R!  Value of the referenced element
          "display" : "<string>" // Display for the code
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }],
    "unmapped" : { // When no match in the mappings
      "mode" : "<code>", // R!  provided | fixed | other-map
      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "url" : "<uri>" // Canonical URL for other concept map
    }

  }]
}

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:ConceptMap.url [ uri ]; # 0..1 Logical URI to reference this concept map (globally unique)
  fhir:ConceptMap.identifier [ Identifier ]; # 0..1 Additional identifier for the concept map
  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:ConceptMap.name [ string ]; # 0..1 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:ConceptMap.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher (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..* Context 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
  # ConceptMap.source[x] : 0..1 Identifies the source of the concepts which are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceReference [ Reference(ValueSet) ]
  # ConceptMap.target[x] : 0..1 Provides context to the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetReference [ Reference(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 0..1 Code System (if value set crosses code systems)
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 System of the target (if necessary)
    fhir:ConceptMap.group.targetVersion [ string ]; # 0..1 Specific version of the  code system
    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.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:ConceptMap.group.element.target.equivalence [ code ]; # 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other elements required for this mapping (from context)
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 Reference to property mapping depends on
          fhir:ConceptMap.group.element.target.dependsOn.system [ uri ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.code [ string ]; # 1..1 Value of the referenced element
          fhir:ConceptMap.group.element.target.dependsOn.display [ string ]; # 0..1 Display for the code
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
    fhir:ConceptMap.group.unmapped [ # 0..1 When no match in the mappings
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 provided | 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:ConceptMap.group.unmapped.url [ uri ]; # 0..1 Canonical URL for other concept map
    ];
  ], ...;
]

  Changes since DSTU2

ConceptMap
ConceptMap.title
  • Added Element
ConceptMap.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ConceptMap.experimental
  • Now marked as Modifier
ConceptMap.contact
  • Type changed from BackboneElement to ContactDetail
ConceptMap.description
  • Type changed from string to markdown
ConceptMap.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ConceptMap.jurisdiction
  • Renamed from useContext to jurisdiction
  • Change value set from http://hl7.org/fhir/ValueSet/use-context to http://hl7.org/fhir/ValueSet/jurisdiction
ConceptMap.purpose
  • Renamed from requirements to purpose
  • Type changed from string to markdown
ConceptMap.copyright
  • Type changed from string to markdown
ConceptMap.source[x]
  • Min Cardinality changed from 1 to 0
  • Remove Reference(StructureDefinition)
ConceptMap.target[x]
  • Min Cardinality changed from 1 to 0
  • Remove Reference(StructureDefinition)
ConceptMap.group
  • Added Element
ConceptMap.group.source
  • Added Element
ConceptMap.group.sourceVersion
  • Added Element
ConceptMap.group.target
  • Added Element
ConceptMap.group.targetVersion
  • Added Element
ConceptMap.group.element
  • Min Cardinality changed from 0 to 1
ConceptMap.group.element.display
  • Added Element
ConceptMap.group.element.target.display
  • Added Element
ConceptMap.group.element.target.equivalence
  • Min Cardinality changed from 1 to 0
  • Default Value "equivalent" added
ConceptMap.group.element.target.comment
  • Added Element
ConceptMap.group.element.target.dependsOn.property
  • Added Element
ConceptMap.group.element.target.dependsOn.system
  • Added Element
ConceptMap.group.element.target.dependsOn.display
  • Added Element
ConceptMap.group.unmapped
  • Added Element
ConceptMap.group.unmapped.mode
  • Added Element
ConceptMap.group.unmapped.code
  • Added Element
ConceptMap.group.unmapped.display
  • Added Element
ConceptMap.group.unmapped.url
  • Added Element
ConceptMap.contact.name
  • deleted
ConceptMap.contact.telecom
  • deleted
ConceptMap.element.codeSystem
  • deleted
ConceptMap.element.target.codeSystem
  • deleted
ConceptMap.element.target.comments
  • deleted
ConceptMap.element.target.dependsOn.element
  • deleted
ConceptMap.element.target.dependsOn.codeSystem
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

Alternate definitions: Schema / Schematron , Resource Profile Master Definition ( XML , JSON ), Questionnaire XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle )

ConceptMap.useContext ConceptMap.element.target.equivalence
Path Definition Type Reference
ConceptMap.status The lifecycle status of a Value Set or Concept Map. Required ConformanceResourceStatus PublicationStatus
ConceptMap.jurisdiction Indicates the countries, regions, disciplines Countries and other aspects of use regions within which this artifact is targeted for use. use Extensible Context of Use Jurisdiction ValueSet
ConceptMap.group.element.target.equivalence The degree of equivalence between concepts. Required ConceptMapEquivalence
ConceptMap.group.unmapped.mode Defines which action to take if there is no match in the group. Required ConceptMapGroupUnmappedMode

  • cmd-1 : On ConceptMap.element.target: ConceptMap.group.element.target: If the map is narrower or inexact, there SHALL be some comments (xpath ( expression on f:ConceptMap/f:element/f:target: ConceptMap.group.element.target: exists(f:comments) comment.exists() or ((f:equivalence/@value equivalence.empty() or ((equivalence != 'narrower') and (f:equivalence/@value (equivalence != 'inexact')) )
  • cmd-2 : On ConceptMap.group.unmapped: If the mode is 'fixed', a code must be provided ( expression on ConceptMap.group.unmapped: (mode = 'fixed') implies code.exists() )
  • cmd-3 : On ConceptMap.group.unmapped: If the mode is 'other-map', a code must be provided ( expression on ConceptMap.group.unmapped: (mode = 'other-map') implies url.exists() )
  • The value of the system , version and code element elements 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.
  • There should be only one element for each source concept. If there is more than one, the target statements are cumulative across them

The concept mappings in element are arranged into groups that share common source/target systems. These groups have no semantic signficance; 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.

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 ). Note that this is different from StructureMap because that is intended to define an executional transform between structures, not a conceptual model.

This table summarizes how to treat these items as a terminology:

StructureDefinition The StructureDefinition.url (canonical URL) is the system . Each .snapshot.element.id in the snapshot is a code in the code system
Questionnaire The Questionnaire.url (canonical URL) is the system . Each .item.linkId in the snapshot is a code in the code system. Items with no linkId cannot be addressed
DataElement The DataElement.url (canonical URL) is the system . Each .element.id in the snapshot is a code in the code system. Elements with no id cannot be addressed
Medication Medication resources are a bit different, since they don't have a canonical URL, and there are not multiple items in a resource. So to refer to a medication resource, the system is [base]/Medication, where base is the server address. The Logical Id of the resource is the code

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 Paths Expression context token A use context assigned to the concept map In Common ConceptMap.useContext
date date The concept map publication date ConceptMap.date
dependson uri Reference to element/field/ValueSet property mapping depends on ConceptMap.element.target.dependsOn.element ConceptMap.group.element.target.dependsOn.property
description string Text search in the The description of the concept map ConceptMap.description
identifier token Additional External identifier for the concept map ConceptMap.identifier
jurisdiction token Intended jurisdiction for the concept map ConceptMap.jurisdiction
name string Name Computationally friendly name of the concept map ConceptMap.name
other uri Canonical URL for other concept map ConceptMap.group.unmapped.url
product uri Reference to element/field/ValueSet property mapping depends on ConceptMap.element.target.product.element ConceptMap.group.element.target.product.property
publisher string Name of the publisher of the concept map ConceptMap.publisher
source reference Identifies the source of the concepts which are being mapped ConceptMap.sourceReference ConceptMap.source.as(Reference)
( ValueSet , StructureDefinition )
sourcecode source-code token Identifies element being mapped ConceptMap.element.code ConceptMap.group.element.code
sourcesystem source-system uri Code System (if value set crosses code systems) ConceptMap.element.codeSystem ConceptMap.group.source
sourceuri source-uri reference Identifies the source of the concepts which are being mapped ConceptMap.sourceUri ConceptMap.source.as(Uri)
( ValueSet , StructureDefinition )
status token Status The current status of the concept map ConceptMap.status
target reference Provides context to the mappings ConceptMap.target[x] ConceptMap.target.as(Reference)
( ValueSet , StructureDefinition )
targetcode target-code token Code that identifies the target element ConceptMap.element.target.code ConceptMap.group.element.target.code
targetsystem target-system uri System of the target (if necessary) ConceptMap.element.target.codeSystem ConceptMap.group.target
target-uri reference Provides context to the mappings ConceptMap.target.as(Uri)
( ValueSet )
title string The human-friendly name of the concept map ConceptMap.title
url uri The URL of uri that identifies the concept map ConceptMap.url
version token The business version identifier of the concept map ConceptMap.version