description: This profile defines a set of constraints to the FHIR Immunization resource for use in Ontario Patient Summaries (PS-ON).  It refines 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-UV-IPS 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.on.patient
derivation: constraint
name: ImmunizationPSON
type: Immunization
elements:
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-patient']
    index: 10
    elements:
      reference: {mustSupport: true, index: 11}
    required: [reference]
  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: 14}
    elements:
      extension:
        type: Extension
        short: occurrence[x] absence reason
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 14
        slicing:
          slices:
            data-absent-reason:
              match: {}
              schema: {type: Extension, short: 'occurrence[x] absence reason', mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 14}
              max: 1
  protocolApplied:
    elements:
      targetDisease:
        type: CodeableConcept
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips'}
        index: 19
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            targetDiseaseGPSCode:
              match: {}
              schema:
                short: Optional slice for representing the code for a disease the vaccination is against from the SNOMED CT GPS code set.
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-gps-uv-ips'}
                index: 20
            targetDiseaseCVC:
              match: {}
              schema:
                short: Optional slice for representing the code for a disease the vaccination is against from the Canadian Vaccine Catalogue code set.
                binding: {strength: preferred, valueSet: 'https://cvc.canimmunize.ca/v3/ValueSet/Disease'}
                mustSupport: true
                index: 21
  meta:
    mustSupport: true
    index: 1
    elements:
      profile: {mustSupport: true, index: 2}
    required: [profile]
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite'}
    mustSupport: true
    index: 16
  vaccineCode:
    short: |-
      Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.

      The 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.

      Other 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.
    type: CodeableConcept
    mustSupport: true
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips'}
    index: 4
    slicing:
      rules: open
      description: Discriminated by bound value set
      discriminator:
      - {path: $this, type: pattern}
      min: 1
      max: 1
      slices:
        vaccineGPSCode:
          match: {}
          schema:
            short: Optional slice for representing the code for vaccine from the SNOMED CT GPS code set
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-gps-uv-ips'}
            index: 5
          min: 0
          max: 1
        atcClass:
          match: {}
          schema:
            short: Optional slice for representing the vaccine code from the WHO ATC classification
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips'}
            index: 6
          min: 0
          max: 1
        Generic:
          match: {}
          schema:
            binding: {strength: preferred, valueSet: 'https://cvc.canimmunize.ca/v3/ValueSet/Generic'}
            mustSupport: true
            index: 7
          max: 1
        Tradename:
          match: {}
          schema:
            binding: {strength: preferred, valueSet: 'https://cvc.canimmunize.ca/v3/ValueSet/Tradename'}
            mustSupport: true
            index: 8
          max: 1
        absentOrUnknownImmunization:
          match: {}
          schema:
            short: Optional slice for representing the codes for an Absent or Unknown Immunization
            mustSupport: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips'}
            index: 9
          min: 0
          max: 1
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin'}
    mustSupport: true
    index: 17
  status: {mustSupport: true, index: 3}
  id: {index: 0}
  lotNumber: {mustSupport: false, index: 15}
  occurrence:
    mustSupport: true
    choices: []
    index: 13
  performer: {mustSupport: false, index: 18}
package_version: summary-0.0.1-alpha
class: profile
kind: resource
url: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 0.0.1
required: [vaccineCode, occurrence, meta]