description: This template represents both medicinal and non-medicinal supplies ordered, requested, or intended for the patient (e.g., medication prescription, order for wheelchair). The importance of the supply order or request to the patient and provider may be indicated in the Priority Preference. \nThe effectiveTime indicates the time when the supply is intended to take place and author time indicates when the documentation of the plan occurred. The Planned Supply template may also indicate the potential insurance coverage for the procedure. \nDepending on the type of supply, the product or participant will be either a Medication Information product (medication), an Immunization Medication Information product (immunization), or a Product Instance participant (device/equipment).
package_name: hl7.cda.us.ccda
derivation: constraint
name: PlannedSupply
type: http://hl7.org/cda/stds/core/StructureDefinition/Supply
elements:
  entryRelationship:
    short: The following entryRelationship represents the insurance coverage the patient may have for the supply.
    index: 22
    slicing:
      rules: open
      discriminator:
      - {path: act, type: profile}
      - {path: observation, type: profile}
      min: null
      slices:
        priorityPreference:
          match: {}
          schema:
            short: The following entryRelationship represents the priority that a patient or a provider places on the supply.
            array: true
            index: 23
            elements:
              typeCode:
                pattern: {type: Code, value: REFR}
                index: 24
              observation: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Observation', index: 25}
            required: [observation]
        indication:
          match: {}
          schema:
            short: The following entryRelationship represents the indication for the supply.
            array: true
            index: 26
            elements:
              typeCode:
                pattern: {type: Code, value: RSON}
                index: 27
              observation: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Observation', index: 28}
            required: [observation]
        instruction:
          match: {}
          schema:
            short: The following entryRelationship captures any instructions associated with the planned supply.
            array: true
            index: 29
            elements:
              typeCode:
                pattern: {type: Code, value: SUBJ}
                index: 30
              act: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Act', index: 31}
            required: [act]
        plannedCoverage:
          match: {}
          schema:
            array: true
            index: 32
            elements:
              typeCode:
                pattern: {type: Code, value: COMP}
                index: 33
              act: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Act', index: 34}
            required: [act]
  participant:
    short: This participant represents a device that is ordered, requested or intended for the patient.
    index: 18
    slicing:
      rules: open
      discriminator:
      - {path: typeCode, type: value}
      min: null
      slices:
        productInstance:
          match: {typeCode: DEV}
          schema:
            index: 19
            elements:
              typeCode:
                pattern: {type: Code, value: DEV}
                index: 20
              participantRole: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole', index: 21}
  classCode: {index: 4}
  author: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Author', short: The author in a supply represents the clinician who is requesting or planning the supply., index: 17}
  repeatNumber: {short: 'In a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.', index: 12}
  product:
    short: Represents either a medication or an immunization supply
    index: 14
    elements:
      manufacturedProduct: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct', index: 15}
  id: {index: 6}
  moodCode:
    binding: {strength: required, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24'}
    index: 5
  effectiveTime: {short: The effectiveTime in a planned supply represents the time that the supply should occur., index: 11}
  templateId:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: root, type: value}
      - {path: extension, type: value}
      min: 1
      slices:
        planned-supply:
          match: {root: 2.16.840.1.113883.10.20.22.4.43, extension: '2024-05-01'}
          schema:
            _required: true
            index: 1
            elements:
              root:
                pattern: {type: String, value: 2.16.840.1.113883.10.20.22.4.43}
                index: 2
              extension:
                pattern: {type: String, value: '2024-05-01'}
                index: 3
            required: [root, extension]
            extensions: {}
  quantity: {index: 13}
  statusCode:
    index: 9
    elements:
      code:
        pattern: {type: Code, value: active}
        index: 10
    required: [code]
  performer: {short: The clinician who is expected to perform the supply could be identified using supply/performer., index: 16}
  text:
    short: SHOULD reference the portion of section narrative text corresponding to this entry
    index: 7
    elements:
      reference:
        constraint:
          value-starts-octothorpe: {human: 'If reference/@value is present, it SHALL begin with a ''#'' and SHALL point to its corresponding narrative', source: 'http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply', severity: error, expression: value.exists() implies value.startsWith('#')}
        index: 8
package_version: 3.0.0
class: logical
kind: logical
url: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply
base: http://hl7.org/cda/stds/core/StructureDefinition/Supply
version: 3.0.0
required: [id, statusCode, templateId]