description: This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. \nThe priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred.
package_name: hl7.cda.us.ccda
derivation: constraint
name: PlannedImmunizationActivity
type: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
elements:
  entryRelationship:
    short: The following entryRelationship captures any instructions associated with the planned immunization activity.
    index: 22
    slicing:
      rules: open
      discriminator:
      - {path: observation, type: profile}
      - {path: act, type: profile}
      min: null
      slices:
        priorityPreference:
          match: {}
          schema:
            short: The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
            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 immunization activity.
            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:
            array: true
            index: 29
            elements:
              typeCode:
                pattern: {type: Code, value: SUBJ}
                index: 30
              observation: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Observation', index: 31}
            required: [observation]
  consumable:
    index: 18
    elements:
      manufacturedProduct: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct', index: 19}
  doseQuantity:
    constraint:
      should-unit: {human: SHOULD contain @unit, source: 'http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity', severity: warning, expression: nullFlavor.exists() or unit.exists()}
    index: 16
    elements:
      unit:
        short: 'NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units'
        binding: {strength: preferred, valueSet: 'http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive'}
        index: 17
  routeCode:
    binding: {strength: required, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7'}
    constraint:
      should-translation: {human: SHOULD contain translation, source: 'http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity', severity: warning, expression: translation.exists()}
    index: 13
    elements:
      translation:
        binding: {strength: preferred, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12'}
        index: 14
  classCode: {index: 4}
  author: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Author', short: The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity., index: 21}
  repeatNumber: {short: 'In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.', index: 12}
  id: {index: 6}
  approachSiteCode:
    binding: {strength: required, valueSet: 'http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9'}
    index: 15
  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 immunization activity represents the time that the immunization activity should occur., index: 11}
  templateId:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: root, type: value}
      min: 1
      slices:
        planned-immunization-activity:
          match: {root: 2.16.840.1.113883.10.20.22.4.120}
          schema:
            _required: true
            index: 1
            elements:
              root:
                pattern: {type: String, value: 2.16.840.1.113883.10.20.22.4.120}
                index: 2
              extension: {index: 3}
            required: [root]
            extensions: {}
  statusCode:
    index: 9
    elements:
      code:
        pattern: {type: Code, value: active}
        index: 10
    required: [code]
  performer: {short: The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer., index: 20}
  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/PlannedImmunizationActivity', severity: error, expression: value.exists() implies value.startsWith('#')}
        index: 8
  precondition:
    index: 32
    slicing:
      rules: open
      discriminator:
      - {path: criterion, type: profile}
      min: null
      slices:
        pronditionForSubstanceAdmin:
          match: {}
          schema:
            array: true
            index: 33
            elements:
              typeCode: {index: 34}
              criterion: {type: 'http://hl7.org/cda/stds/core/StructureDefinition/Criterion', index: 35}
            required: [typeCode]
package_version: 4.0.0-ballot
class: logical
kind: logical
url: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity
base: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
version: 4.0.0-ballot
required: [id, effectiveTime, statusCode, templateId]