description: This profile represents the constraints applied to the Immunization resource by the PS-CA project to represent a record of immunization in the patient summary. It is informed by the constraints of the [Immunization IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Immunization-uv-ips.html) and the [Canadian Baseline  Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-immunization.html) to allow for cross-border and cross-jurisdiction sharing of Medication Summary information. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.
package_name: ca.infoway.io.psca
derivation: constraint
name: ImmunizationPSCA
type: Immunization
elements:
  status: {mustSupport: true, index: 0}
  vaccineCode:
    short: "Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent/unknown code.\n\nOther coded information can be provided as well as: the Pharmaceutical and medicinal product identifiers, when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.\r\n\r\nThe IPS-UV vaccine concepts are not used in Canadian implementations as they do not include Canadian trade or brand names. Implementers should use the following pan-Canadian value sets, depending on context: \"VaccineHistoricalNameCode\", \"PassiveAdministeredImmunizingAgentCode\", and \"PassiveHistoricalImmunizingAgentCode\", which are equivalently preferred alongside the primary binding."
    binding: {strength: preferred, valueSet: 'https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode'}
    mustSupport: true
    index: 1
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps']
    index: 2
    elements:
      reference: {mustSupport: true, index: 3}
    required: [reference]
  occurrence:
    mustSupport: true
    choices: []
    index: 5
  occurrence[x]:
    extensions:
      data-absent-reason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', max: 1, type: Extension, short: 'occurrence[x] absence reason', mustSupport: true, index: 7}
    elements:
      extension:
        index: 6
        slicing:
          rules: open
          description: Extensions are always sliced by (at least) url
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            data-absent-reason:
              match: {url: null}
              schema: {type: Extension, short: 'occurrence[x] absence reason', mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 7}
              max: 1
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode'}
    index: 8
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode'}
    index: 9
  protocolApplied:
    elements:
      targetDisease:
        binding: {strength: preferred, valueSet: 'https://fhir.infoway-inforoute.ca/ValueSet/vaccinepreventablediseasecode'}
        index: 10
package_version: 2.1.0-DFT
class: profile
kind: resource
url: http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: null
required: [occurrence]