http://hl7.org/fhir/StructureDefinition/ConceptMap|4.0.1

description: A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
derivation: specialization
name: ConceptMap
type: ConceptMap
elements:
  description: {short: Natural language description of the concept map, index: 10}
  date: {short: Date last changed, isSummary: true, index: 7}
  group:
    short: Same source and target systems
    array: true
    index: 19
    elements:
      source: {short: Source system where concepts to be mapped are defined, index: 20}
      sourceVersion: {short: Specific version of the  code system, index: 21}
      target: {short: Target system that the concepts are to be mapped to, index: 22}
      targetVersion: {short: Specific version of the  code system, index: 23}
      element:
        min: 1
        short: Mappings for a concept from the source set
        array: true
        index: 24
        elements:
          code: {short: Identifies element being mapped, index: 25}
          display: {short: Display for the code, index: 26}
          target:
            constraint:
              cmd-1: {human: 'If the map is narrower or inexact, there SHALL be some comments', severity: error, expression: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))}
            short: Concept in target system for element
            array: true
            index: 27
            elements:
              code: {short: Code that identifies the target element, index: 28}
              display: {short: Display for the code, index: 29}
              equivalence:
                isModifier: true
                short: relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1'}
                isModifierReason: Some of the values mean that there is no mapping from the source to the target, particularly 'disjoint', and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between
                index: 30
              comment: {short: Description of status/issues in mapping, index: 31}
              dependsOn:
                short: Other elements required for this mapping (from context)
                array: true
                index: 32
                elements:
                  property: {short: Reference to property mapping depends on, index: 33}
                  system: {short: Code System (if necessary), meaningWhenMissing: The code is in the source (dependsOn) or target (product) system, index: 34}
                  value: {short: Value of the referenced element, index: 35}
                  display: {short: Display for the code (if value is a code), index: 36}
                required: [value, property]
              product:
                elementReference: ['http://hl7.org/fhir/StructureDefinition/ConceptMap', elements, group, elements, element, elements, target, elements, dependsOn]
                short: Other concepts that this mapping also produces
                array: true
                index: 37
            required: [equivalence]
      unmapped:
        constraint:
          cmd-3: {human: 'If the mode is ''other-map'', a url must be provided', severity: error, expression: (mode = 'other-map') implies url.exists()}
          cmd-2: {human: 'If the mode is ''fixed'', a code must be provided', severity: error, expression: (mode = 'fixed') implies code.exists()}
        short: What to do when there is no mapping for the source concept
        index: 38
        elements:
          mode:
            short: provided | fixed | other-map
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1'}
            index: 39
          code: {short: Fixed code when mode = fixed, index: 40}
          display: {short: Display for the code, index: 41}
          url: {short: canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped, index: 42}
        required: [mode]
    required: [element]
  publisher: {short: Name of the publisher (organization or individual), isSummary: true, index: 8}
  jurisdiction:
    short: Intended jurisdiction for concept map (if applicable)
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 12
  purpose: {short: Why this concept map is defined, index: 13}
  name: {short: Name for this concept map (computer friendly), isSummary: true, index: 3}
  useContext: {short: The context that the content is intended to support, array: true, isSummary: true, index: 11}
  copyright: {short: Use and/or publishing restrictions, index: 14}
  experimental: {short: 'For testing purposes, not real usage', isSummary: true, index: 6}
  source:
    short: The source value set that contains the concepts that are being mapped
    choices: []
    isSummary: true
    index: 16
  title: {short: Name for this concept map (human friendly), isSummary: true, index: 4}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.0.1'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 5
  url: {short: 'Canonical identifier for this concept map, represented as a URI (globally unique)', isSummary: true, index: 0}
  identifier: {short: Additional identifier for the concept map, isSummary: true, index: 1}
  target:
    short: The target value set which provides context for the mappings
    choices: []
    isSummary: true
    index: 18
  version: {short: Business version of the concept map, isSummary: true, index: 2}
  contact: {short: Contact details for the publisher, array: true, isSummary: true, index: 9}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ConceptMap
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [status]