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

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: {isModifier: false, short: Natural language description of the concept map, mustSupport: false, isSummary: false, index: 12}
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 9}
  group:
    isModifier: false
    short: Same source and target systems
    mustSupport: false
    array: true
    isSummary: false
    index: 42
    elements:
      source: {isModifier: false, short: Source system where concepts to be mapped are defined, mustSupport: false, isSummary: false, index: 43}
      target: {isModifier: false, short: Target system that the concepts are to be mapped to, mustSupport: false, isSummary: false, index: 44}
      element:
        constraint:
          cmd-5: {human: Either code or valueSet SHALL be present but not both., source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())}
          cmd-4: {human: 'If noMap is present, target SHALL NOT be present', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (noMap.exists() and noMap=true) implies target.empty()}
        min: 1
        isModifier: false
        short: Mappings for a concept from the source set
        index: 45
        mustSupport: false
        array: true
        elements:
          code: {isModifier: false, short: Identifies element being mapped, mustSupport: false, isSummary: false, index: 46}
          display: {isModifier: false, short: Display for the code, mustSupport: false, isSummary: false, index: 47}
          valueSet: {isModifier: false, short: Identifies the set of concepts being mapped, mustSupport: false, isSummary: false, index: 48}
          noMap: {isModifier: false, short: No mapping to a target concept for this source concept, mustSupport: false, isSummary: false, index: 49}
          target:
            constraint:
              cmd-7: {human: Either code or valueSet SHALL be present but not both., source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())}
              cmd-1: {human: 'If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is ''draft''', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to'))}
            isModifier: false
            short: Concept in target system for element
            index: 50
            mustSupport: false
            array: true
            elements:
              code: {isModifier: false, short: Code that identifies the target element, mustSupport: false, isSummary: false, index: 51}
              display: {isModifier: false, short: Display for the code, mustSupport: false, isSummary: false, index: 52}
              valueSet: {isModifier: false, short: Identifies the set of target concepts, mustSupport: false, isSummary: false, index: 53}
              relationship:
                isModifier: true
                short: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
                mustSupport: false
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0'}
                isModifierReason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between
                isSummary: false
                index: 54
              comment: {isModifier: false, short: Description of status/issues in mapping, mustSupport: false, isSummary: false, index: 55}
              property:
                isModifier: false
                short: Property value for the source -> target mapping
                mustSupport: false
                array: true
                isSummary: false
                index: 56
                elements:
                  code: {isModifier: false, short: Reference to ConceptMap.property.code, mustSupport: false, isSummary: false, index: 57}
                  value:
                    isModifier: false
                    short: Value of the property for this concept
                    mustSupport: false
                    choices: []
                    isSummary: false
                    index: 59
                required: [value, code]
              dependsOn:
                constraint:
                  cmd-6: {human: 'One of value[x] or valueSet must exist, but not both.', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())}
                isModifier: false
                short: Other properties required for this mapping
                index: 60
                mustSupport: false
                array: true
                elements:
                  attribute: {isModifier: false, short: A reference to a mapping attribute defined in ConceptMap.additionalAttribute, mustSupport: false, isSummary: false, index: 61}
                  value:
                    isModifier: false
                    short: Value of the referenced data element
                    mustSupport: false
                    choices: []
                    isSummary: false
                    index: 63
                  valueSet: {isModifier: false, short: The mapping depends on a data element with a value from this value set, mustSupport: false, isSummary: false, index: 64}
                required: [attribute]
                isSummary: false
              product:
                elementReference: ['http://hl7.org/fhir/StructureDefinition/ConceptMap', elements, group, elements, element, elements, target, elements, dependsOn]
                isModifier: false
                short: Other data elements that this mapping also produces
                mustSupport: false
                array: true
                isSummary: false
                index: 65
            required: [relationship]
            isSummary: false
        isSummary: false
      unmapped:
        constraint:
          cmd-9: {human: 'If the mode is not ''other-map'', relationship must be provided', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (mode != 'other-map') implies relationship.exists()}
          cmd-8: {human: 'If the mode is not ''fixed'', code, display and valueSet are not allowed', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())}
          cmd-3: {human: 'If the mode is ''other-map'', a url for the other map must be provided', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (mode = 'other-map') implies otherMap.exists()}
          cmd-2: {human: 'If the mode is ''fixed'', either a code or valueSet must be provided, but not both.', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))}
          cmd-10: {human: 'If the mode is not ''other-map'', otherMap is not allowed', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: (mode != 'other-map') implies otherMap.empty()}
        isModifier: false
        short: What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
        mustSupport: false
        isSummary: false
        index: 66
        elements:
          mode:
            isModifier: false
            short: use-source-code | fixed | other-map
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|5.0.0'}
            isSummary: false
            index: 67
          code: {isModifier: false, short: Fixed code when mode = fixed, mustSupport: false, isSummary: false, index: 68}
          display: {isModifier: false, short: Display for the code, mustSupport: false, isSummary: false, index: 69}
          valueSet: {isModifier: false, short: Fixed code set when mode = fixed, mustSupport: false, isSummary: false, index: 70}
          relationship:
            isModifier: true
            short: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0'}
            isModifierReason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between
            isSummary: false
            index: 71
          otherMap: {isModifier: false, short: canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped, mustSupport: false, isSummary: false, index: 72}
        required: [mode]
    required: [element]
  endorser: {isModifier: false, short: Who endorsed the ConceptMap, mustSupport: false, array: true, isSummary: false, index: 25}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 10}
  approvalDate: {isModifier: false, short: When the ConceptMap was approved by publisher, mustSupport: false, isSummary: false, index: 18}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for concept map (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 14
  purpose: {isModifier: false, short: Why this concept map is defined, mustSupport: false, isSummary: false, index: 15}
  property:
    constraint:
      cmd-11: {human: 'If the property type is code, a system SHALL be specified', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: error, expression: type = 'code' implies system.exists()}
    isModifier: false
    short: Additional properties of the mapping
    index: 27
    mustSupport: false
    array: true
    elements:
      code: {isModifier: false, short: 'Identifies the property on the mappings, and when referred to in the $translate operation', mustSupport: false, isSummary: true, index: 28}
      uri: {isModifier: false, short: Formal identifier for the property, mustSupport: false, isSummary: true, index: 29}
      description: {isModifier: false, short: 'Why the property is defined, and/or what it conveys', mustSupport: false, isSummary: true, index: 30}
      type:
        isModifier: false
        short: Coding | string | integer | boolean | dateTime | decimal | code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conceptmap-property-type|5.0.0'}
        isSummary: true
        index: 31
      system: {isModifier: false, short: The CodeSystem from which code values come, mustSupport: false, isSummary: true, index: 32}
    required: [type, code]
    isSummary: true
  name: {isModifier: false, short: Name for this concept map (computer friendly), mustSupport: false, isSummary: true, index: 5}
  sourceScope:
    isModifier: false
    short: The source value set that contains the concepts that are being mapped
    mustSupport: false
    choices: []
    isSummary: true
    index: 39
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 17}
  useContext: {isModifier: false, short: The context that the content is intended to support, mustSupport: false, array: true, isSummary: true, index: 13}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 16}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 8}
  topic:
    isModifier: false
    short: E.g. Education, Treatment, Assessment, etc
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    isSummary: false
    index: 21
  title: {isModifier: false, short: Name for this concept map (human friendly), mustSupport: false, isSummary: true, index: 6}
  targetScope:
    isModifier: false
    short: The target value set which provides context for the mappings
    mustSupport: false
    choices: []
    isSummary: true
    index: 41
  author: {isModifier: false, short: Who authored the ConceptMap, mustSupport: false, array: true, isSummary: false, index: 22}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 7
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/ConceptMap', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this concept map, represented as a URI (globally unique)
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the concept map, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the ConceptMap was last reviewed by the publisher, mustSupport: false, isSummary: false, index: 19}
  editor: {isModifier: false, short: Who edited the ConceptMap, mustSupport: false, array: true, isSummary: false, index: 23}
  additionalAttribute:
    isModifier: false
    short: Definition of an additional attribute to act as a data source or target
    mustSupport: false
    array: true
    isSummary: true
    index: 33
    elements:
      code: {isModifier: false, short: Identifies this additional attribute through this resource, mustSupport: false, isSummary: true, index: 34}
      uri: {isModifier: false, short: Formal identifier for the data element referred to in this attribte, mustSupport: false, isSummary: true, index: 35}
      description: {isModifier: false, short: 'Why the additional attribute is defined, and/or what the data element it refers to is', mustSupport: false, isSummary: true, index: 36}
      type:
        isModifier: false
        short: code | Coding | string | boolean | Quantity
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conceptmap-attribute-type|5.0.0'}
        isSummary: true
        index: 37
    required: [type, code]
  reviewer: {isModifier: false, short: Who reviewed the ConceptMap, mustSupport: false, array: true, isSummary: false, index: 24}
  version: {isModifier: false, short: Business version of the concept map, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc', mustSupport: false, array: true, isSummary: false, index: 26}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 11}
  effectivePeriod: {isModifier: false, short: When the ConceptMap is expected to be used, mustSupport: false, isSummary: true, index: 20}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ConceptMap
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status]