PackagesCanonicalsLogsProblems
    Packages
    ca.infoway.io.psca@1.0.0-pre
    http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps
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.

      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.
    mustSupport: true
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
    index: 1
    elements:
      coding:
        index: 2
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            vaccineSctIpsFreeSet:
              match: {}
              schema:
                short: Optional slice for representing the code for vaccine from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-snomed-ct-ips-free-set'}
                index: 3
            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: 4
            CVCTradename:
              match: {}
              schema:
                short: Optional slice for representing the codes from the Canadian Vaccine Catalogue Tradenames value set.
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Tradename'}
                index: 5
            CVCGeneric:
              match: {}
              schema:
                short: Optional slice for representing the codes from the Canadian Vaccine Catalogue Generic names value set.
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic'}
                index: 6
            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: 7
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps']
    index: 8
    elements:
      reference: {mustSupport: true, index: 9}
    required: [reference]
  occurrence:
    mustSupport: true
    choices: []
    index: 11
  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: 13}
    elements:
      extension:
        index: 12
        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: 13}
              max: 1
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite'}
    index: 14
    elements:
      coding:
        index: 15
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            siteIPS:
              match: {}
              schema:
                short: Optional slice for representing the site of an immunization from the IPS SNOMED CT value set.
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips'}
                index: 16
            siteCVC:
              match: {}
              schema:
                short: Optional slice for representing the site of an immunization from the Canadian Vaccine Catalogue Anatomical Site value set.
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite'}
                index: 17
            HumanSubstanceAdministrationSiteV3:
              match: {}
              schema:
                short: The set of body locations to or through which a drug product may be administered.
                binding: {strength: required, valueSet: 'http://terminology.hl7.org/ValueSet/v3-HumanSubstanceAdministrationSite'}
                index: 18
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin'}
    index: 19
    elements:
      coding:
        index: 20
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            routeEDQM:
              match: {}
              schema:
                short: Optional slice for representing the route of immunization administraction drawn from the EDQM value set.
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration'}
                index: 21
            routeCVC:
              match: {}
              schema:
                short: Optional slice for representing the route of immunization administraction drawn from the Canadian Vaccine Catalogue Route of Administration value set.
                binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin'}
                index: 22
            RouteOfAdministrationV3:
              match: {}
              schema:
                short: The path the administered medication takes to get into the body or into contact with the body.
                binding: {strength: required, valueSet: 'http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration'}
                index: 23
  protocolApplied:
    elements:
      targetDisease:
        binding: {strength: preferred, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease'}
        index: 24
        elements:
          coding:
            index: 25
            slicing:
              rules: open
              description: Discriminated by bound value set
              discriminator:
              - {path: $this, type: pattern}
              min: null
              slices:
                targetDiseasesSctIpsFreeSet:
                  match: {}
                  schema:
                    short: Optional slice for representing the code for a disease the vaccination is against from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
                    binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-snomed-ct-ips-free-set'}
                    index: 26
                targetDiseaseCVC:
                  match: {}
                  schema:
                    short: Optional slice for representing the code for a disease the vaccination is against from the Canadian Vaccine Catalogue Disease value set.
                    binding: {strength: required, valueSet: 'http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease'}
                    index: 27
package_version: 1.0.0-pre
class: profile
kind: resource
url: http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.0.0
required: [vaccineCode, occurrence]