description: This cross-version extension represents DeviceDispense from http://hl7.org/fhir/StructureDefinition/DeviceDispense|5.0.0 for use in FHIR R4B.
package_name: hl7.fhir.uv.xver-r5.r4b
derivation: constraint
name: ext_R5_DeviceDispense
type: Extension
elements:
  extension:
    array: true
    min: 3
    index: 0
    slicing:
      rules: closed
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: 3
      slices:
        category:
          match: {url: null}
          schema:
            short: Type of device dispense
            isModifier: false
            array: true
            index: 17
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Type of device dispense
                choices: [valueCodeableConcept]
                index: 19
              valueCodeableConcept:
                base: {path: 'Extension.value[x]'}
                type: CodeableConcept
                short: Type of device dispense
                choiceOf: value
                index: 20
        whenHandedOver:
          match: {url: null}
          schema:
            short: When product was given out
            isModifier: false
            index: 63
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: When product was given out
                choices: [valueDateTime]
                index: 65
              valueDateTime:
                base: {path: 'Extension.value[x]'}
                type: dateTime
                short: When product was given out
                choiceOf: value
                index: 66
        eventHistory:
          match: {url: null}
          schema:
            short: A list of relevant lifecycle events
            isModifier: false
            array: true
            index: 79
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: A list of relevant lifecycle events
                choices: [valueReference]
                index: 81
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: A list of relevant lifecycle events
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Provenance']
                index: 82
        usageInstruction:
          match: {url: null}
          schema:
            short: Full representation of the usage instructions
            isModifier: false
            index: 75
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Full representation of the usage instructions
                choices: [valueMarkdown]
                index: 77
              valueMarkdown:
                base: {path: 'Extension.value[x]'}
                type: markdown
                short: Full representation of the usage instructions
                choiceOf: value
                index: 78
        encounter:
          match: {url: null}
          schema:
            short: Encounter associated with event
            isModifier: false
            index: 29
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Encounter associated with event
                choices: [valueReference]
                index: 31
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: Encounter associated with event
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
                index: 32
        preparedDate:
          match: {url: null}
          schema:
            short: When product was packaged and reviewed
            isModifier: false
            index: 59
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: When product was packaged and reviewed
                choices: [valueDateTime]
                index: 61
              valueDateTime:
                base: {path: 'Extension.value[x]'}
                type: dateTime
                short: When product was packaged and reviewed
                choiceOf: value
                index: 62
        type:
          match: {url: null}
          schema:
            short: Trial fill, partial fill, emergency fill, etc
            isModifier: false
            index: 51
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Trial fill, partial fill, emergency fill, etc
                choices: [valueCodeableConcept]
                index: 53
              valueCodeableConcept:
                base: {path: 'Extension.value[x]'}
                type: CodeableConcept
                short: Trial fill, partial fill, emergency fill, etc
                choiceOf: value
                index: 54
        statusReason:
          match: {url: null}
          schema:
            short: Why a dispense was or was not performed
            isModifier: false
            index: 13
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Why a dispense was or was not performed
                choices: [valueCodeableReference]
                index: 15
              valueCodeableReference:
                base: {path: 'Extension.value[x]'}
                type: CodeableReference
                short: Why a dispense was or was not performed
                choiceOf: value
                index: 16
        note:
          match: {url: null}
          schema:
            short: Information about the dispense
            isModifier: false
            array: true
            index: 71
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Information about the dispense
                choices: [valueAnnotation]
                index: 73
              valueAnnotation:
                base: {path: 'Extension.value[x]'}
                type: Annotation
                short: Information about the dispense
                choiceOf: value
                index: 74
        supportingInformation:
          match: {url: null}
          schema:
            short: Information that supports the dispensing of the device
            isModifier: false
            array: true
            index: 33
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Information that supports the dispensing of the device
                choices: [valueReference]
                index: 35
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: Information that supports the dispensing of the device
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
                index: 36
        status:
          match: {url: null}
          schema:
            isModifier: true
            short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
            _required: true
            isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            index: 9
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
                choices: [valueCode]
                index: 11
              valueCode:
                base: {path: 'Extension.value[x]'}
                type: code
                short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
                choiceOf: value
                index: 12
        device:
          match: {url: null}
          schema:
            short: What device was supplied
            isModifier: false
            _required: true
            index: 21
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: What device was supplied
                choices: [valueCodeableReference]
                index: 23
              valueCodeableReference:
                base: {path: 'Extension.value[x]'}
                type: CodeableReference
                short: What device was supplied
                choiceOf: value
                index: 24
        basedOn:
          match: {url: null}
          schema:
            short: The order or request that this dispense is fulfilling
            isModifier: false
            array: true
            index: 1
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: The order or request that this dispense is fulfilling
                choices: [valueReference]
                index: 3
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: The order or request that this dispense is fulfilling
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest']
                index: 4
        quantity:
          match: {url: null}
          schema:
            short: Amount dispensed
            isModifier: false
            index: 55
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Amount dispensed
                choices: [valueQuantity]
                index: 57
              valueQuantity:
                base: {path: 'Extension.value[x]'}
                type: Quantity
                short: Amount dispensed
                choiceOf: value
                index: 58
        partOf:
          match: {url: null}
          schema:
            short: The bigger event that this dispense is a part of
            isModifier: false
            array: true
            index: 5
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: The bigger event that this dispense is a part of
                choices: [valueReference]
                index: 7
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: The bigger event that this dispense is a part of
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Procedure']
                index: 8
        location:
          match: {url: null}
          schema:
            short: Where the dispense occurred
            isModifier: false
            index: 47
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Where the dispense occurred
                choices: [valueReference]
                index: 49
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: Where the dispense occurred
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Location']
                index: 50
        receiver:
          match: {url: null}
          schema:
            short: Who collected the device or where the medication was delivered
            isModifier: false
            index: 25
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Who collected the device or where the medication was delivered
                choices: [valueReference]
                index: 27
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: Who collected the device or where the medication was delivered
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
                index: 28
        destination:
          match: {url: null}
          schema:
            short: Where the device was sent or should be sent
            isModifier: false
            index: 67
            elements:
              value:
                base: {path: 'Extension.value[x]'}
                short: Where the device was sent or should be sent
                choices: [valueReference]
                index: 69
              valueReference:
                base: {path: 'Extension.value[x]'}
                type: Reference
                short: Where the device was sent or should be sent
                choiceOf: value
                refers: ['http://hl7.org/fhir/StructureDefinition/Location']
                index: 70
        performer:
          match: {url: null}
          schema:
            short: Who performed event
            isModifier: false
            array: true
            index: 37
            extensions:
              function:
                url: null
                short: Who performed the dispense and what they did
                isModifier: false
                index: 39
                elements:
                  value:
                    base: {path: 'Extension.value[x]'}
                    short: Who performed the dispense and what they did
                    choices: [valueCodeableConcept]
                    index: 41
                  valueCodeableConcept:
                    base: {path: 'Extension.value[x]'}
                    type: CodeableConcept
                    short: Who performed the dispense and what they did
                    choiceOf: value
                    index: 42
              actor:
                url: null
                short: Individual who was performing
                isModifier: false
                _required: true
                index: 43
                elements:
                  value:
                    base: {path: 'Extension.value[x]'}
                    short: Individual who was performing
                    choices: [valueReference]
                    index: 45
                  valueReference:
                    base: {path: 'Extension.value[x]'}
                    type: Reference
                    short: Individual who was performing
                    choiceOf: value
                    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
                    index: 46
            elements:
              extension:
                array: true
                min: 1
                index: 38
                slicing:
                  rules: closed
                  ordered: false
                  discriminator:
                  - {path: url, type: value}
                  min: 1
                  slices:
                    function:
                      match: {url: null}
                      schema:
                        short: Who performed the dispense and what they did
                        isModifier: false
                        index: 39
                        elements:
                          value:
                            base: {path: 'Extension.value[x]'}
                            short: Who performed the dispense and what they did
                            choices: [valueCodeableConcept]
                            index: 41
                          valueCodeableConcept:
                            base: {path: 'Extension.value[x]'}
                            type: CodeableConcept
                            short: Who performed the dispense and what they did
                            choiceOf: value
                            index: 42
                    actor:
                      match: {url: null}
                      schema:
                        short: Individual who was performing
                        isModifier: false
                        _required: true
                        index: 43
                        elements:
                          value:
                            base: {path: 'Extension.value[x]'}
                            short: Individual who was performing
                            choices: [valueReference]
                            index: 45
                          valueReference:
                            base: {path: 'Extension.value[x]'}
                            type: Reference
                            short: Individual who was performing
                            choiceOf: value
                            refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
                            index: 46
            required: [extension]
  url:
    pattern: {type: Uri, value: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDispense'}
    index: 83
package_version: 0.0.1-snapshot-1
extensions:
  category:
    url: null
    short: Type of device dispense
    isModifier: false
    array: true
    index: 17
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Type of device dispense
        choices: [valueCodeableConcept]
        index: 19
      valueCodeableConcept:
        base: {path: 'Extension.value[x]'}
        type: CodeableConcept
        short: Type of device dispense
        choiceOf: value
        index: 20
  whenHandedOver:
    url: null
    short: When product was given out
    isModifier: false
    index: 63
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: When product was given out
        choices: [valueDateTime]
        index: 65
      valueDateTime:
        base: {path: 'Extension.value[x]'}
        type: dateTime
        short: When product was given out
        choiceOf: value
        index: 66
  eventHistory:
    url: null
    short: A list of relevant lifecycle events
    isModifier: false
    array: true
    index: 79
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: A list of relevant lifecycle events
        choices: [valueReference]
        index: 81
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: A list of relevant lifecycle events
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Provenance']
        index: 82
  usageInstruction:
    url: null
    short: Full representation of the usage instructions
    isModifier: false
    index: 75
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Full representation of the usage instructions
        choices: [valueMarkdown]
        index: 77
      valueMarkdown:
        base: {path: 'Extension.value[x]'}
        type: markdown
        short: Full representation of the usage instructions
        choiceOf: value
        index: 78
  encounter:
    url: null
    short: Encounter associated with event
    isModifier: false
    index: 29
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Encounter associated with event
        choices: [valueReference]
        index: 31
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: Encounter associated with event
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
        index: 32
  preparedDate:
    url: null
    short: When product was packaged and reviewed
    isModifier: false
    index: 59
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: When product was packaged and reviewed
        choices: [valueDateTime]
        index: 61
      valueDateTime:
        base: {path: 'Extension.value[x]'}
        type: dateTime
        short: When product was packaged and reviewed
        choiceOf: value
        index: 62
  type:
    url: null
    short: Trial fill, partial fill, emergency fill, etc
    isModifier: false
    index: 51
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Trial fill, partial fill, emergency fill, etc
        choices: [valueCodeableConcept]
        index: 53
      valueCodeableConcept:
        base: {path: 'Extension.value[x]'}
        type: CodeableConcept
        short: Trial fill, partial fill, emergency fill, etc
        choiceOf: value
        index: 54
  statusReason:
    url: null
    short: Why a dispense was or was not performed
    isModifier: false
    index: 13
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Why a dispense was or was not performed
        choices: [valueCodeableReference]
        index: 15
      valueCodeableReference:
        base: {path: 'Extension.value[x]'}
        type: CodeableReference
        short: Why a dispense was or was not performed
        choiceOf: value
        index: 16
  note:
    url: null
    short: Information about the dispense
    isModifier: false
    array: true
    index: 71
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Information about the dispense
        choices: [valueAnnotation]
        index: 73
      valueAnnotation:
        base: {path: 'Extension.value[x]'}
        type: Annotation
        short: Information about the dispense
        choiceOf: value
        index: 74
  supportingInformation:
    url: null
    short: Information that supports the dispensing of the device
    isModifier: false
    array: true
    index: 33
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Information that supports the dispensing of the device
        choices: [valueReference]
        index: 35
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: Information that supports the dispensing of the device
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        index: 36
  status:
    url: null
    isModifier: true
    short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
    _required: true
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    index: 9
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
        choices: [valueCode]
        index: 11
      valueCode:
        base: {path: 'Extension.value[x]'}
        type: code
        short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
        choiceOf: value
        index: 12
  device:
    url: null
    short: What device was supplied
    isModifier: false
    _required: true
    index: 21
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: What device was supplied
        choices: [valueCodeableReference]
        index: 23
      valueCodeableReference:
        base: {path: 'Extension.value[x]'}
        type: CodeableReference
        short: What device was supplied
        choiceOf: value
        index: 24
  basedOn:
    url: null
    short: The order or request that this dispense is fulfilling
    isModifier: false
    array: true
    index: 1
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: The order or request that this dispense is fulfilling
        choices: [valueReference]
        index: 3
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: The order or request that this dispense is fulfilling
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest']
        index: 4
  quantity:
    url: null
    short: Amount dispensed
    isModifier: false
    index: 55
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Amount dispensed
        choices: [valueQuantity]
        index: 57
      valueQuantity:
        base: {path: 'Extension.value[x]'}
        type: Quantity
        short: Amount dispensed
        choiceOf: value
        index: 58
  partOf:
    url: null
    short: The bigger event that this dispense is a part of
    isModifier: false
    array: true
    index: 5
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: The bigger event that this dispense is a part of
        choices: [valueReference]
        index: 7
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: The bigger event that this dispense is a part of
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Procedure']
        index: 8
  location:
    url: null
    short: Where the dispense occurred
    isModifier: false
    index: 47
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Where the dispense occurred
        choices: [valueReference]
        index: 49
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: Where the dispense occurred
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        index: 50
  receiver:
    url: null
    short: Who collected the device or where the medication was delivered
    isModifier: false
    index: 25
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Who collected the device or where the medication was delivered
        choices: [valueReference]
        index: 27
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: Who collected the device or where the medication was delivered
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        index: 28
  destination:
    url: null
    short: Where the device was sent or should be sent
    isModifier: false
    index: 67
    elements:
      value:
        base: {path: 'Extension.value[x]'}
        short: Where the device was sent or should be sent
        choices: [valueReference]
        index: 69
      valueReference:
        base: {path: 'Extension.value[x]'}
        type: Reference
        short: Where the device was sent or should be sent
        choiceOf: value
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        index: 70
  performer:
    url: null
    short: Who performed event
    isModifier: false
    array: true
    index: 37
    extensions:
      function:
        url: null
        short: Who performed the dispense and what they did
        isModifier: false
        index: 39
        elements:
          value:
            base: {path: 'Extension.value[x]'}
            short: Who performed the dispense and what they did
            choices: [valueCodeableConcept]
            index: 41
          valueCodeableConcept:
            base: {path: 'Extension.value[x]'}
            type: CodeableConcept
            short: Who performed the dispense and what they did
            choiceOf: value
            index: 42
      actor:
        url: null
        short: Individual who was performing
        isModifier: false
        _required: true
        index: 43
        elements:
          value:
            base: {path: 'Extension.value[x]'}
            short: Individual who was performing
            choices: [valueReference]
            index: 45
          valueReference:
            base: {path: 'Extension.value[x]'}
            type: Reference
            short: Individual who was performing
            choiceOf: value
            refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
            index: 46
    elements:
      extension:
        array: true
        min: 1
        index: 38
        slicing:
          rules: closed
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: 1
          slices:
            function:
              match: {url: null}
              schema:
                short: Who performed the dispense and what they did
                isModifier: false
                index: 39
                elements:
                  value:
                    base: {path: 'Extension.value[x]'}
                    short: Who performed the dispense and what they did
                    choices: [valueCodeableConcept]
                    index: 41
                  valueCodeableConcept:
                    base: {path: 'Extension.value[x]'}
                    type: CodeableConcept
                    short: Who performed the dispense and what they did
                    choiceOf: value
                    index: 42
            actor:
              match: {url: null}
              schema:
                short: Individual who was performing
                isModifier: false
                _required: true
                index: 43
                elements:
                  value:
                    base: {path: 'Extension.value[x]'}
                    short: Individual who was performing
                    choices: [valueReference]
                    index: 45
                  valueReference:
                    base: {path: 'Extension.value[x]'}
                    type: Reference
                    short: Individual who was performing
                    choiceOf: value
                    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
                    index: 46
    required: [extension]
class: extension
kind: complex-type
url: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceDispense
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 0.0.1-snapshot-1
required: [url]