description: This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile.\r\n\r\nIt 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: hl7.fhir.uv.ips
derivation: constraint
name: ImmunizationUvIps
type: Immunization
elements:
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips']
    index: 5
    elements:
      reference: {mustSupport: true, index: 6}
    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: 9}
    elements:
      extension:
        type: Extension
        short: occurrence[x] absence reason
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 9
        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: 9}
              max: 1
  protocolApplied:
    index: 14
    elements:
      targetDisease:
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips'}
        index: 15
        slicing:
          rules: open
          description: Discriminated by bound value set
          discriminator:
          - {path: $this, type: pattern}
          min: null
          slices:
            targetDiseaseGPSCode:
              match: {}
              schema:
                short: Code for a disease the vaccination is against from the SNOMED CT GPS code set.
                mustSupport: true
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-gps-uv-ips'}
                index: 16
              min: 0
              max: 1
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips'}
    index: 10
  vaccineCode:
    short: "Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.\r\n\r\n     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.\r\n\r\n     Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), 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: 1
    slicing:
      rules: open
      description: Discriminated by bound value set
      discriminator:
      - {path: $this, type: pattern}
      min: 1
      max: 1
      slices:
        vaccineGPSCode:
          match: {}
          schema:
            short: Code for vaccine from the SNOMED CT GPS code set
            mustSupport: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-gps-uv-ips'}
            index: 2
          min: 0
          max: 1
        atcClass:
          match: {}
          schema:
            short: WHO ATC classification
            mustSupport: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips'}
            index: 3
          min: 0
          max: 1
        absentOrUnknownImmunization:
          match: {}
          schema:
            short: Absent Unknown Immunization
            mustSupport: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips'}
            index: 4
          min: 0
          max: 1
  route:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration'}
    mustSupport: true
    index: 11
  status: {mustSupport: true, index: 0}
  occurrence:
    mustSupport: true
    choices: []
    index: 8
  performer:
    mustSupport: true
    index: 12
    elements:
      actor: {mustSupport: true, index: 13}
package_version: 1.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.0.0
required: [vaccineCode, occurrence]