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

description: A Map of relationships between 2 structures that can be used to transform data.
derivation: specialization
name: StructureMap
type: StructureMap
elements:
  description: {isModifier: false, short: Natural language description of the structure map, mustSupport: false, isSummary: false, index: 12}
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 9}
  group:
    min: 1
    isModifier: false
    short: Named sections for reader convenience
    index: 27
    mustSupport: false
    array: true
    elements:
      name: {isModifier: false, short: Human-readable label, mustSupport: false, isSummary: true, index: 28}
      extends: {isModifier: false, short: Another group that this group adds rules to, mustSupport: false, isSummary: true, index: 29}
      typeMode:
        isModifier: false
        short: types | type-and-types
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-group-type-mode|5.0.0'}
        isSummary: true
        index: 30
      documentation: {isModifier: false, short: Additional description/explanation for group, mustSupport: false, isSummary: true, index: 31}
      input:
        min: 1
        isModifier: false
        short: Named instance provided when invoking the map
        index: 32
        mustSupport: false
        array: true
        elements:
          name: {isModifier: false, short: Name for this instance of data, mustSupport: false, isSummary: true, index: 33}
          type: {isModifier: false, short: Type for this instance of data, mustSupport: false, isSummary: true, index: 34}
          mode:
            isModifier: false
            short: source | target
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-input-mode|5.0.0'}
            isSummary: true
            index: 35
          documentation: {isModifier: false, short: Documentation for this instance of data, mustSupport: false, isSummary: false, index: 36}
        required: [mode, name]
        isSummary: true
      rule:
        isModifier: false
        short: Transform Rule from source to target
        mustSupport: false
        array: true
        isSummary: true
        index: 37
        elements:
          name: {isModifier: false, short: Name of the rule for internal references, mustSupport: false, isSummary: true, index: 38}
          source:
            min: 1
            isModifier: false
            short: Source inputs to the mapping
            index: 39
            mustSupport: false
            array: true
            elements:
              min: {isModifier: false, short: Specified minimum cardinality, mustSupport: false, isSummary: true, index: 41}
              variable: {isModifier: false, short: 'Named context for field, if a field is specified', mustSupport: false, isSummary: true, index: 47}
              element: {isModifier: false, short: Optional field for this source, mustSupport: false, isSummary: true, index: 45}
              check: {isModifier: false, short: FHIRPath expression  - must be true or the mapping engine throws an error instead of completing, mustSupport: false, isSummary: true, index: 49}
              type: {isModifier: false, short: Rule only applies if source has this type, mustSupport: false, isSummary: true, index: 43}
              logMessage: {isModifier: false, short: Message to put in log if source exists (FHIRPath), mustSupport: false, isSummary: true, index: 50}
              max: {isModifier: false, short: Specified maximum cardinality (number or *), mustSupport: false, isSummary: true, index: 42}
              condition: {isModifier: false, short: FHIRPath expression  - must be true or the rule does not apply, mustSupport: false, isSummary: true, index: 48}
              context: {isModifier: false, short: Type or variable this rule applies to, mustSupport: false, isSummary: true, index: 40}
              listMode:
                isModifier: false
                short: first | not_first | last | not_last | only_one
                mustSupport: false
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-source-list-mode|5.0.0'}
                isSummary: true
                index: 46
              defaultValue: {isModifier: false, short: Default value if no value exists, mustSupport: false, isSummary: true, index: 44}
            required: [context]
            isSummary: true
          target:
            constraint:
              smp-1: {human: Can only have an element if you have a context, source: 'http://hl7.org/fhir/StructureDefinition/StructureMap', severity: error, expression: element.exists() implies context.exists()}
            isModifier: false
            short: Content to create because of this mapping rule
            mustSupport: false
            array: true
            isSummary: true
            index: 51
            elements:
              context: {isModifier: false, short: Variable this rule applies to, mustSupport: false, isSummary: true, index: 52}
              element: {isModifier: false, short: Field to create in the context, mustSupport: false, isSummary: true, index: 53}
              variable: {isModifier: false, short: 'Named context for field, if desired, and a field is specified', mustSupport: false, isSummary: true, index: 54}
              listMode:
                isModifier: false
                short: first | share | last | single
                mustSupport: false
                array: true
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-target-list-mode|5.0.0'}
                isSummary: true
                index: 55
              listRuleId: {isModifier: false, short: Internal rule reference for shared list items, mustSupport: false, isSummary: true, index: 56}
              transform:
                isModifier: false
                short: create | copy +
                mustSupport: false
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-transform|5.0.0'}
                isSummary: true
                index: 57
              parameter:
                isModifier: false
                short: Parameters to the transform
                mustSupport: false
                array: true
                isSummary: true
                index: 58
                elements:
                  value:
                    isModifier: false
                    short: Parameter value - variable or literal
                    mustSupport: false
                    choices: []
                    isSummary: true
                    index: 60
                required: [value]
          rule:
            elementReference: ['http://hl7.org/fhir/StructureDefinition/StructureMap', elements, group, elements, rule]
            isModifier: false
            short: Rules contained in this rule
            mustSupport: false
            array: true
            isSummary: true
            index: 61
          dependent:
            isModifier: false
            short: Which other rules to apply in the context of this rule
            mustSupport: false
            array: true
            isSummary: true
            index: 62
            elements:
              name: {isModifier: false, short: Name of a rule or group to apply, mustSupport: false, isSummary: true, index: 63}
              parameter:
                elementReference: ['http://hl7.org/fhir/StructureDefinition/StructureMap', elements, group, elements, rule, elements, target, elements, parameter]
                min: 1
                isModifier: false
                short: Parameter to pass to the rule or group
                index: 64
                mustSupport: false
                array: true
                isSummary: true
            required: [parameter, name]
          documentation: {isModifier: false, short: Documentation for this instance of data, mustSupport: false, isSummary: false, index: 65}
        required: [source]
    required: [name, input]
    isSummary: true
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 10}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for structure 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 structure map is defined, mustSupport: false, isSummary: false, index: 15}
  name: {isModifier: false, short: Name for this structure map (computer friendly), mustSupport: false, isSummary: true, index: 5}
  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}
  title: {isModifier: false, short: Name for this structure map (human friendly), mustSupport: false, isSummary: true, index: 6}
  const:
    isModifier: false
    short: Definition of the constant value used in the map rules
    mustSupport: false
    array: true
    isSummary: true
    index: 24
    elements:
      name: {isModifier: false, short: Constant name, mustSupport: false, isSummary: true, index: 25}
      value: {isModifier: false, short: FHIRPath exression - value of the constant, mustSupport: false, isSummary: true, index: 26}
  structure:
    isModifier: false
    short: Structure Definition used by this map
    mustSupport: false
    array: true
    isSummary: true
    index: 18
    elements:
      url: {isModifier: false, short: Canonical reference to structure definition, mustSupport: false, isSummary: true, index: 19}
      mode:
        isModifier: false
        short: source | queried | target | produced
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/map-model-mode|5.0.0'}
        isSummary: true
        index: 20
      alias: {isModifier: false, short: Name for type in this map, mustSupport: false, isSummary: true, index: 21}
      documentation: {isModifier: false, short: Documentation on use of structure, mustSupport: false, isSummary: false, index: 22}
    required: [url, mode]
  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/StructureMap', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this structure map, represented as a URI (globally unique)
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the structure map, mustSupport: false, array: true, isSummary: true, index: 1}
  version: {isModifier: false, short: Business version of the structure map, mustSupport: false, isSummary: true, index: 2}
  import: {isModifier: false, short: Other maps used by this map (canonical URLs), mustSupport: false, array: true, isSummary: true, index: 23}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 11}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/StructureMap
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [url, group, name, status]