description: null
package_name: ca.bc.bcy
derivation: constraint
name: Immunization
type: Immunization
elements:
  patient:
    elements:
      id: {index: 43}
      reference: {index: 44}
      type: {index: 45}
      identifier: {index: 46}
      display: {index: 47}
    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: 51}
    elements:
      extension:
        type: Extension
        short: Estimated Flag for Vaccination Date
        url: https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date
        index: 51
        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: 51}
  isSubpotent: {index: 85}
  protocolApplied:
    short: Dose Number or Revised Dose Number
    index: 101
    elements:
      id: {index: 102}
      series: {index: 103}
      authority: {index: 104}
      targetDisease: {index: 105}
      doseNumber:
        choices: [doseNumberString]
        index: 107
      doseNumberString: {type: string, choiceOf: doseNumber, index: 108}
      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: 109}
        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: 109
            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: 109}
                  max: 1
      seriesDoses:
        choices: []
        index: 111
  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: 61}
      coding:
        elements:
          id: {index: 62}
          system: {index: 63}
          version: {index: 64}
          code: {index: 65}
          userSelected: {index: 66}
      text: {index: 67}
  vaccineCode:
    index: 17
    elements:
      id: {index: 18}
      coding:
        index: 19
        elements:
          id: {index: 20}
        slicing:
          rules: open
          discriminator:
          - {path: code, type: value}
          min: null
          slices:
            AgentNVC:
              match: {code: null}
              schema:
                short: Agent administered
                _required: true
                index: 21
                elements:
                  id: {index: 22}
                  system: {index: 23}
                  version: {index: 24}
                  code: {index: 25}
                  display: {index: 26}
                  userSelected: {index: 27}
                required: [display, system, code]
            AgentPIR:
              match: {code: null}
              schema:
                index: 28
                elements:
                  id: {index: 29}
                  system: {index: 30}
                  version: {index: 31}
                  code: {index: 32}
                  display: {index: 33}
                  userSelected: {index: 34}
                required: [display, system, code]
            Tradename:
              match: {code: null}
              schema:
                short: Tradename administered
                index: 35
                elements:
                  id: {index: 36}
                  system: {index: 37}
                  version: {index: 38}
                  code: {index: 39}
                  display: {index: 40}
                  userSelected: {index: 41}
                required: [system, code]
      text: {index: 42}
  doseQuantity:
    elements:
      id: {index: 75}
      value: {index: 76}
      unit: {index: 77}
      system: {index: 78}
      code: {index: 79}
  reasonCode: {index: 83}
  route:
    elements:
      id: {index: 68}
      coding:
        elements:
          id: {index: 69}
          system: {index: 70}
          version: {index: 71}
          code: {index: 72}
          userSelected: {index: 73}
      text: {index: 74}
  programEligibility: {index: 99}
  note: {index: 82}
  extension:
    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: 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: 8}
  contained: {index: 7}
  status: {short: completed | entered-in-error |, index: 16}
  id: {short: PIR Internal Immunization ID, index: 0}
  lotNumber: {index: 60}
  identifier:
    short: PIR internal Immunization Identifier + External Immunization ID from source system(s)
    index: 9
    elements:
      type:
        index: 10
        elements:
          id: {index: 11}
          coding: {index: 12}
          text: {index: 13}
        required: [text]
      system: {index: 14}
      value: {index: 15}
    required: [value, type, system]
  education: {index: 98}
  reaction: {index: 100}
  location:
    short: Immunization Service Delivery Location (SDL)
    index: 54
    elements:
      id: {index: 55}
      reference: {index: 56}
      type: {index: 57}
      identifier: {index: 58}
      display: {index: 59}
    required: [reference]
  occurrenceDateTime: {type: dateTime, choiceOf: occurrence, index: 50}
  subpotentReason:
    short: Reason + Status for being subpotent
    index: 86
    elements:
      coding:
        index: 87
        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: 88
                elements:
                  id: {index: 89}
                  system: {index: 90}
                  code: {index: 91}
                  display: {index: 92}
                required: [display, system, code]
            doseStatus:
              match: {code: null}
              schema:
                short: Dose Status if overriden
                _required: true
                index: 93
                elements:
                  system: {index: 94}
                  code: {index: 95}
                  display: {index: 96}
                required: [display, system, code]
      text: {index: 97}
    required: [coding]
  occurrence:
    extensions: {}
    elements:
      extension:
        elements:
          value:
            choices: []
            index: 53
  performer:
    elements:
      actor:
        short: Provider who administered the vaccine
        index: 80
        elements:
          reference: {index: 81}
  reasonReference: {index: 84}
package_version: ids-1.0.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: 8}
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]