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.oh.patient-summary
derivation: constraint
name: ImmunizationPSON
type: Immunization
elements:
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-patient']
    index: 11
    elements:
      reference: {mustSupport: true, index: 12}
    required: [reference]
  occurrence[x]:
    extensions:
      data-absent-reason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', max: 1, short: 'occurrence[x] absence reason', type: Extension, mustSupport: true, index: 16}
    elements:
      extension:
        index: 15
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            data-absent-reason:
              match: {url: null}
              schema: {short: 'occurrence[x] absence reason', type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 16}
              max: 1
  protocolApplied:
    elements:
      targetDisease:
        type: CodeableConcept
        binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease'}
        index: 21
        elements:
          coding:
            type: Coding
            index: 22
            slicing:
              rules: open
              description: Discriminated by bound value set
              discriminator:
              - {path: $this, type: pattern}
              min: null
              slices:
                targetDiseaseIPSCode:
                  match: {}
                  schema:
                    short: Optional slice for representing the code for a disease the vaccination is against the IPS Value Set
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips'}
                    index: 23
                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: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease'}
                    index: 24
  meta:
    mustSupport: true
    index: 1
    elements:
      profile: {mustSupport: true, index: 2}
    required: [profile]
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite'}
    mustSupport: true
    index: 18
  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://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
    index: 4
    elements:
      coding:
        type: Coding
        mustSupport: true
        index: 5
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            vaccineIPSCode:
              match: {}
              schema:
                short: Optional slice for representing the code for vaccine from the SNOMED CT IPS code set
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips'}
                index: 6
              max: 1
            atcClass:
              match: {}
              schema:
                short: Optional slice for representing the vaccine code from the WHO ATC classification
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips'}
                index: 7
            CVCGeneric:
              match: {}
              schema:
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
                mustSupport: true
                index: 8
            CVCTradename:
              match: {}
              schema:
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Tradename'}
                mustSupport: true
                index: 9
            absentOrUnknownImmunization:
              match: {}
              schema:
                short: Optional slice for representing the codes for an Absent or Unknown Immunization
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips'}
                mustSupport: true
                index: 10
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin'}
    mustSupport: true
    index: 19
  status: {mustSupport: true, index: 3}
  id: {index: 0}
  lotNumber: {mustSupport: false, index: 17}
  occurrence:
    mustSupport: true
    choices: []
    index: 14
  performer: {mustSupport: false, index: 20}
package_version: 0.10.0-alpha-1
class: profile
kind: resource
url: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 0.9.1
required: [vaccineCode, occurrence, meta]