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
derivation: constraint
name: ImmunizationPSON
type: Immunization
elements:
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-patient']
    index: 16
    elements:
      reference: {mustSupport: true, index: 17}
    required: [reference]
  occurrence[x]:
    extensions:
      data-absent-reason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', type: Extension, short: 'occurrence[x] absence reason', mustSupport: true, index: 23}
    elements:
      extension:
        index: 22
        slicing:
          rules: open
          ordered: false
          min: null
          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: 23}
  protocolApplied:
    mustSupport: true
    index: 31
    elements:
      targetDisease:
        type: CodeableConcept
        binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease'}
        mustSupport: true
        index: 32
        elements:
          coding:
            index: 33
            elements:
              display:
                extensions:
                  translation:
                    url: null
                    index: 34
                    extensions: {}
                    elements:
                      extension: {array: true, min: 2, index: 35}
                elements:
                  extension:
                    index: 34
                    slicing:
                      slices:
                        translation:
                          match: {}
                          schema:
                            index: 34
                            extensions: {}
                            elements:
                              extension: {array: true, min: 2, index: 35}
            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: 36
                    elements:
                      display:
                        extensions:
                          translation:
                            url: null
                            index: 37
                            extensions: {}
                            elements:
                              extension: {array: true, min: 2, index: 38}
                        elements:
                          extension:
                            index: 37
                            slicing:
                              slices:
                                translation:
                                  match: {}
                                  schema:
                                    index: 37
                                    extensions: {}
                                    elements:
                                      extension: {array: true, min: 2, index: 38}
                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: 39
                    elements:
                      display:
                        extensions:
                          translation:
                            url: null
                            index: 40
                            extensions: {}
                            elements:
                              extension: {array: true, min: 2, index: 41}
                        elements:
                          extension:
                            index: 40
                            slicing:
                              slices:
                                translation:
                                  match: {}
                                  schema:
                                    index: 40
                                    extensions: {}
                                    elements:
                                      extension: {array: true, min: 2, index: 41}
  meta:
    mustSupport: true
    index: 0
    elements:
      profile: {mustSupport: true, index: 1}
    required: [profile]
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite'}
    mustSupport: true
    index: 24
    elements:
      coding:
        elements:
          display:
            extensions:
              translation:
                url: null
                index: 25
                extensions: {}
                elements:
                  extension: {array: true, min: 2, index: 26}
            elements:
              extension:
                index: 25
                slicing:
                  slices:
                    translation:
                      match: {}
                      schema:
                        index: 25
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 26}
  vaccineCode:
    type: CodeableConcept
    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.
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
    mustSupport: true
    index: 3
    elements:
      coding:
        index: 4
        elements:
          display:
            extensions:
              translation:
                url: null
                index: 5
                extensions: {}
                elements:
                  extension: {array: true, min: 2, index: 6}
            elements:
              extension:
                index: 5
                slicing:
                  slices:
                    translation:
                      match: {}
                      schema:
                        index: 5
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 6}
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            CVCGeneric:
              match: {}
              schema:
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
                index: 7
                elements:
                  display:
                    extensions:
                      translation:
                        url: null
                        index: 8
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 9}
                    elements:
                      extension:
                        index: 8
                        slicing:
                          slices:
                            translation:
                              match: {}
                              schema:
                                index: 8
                                extensions: {}
                                elements:
                                  extension: {array: true, min: 2, index: 9}
            CVCTradename:
              match: {}
              schema:
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Tradename'}
                index: 10
                elements:
                  display:
                    extensions:
                      translation:
                        url: null
                        index: 11
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 12}
                    elements:
                      extension:
                        index: 11
                        slicing:
                          slices:
                            translation:
                              match: {}
                              schema:
                                index: 11
                                extensions: {}
                                elements:
                                  extension: {array: true, min: 2, index: 12}
            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'}
                index: 13
                elements:
                  display:
                    extensions:
                      translation:
                        url: null
                        index: 14
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 15}
                    elements:
                      extension:
                        index: 14
                        slicing:
                          slices:
                            translation:
                              match: {}
                              schema:
                                index: 14
                                extensions: {}
                                elements:
                                  extension: {array: true, min: 2, index: 15}
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin'}
    index: 27
    elements:
      coding:
        elements:
          display:
            extensions:
              translation:
                url: null
                index: 28
                extensions: {}
                elements:
                  extension: {array: true, min: 2, index: 29}
            elements:
              extension:
                index: 28
                slicing:
                  slices:
                    translation:
                      match: {}
                      schema:
                        index: 28
                        extensions: {}
                        elements:
                          extension: {array: true, min: 2, index: 29}
  status: {mustSupport: true, index: 2}
  occurrenceString: {type: string, mustSupport: true, choiceOf: occurrence, index: 21}
  occurrenceDateTime: {type: dateTime, mustSupport: true, choiceOf: occurrence, index: 20}
  occurrence:
    mustSupport: true
    choices: [occurrenceDateTime, occurrenceString]
    index: 19
  performer: {index: 30}
package_version: setp-1.0.39
class: profile
kind: resource
url: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 0.10.0
required: [meta]