description: null
package_name: ca.bc.bcy-ids
derivation: constraint
name: Immunization
type: Immunization
elements:
  patient:
    elements:
      id: {index: 46}
      reference: {index: 47}
      type: {index: 48}
      identifier: {index: 49}
      display: {index: 50}
    required: [reference]
  occurrence[x]:
    extensions:
      _occurrenceDateTime: {url: 'https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date', type: Extension, short: Estimated Flag for Vaccination Date, index: 54}
    elements:
      extension:
        type: Extension
        short: Estimated Flag for Vaccination Date
        url: https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date
        index: 54
        slicing:
          slices:
            _occurrenceDateTime:
              match: {}
              schema: {type: Extension, short: Estimated Flag for Vaccination Date, url: 'https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date', index: 54}
  isSubpotent: {index: 91}
  protocolApplied:
    short: Dose Number or Revised Dose Number
    index: 107
    elements:
      id: {index: 108}
      series: {index: 109}
      authority: {index: 110}
      targetDisease: {index: 111}
      doseNumber:
        choices: [doseNumberString]
        index: 113
      doseNumberString: {type: string, choiceOf: doseNumber, index: 114}
      doseNumber[x]:
        extensions:
          _doseNumber: {url: 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose', max: 1, type: Extension, short: Revised Dose Number + Reason + comments, isModifier: false, index: 115}
        elements:
          extension:
            type: Extension
            short: Revised Dose Number + Reason + comments
            isModifier: false
            url: http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose
            index: 115
            slicing:
              slices:
                _doseNumber:
                  match: {}
                  schema: {type: Extension, short: Revised Dose Number + Reason + comments, isModifier: false, url: 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose', index: 115}
                  max: 1
      seriesDoses:
        choices: []
        index: 117
  meta:
    index: 1
    elements:
      versionId: {index: 2}
      lastUpdated: {index: 3}
      profile: {index: 4}
      security: {index: 5}
      tag: {index: 6}
    required: [profile]
  site:
    elements:
      id: {index: 64}
      coding:
        elements:
          id: {index: 65}
          system: {index: 66}
          version: {index: 67}
          code: {index: 68}
          userSelected: {index: 69}
      text: {index: 70}
  vaccineCode:
    index: 20
    elements:
      id: {index: 21}
      coding:
        index: 22
        elements:
          id: {index: 23}
        slicing:
          rules: open
          discriminator:
          - {path: code, type: value}
          min: null
          slices:
            AgentNVC:
              match: {code: null}
              schema:
                short: Agent administered
                _required: true
                index: 24
                elements:
                  id: {index: 25}
                  system: {index: 26}
                  version: {index: 27}
                  code: {index: 28}
                  display: {index: 29}
                  userSelected: {index: 30}
                required: [display, system, code]
            AgentPIR:
              match: {code: null}
              schema:
                index: 31
                elements:
                  id: {index: 32}
                  system: {index: 33}
                  version: {index: 34}
                  code: {index: 35}
                  display: {index: 36}
                  userSelected: {index: 37}
                required: [display, system, code]
            Tradename:
              match: {code: null}
              schema:
                short: Tradename administered
                index: 38
                elements:
                  id: {index: 39}
                  system: {index: 40}
                  version: {index: 41}
                  code: {index: 42}
                  display: {index: 43}
                  userSelected: {index: 44}
                required: [system, code]
      text: {index: 45}
  doseQuantity:
    elements:
      id: {index: 78}
      value: {index: 79}
      unit: {index: 80}
      system: {index: 81}
      code: {index: 82}
  reasonCode: {index: 89}
  route:
    elements:
      id: {index: 71}
      coding:
        elements:
          id: {index: 72}
          system: {index: 73}
          version: {index: 74}
          code: {index: 75}
          userSelected: {index: 76}
      text: {index: 77}
  programEligibility: {index: 105}
  note:
    index: 85
    extensions:
      pIRIdentifierExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', type: Extension, isModifier: false, index: 87}
      pIRLockSeqNumberExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', type: Extension, isModifier: false, index: 88}
    elements:
      extension:
        array: true
        min: 2
        index: 86
        slicing:
          slices:
            pIRIdentifierExtension:
              match: {}
              schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', index: 87}
            pIRLockSeqNumberExtension:
              match: {}
              schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', index: 88}
  extension:
    array: true
    min: 2
    index: 8
    slicing:
      slices:
        antigenDose:
          match: {}
          schema: {type: Extension, short: Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered, url: 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen', index: 9}
        pIRIdentifierExtension:
          match: {}
          schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', index: 10}
        pIRLockSeqNumberExtension:
          match: {}
          schema: {type: Extension, isModifier: false, url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', index: 11}
  contained: {index: 7}
  status: {short: completed | entered-in-error |, index: 19}
  id: {short: PIR Internal Immunization ID, index: 0}
  lotNumber: {index: 63}
  identifier:
    short: PIR internal Immunization Identifier + External Immunization ID from source system(s)
    index: 12
    elements:
      type:
        index: 13
        elements:
          id: {index: 14}
          coding: {index: 15}
          text: {index: 16}
        required: [text]
      system: {index: 17}
      value: {index: 18}
    required: [value, type, system]
  education: {index: 104}
  reaction: {index: 106}
  location:
    short: Immunization Service Delivery Location (SDL)
    index: 57
    elements:
      id: {index: 58}
      reference: {index: 59}
      type: {index: 60}
      identifier: {index: 61}
      display: {index: 62}
    required: [reference]
  occurrenceDateTime: {type: dateTime, choiceOf: occurrence, index: 53}
  subpotentReason:
    short: Reason + Status for being subpotent
    index: 92
    elements:
      coding:
        index: 93
        slicing:
          rules: open
          discriminator:
          - {path: code, type: value}
          min: 1
          max: 1
          slices:
            doseStatusReason:
              match: {code: null}
              schema:
                short: 'Slice 1: Dose Status Overriden Reason'
                index: 94
                elements:
                  id: {index: 95}
                  system: {index: 96}
                  code: {index: 97}
                  display: {index: 98}
                required: [display, system, code]
            doseStatus:
              match: {code: null}
              schema:
                short: Dose Status if overriden
                _required: true
                index: 99
                elements:
                  system: {index: 100}
                  code: {index: 101}
                  display: {index: 102}
                required: [display, system, code]
      text: {index: 103}
    required: [coding]
  occurrence:
    extensions: {}
    elements:
      extension:
        elements:
          value:
            choices: []
            index: 56
  performer:
    elements:
      actor:
        short: Provider who administered the vaccine
        index: 83
        elements:
          reference: {index: 84}
  reasonReference: {index: 90}
package_version: 1.1.0
extensions:
  antigenDose: {url: 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen', type: Extension, short: Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered, index: 9}
  pIRIdentifierExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier', type: Extension, isModifier: false, index: 10}
  pIRLockSeqNumberExtension: {url: 'https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number', type: Extension, isModifier: false, index: 11}
class: profile
kind: resource
url: http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: null
required: [id, identifier, meta]