description: null
package_name: ca.bc.bcy-ids
derivation: constraint
name: ImmunizationRecommendation
type: ImmunizationRecommendation
elements:
  patient:
    elements:
      reference: {index: 18}
    required: [reference]
  date: {short: Date Forecast Status Calculated as of, index: 19}
  meta:
    index: 1
    elements:
      versionId: {index: 2}
      lastUpdated: {index: 3}
      profile: {index: 4}
      security: {index: 5}
      tag: {index: 6}
    required: [profile]
  authority:
    short: Organization runs the vaccination forecast
    index: 20
    elements:
      reference: {index: 21}
    required: [reference]
  recommendation:
    short: Vaccine forecasted to be administered.
    index: 22
    extensions:
      forecastedDoseVolumeExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume', type: Extension, isModifier: false, index: 23}
      forecastMoreInfoEDSExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-more-Info-eds', type: Extension, isModifier: false, index: 24}
      forecastMoreInfoLOAExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-more-Info-loa', type: Extension, isModifier: false, index: 25}
    elements:
      description: {short: Forecast Agent + Antigen combined description, index: 76}
      contraindicatedVaccineCode: {index: 55}
      doseNumber:
        choices: [doseNumberString]
        index: 78
      vaccineCode:
        index: 26
        elements:
          coding:
            index: 27
            elements:
              system: {index: 28}
            slicing:
              rules: open
              discriminator:
              - {path: code, type: value}
              min: 1
              max: 1
              slices:
                AgentNVC:
                  match: {code: null}
                  schema:
                    short: Agent in CVC code
                    _required: true
                    index: 29
                    elements:
                      system: {index: 30}
                      code: {index: 31}
                      display: {index: 32}
                    required: [display, system, code]
                AgentPIR:
                  match: {code: null}
                  schema:
                    short: Agent in PIR code
                    index: 33
                    elements:
                      system: {index: 34}
                      code: {index: 35}
                      display: {index: 36}
                    required: [display, system, code]
                AntigenNVC:
                  match: {code: null}
                  schema:
                    short: Antigen in NVC code
                    index: 37
                    elements:
                      system: {index: 38}
                      code: {index: 39}
                      display: {index: 40}
                    required: [display, system, code]
                AntigenPIR:
                  match: {code: null}
                  schema:
                    short: Antigen in PIR code
                    index: 41
                    elements:
                      system: {index: 42}
                      code: {index: 43}
                      display: {index: 44}
                    required: [display, system, code]
          text: {short: Trade Name, index: 45}
        required: [coding]
      doseNumberString: {type: string, choiceOf: doseNumber, index: 79}
      extension:
        type: Extension
        isModifier: false
        url: https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume
        index: 23
        slicing:
          slices:
            forecastedDoseVolumeExtension:
              match: {}
              schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume', index: 23}
            forecastMoreInfoEDSExtension:
              match: {}
              schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-more-Info-eds', index: 24}
            forecastMoreInfoLOAExtension:
              match: {}
              schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-more-Info-loa', index: 25}
      forecastStatus:
        short: Vaccination forecast status
        index: 56
        elements:
          coding:
            index: 57
            elements:
              id: {index: 58}
              system: {index: 59}
              version: {index: 60}
              code: {index: 61}
              display: {index: 62}
              userSelected: {index: 63}
            required: [system, code]
        required: [coding]
      forecastReason: {index: 64}
      dateCriterion:
        index: 65
        elements:
          code:
            elements:
              id: {index: 66}
              coding:
                index: 67
                elements:
                  id: {index: 68}
                  system: {index: 69}
                  version: {index: 70}
                  code: {index: 71}
                  display: {index: 72}
                  userSelected: {index: 73}
                required: [display, system, code]
              text: {index: 74}
            required: [coding, text]
          value: {index: 75}
      targetDisease:
        elements:
          id: {index: 46}
          coding:
            short: 1st instance Disease in CVC code, 2nd instance Disease in PIR code
            index: 47
            elements:
              id: {index: 48}
              system: {short: '1st instance: Disease in NVC code.  2nd instance: Disease in PIR code.', index: 49}
              version: {index: 50}
              code: {index: 51}
              display: {index: 52}
              userSelected: {index: 53}
            required: [display, system, code]
          text: {index: 54}
        required: [coding]
      supportingImmunization: {index: 80}
      supportingPatientInformation: {index: 81}
    required: [vaccineCode, dateCriterion, description]
  extension:
    array: true
    min: 2
    index: 8
    slicing:
      slices:
        pIRIdentifierExtension:
          match: {}
          schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', index: 9}
        pIRLockSeqNumberExtension:
          match: {}
          schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', index: 10}
  contained: {index: 7}
  id: {short: PIR Internal Vaccination Forecast ID, index: 0}
  identifier:
    short: PIR Internal Vaccination Forecast ID
    index: 11
    elements:
      type:
        index: 12
        elements:
          id: {index: 13}
          coding: {index: 14}
          text: {index: 15}
        required: [text]
      system: {index: 16}
      value: {index: 17}
    required: [value, type, system]
package_version: 1.1.0
extensions:
  pIRIdentifierExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', type: Extension, isModifier: false, index: 9}
  pIRLockSeqNumberExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', type: Extension, isModifier: false, index: 10}
class: profile
kind: resource
url: http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation
base: http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
version: null
required: [authority, id, identifier, meta]