description: null
package_name: BC
derivation: constraint
name: Immunization
type: Immunization
elements:
  patient:
    elements:
      id: {index: 55}
      reference: {index: 56}
      type: {index: 57}
      identifier: {index: 58}
      display: {index: 59}
    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: 64}
    elements:
      extension:
        type: Extension
        short: Estimated Flag for Vaccination Date
        url: https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date
        index: 64
        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: 64}
  isSubpotent: {index: 102}
  reportOrigin: {index: 69}
  protocolApplied:
    short: Dose Number or Revised Dose Number
    index: 129
    elements:
      id: {index: 130}
      series: {index: 131}
      authority: {index: 132}
      targetDisease: {index: 133}
      doseNumber:
        choices: [doseNumberString]
        index: 135
      doseNumberString: {type: string, choiceOf: doseNumber, index: 136}
      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: 137}
        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: 137
            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: 137}
                  max: 1
      seriesDoses:
        choices: []
        index: 139
  meta:
    index: 1
    elements:
      id: {index: 2}
      versionId: {index: 3}
      lastUpdated: {index: 4}
      source: {index: 5}
      profile: {index: 6}
      security: {index: 7}
      tag: {index: 8}
    required: [profile]
  site:
    elements:
      id: {index: 78}
      coding:
        elements:
          id: {index: 79}
          system: {index: 80}
          version: {index: 81}
          code: {index: 82}
          userSelected: {index: 83}
      text: {index: 84}
  encounter: {index: 60}
  vaccineCode:
    index: 29
    elements:
      id: {index: 30}
      coding:
        index: 31
        elements:
          id: {index: 32}
        slicing:
          rules: open
          discriminator:
          - {path: code, type: value}
          min: null
          slices:
            AgentNVC:
              match: {code: null}
              schema:
                short: Agent administered
                _required: true
                index: 33
                elements:
                  id: {index: 34}
                  system: {index: 35}
                  version: {index: 36}
                  code: {index: 37}
                  display: {index: 38}
                  userSelected: {index: 39}
                required: [display, system, code]
            AgentPIR:
              match: {code: null}
              schema:
                index: 40
                elements:
                  id: {index: 41}
                  system: {index: 42}
                  version: {index: 43}
                  code: {index: 44}
                  display: {index: 45}
                  userSelected: {index: 46}
                required: [display, system, code]
            Tradename:
              match: {code: null}
              schema:
                short: Tradename administered
                index: 47
                elements:
                  id: {index: 48}
                  system: {index: 49}
                  version: {index: 50}
                  code: {index: 51}
                  display: {index: 52}
                  userSelected: {index: 53}
                required: [system, code]
      text: {index: 54}
  doseQuantity:
    elements:
      id: {index: 92}
      value: {index: 93}
      unit: {index: 94}
      system: {index: 95}
      code: {index: 96}
  implicitRules: {index: 9}
  reasonCode: {index: 100}
  statusReason: {index: 28}
  route:
    elements:
      id: {index: 85}
      coding:
        elements:
          id: {index: 86}
          system: {index: 87}
          version: {index: 88}
          code: {index: 89}
          userSelected: {index: 90}
      text: {index: 91}
  recorded: {index: 67}
  programEligibility: {index: 126}
  note: {index: 99}
  extension:
    type: Extension
    short: Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered
    isModifier: false
    url: http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen
    index: 13
    slicing:
      slices:
        antigenDose:
          match: {}
          schema:
            type: Extension
            short: Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered
            isModifier: false
            url: http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen
            index: 13
            extensions:
              antigenCode:
                url: null
                index: 14
                elements:
                  value[x]:
                    elements:
                      coding:
                        elements:
                          system: {index: 15}
            elements:
              extension:
                index: 14
                slicing:
                  slices:
                    antigenCode:
                      match: {}
                      schema:
                        index: 14
                        elements:
                          value[x]:
                            elements:
                              coding:
                                elements:
                                  system: {index: 15}
  contained: {index: 12}
  primarySource: {index: 68}
  status: {short: completed | entered-in-error |, index: 27}
  language: {index: 10}
  id: {short: PIR Internal Immunization ID, index: 0}
  lotNumber: {index: 77}
  identifier:
    short: PIR internal Immunization Identifier + External Immunization ID from source system(s)
    index: 16
    elements:
      id: {index: 17}
      use: {index: 18}
      type:
        index: 19
        elements:
          id: {index: 20}
          coding: {index: 21}
          text: {index: 22}
        required: [text]
      system: {index: 23}
      value: {index: 24}
      period: {index: 25}
      assigner: {index: 26}
    required: [value, type, system]
  manufacturer: {index: 76}
  education: {index: 125}
  reaction: {index: 128}
  location:
    short: Immunization Service Delivery Location (SDL)
    index: 70
    elements:
      id: {index: 71}
      reference: {index: 72}
      type: {index: 73}
      identifier: {index: 74}
      display: {index: 75}
    required: [reference]
  occurrenceDateTime: {type: dateTime, choiceOf: occurrence, index: 63}
  fundingSource: {index: 127}
  subpotentReason:
    short: Reason + Status for being subpotent
    index: 103
    elements:
      id: {index: 104}
      coding:
        index: 105
        elements:
          id: {index: 106}
          system: {index: 107}
          version: {index: 108}
          userSelected: {index: 109}
        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: 110
                elements:
                  id: {index: 111}
                  system: {index: 112}
                  version: {index: 113}
                  code: {index: 114}
                  display: {index: 115}
                  userSelected: {index: 116}
                required: [display, system, code]
            doseStatus:
              match: {code: null}
              schema:
                short: Dose Status if overriden
                _required: true
                index: 117
                elements:
                  id: {index: 118}
                  system: {index: 119}
                  version: {index: 120}
                  code: {index: 121}
                  display: {index: 122}
                  userSelected: {index: 123}
                required: [display, system, code]
      text: {index: 124}
    required: [coding]
  occurrence:
    extensions: {}
    elements:
      extension:
        elements:
          value:
            choices: []
            index: 66
  performer:
    elements:
      actor:
        short: Provider who administered the vaccine
        index: 97
        elements:
          reference: {index: 98}
  reasonReference: {index: 101}
  text: {index: 11}
package_version: BCY_IDS.01-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
    isModifier: false
    index: 13
    extensions:
      antigenCode:
        url: null
        index: 14
        elements:
          value[x]:
            elements:
              coding:
                elements:
                  system: {index: 15}
    elements:
      extension:
        index: 14
        slicing:
          slices:
            antigenCode:
              match: {}
              schema:
                index: 14
                elements:
                  value[x]:
                    elements:
                      coding:
                        elements:
                          system: {index: 15}
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]