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: 12
    elements:
      reference: {mustSupport: true, index: 13}
    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: 16}
    elements:
      extension:
        type: Extension
        short: occurrence[x] absence reason
        mustSupport: true
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 16
        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: 16}
              max: 1
  reportOrigin: {mustSupport: true, index: 19}
  meta:
    mustSupport: true
    index: 1
    elements:
      profile:
        mustSupport: true
        pattern: {type: Canonical, value: 'http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips'}
        index: 2
  site:
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips'}
    mustSupport: true
    index: 20
  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 AC codes; or any other kind of code that that identifies, classifies or cluster the administered product."
    index: 4
    slicing:
      rules: open
      description: Discriminated by code system
      discriminator:
      - {path: coding.system, type: value}
      min: 1
      max: 1
      slices:
        absentOrUnknownImmunization:
          match:
            coding: {system: 'http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips'}
          schema:
            short: Absent Unknown Immunization
            type: CodeableConcept
            mustSupport: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips'}
            index: 8
            elements:
              coding:
                mustSupport: true
                index: 9
                elements:
                  system:
                    pattern: {type: Uri, value: 'http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips'}
                    mustSupport: true
                    index: 10
                required: [system]
              text: {mustSupport: true, index: 11}
            required: [coding]
    type: CodeableConcept
    mustSupport: true
    elements:
      coding:
        mustSupport: true
        index: 5
        slicing:
          rules: open
          description: Discriminated by code system
          discriminator:
          - {path: system, type: value}
          min: 1
          slices:
            atcClass:
              match: {system: 'http://www.whocc.no/atc'}
              schema:
                short: WHO ATC classification
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips'}
                mustSupport: true
                index: 6
                elements:
                  system:
                    pattern: {type: Uri, value: 'http://www.whocc.no/atc'}
                    mustSupport: true
                    index: 7
                required: [system]
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips'}
    required: [coding]
  route:
    type: CodeableConcept
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration'}
    mustSupport: true
    index: 21
  recorded: {mustSupport: true, index: 17}
  primarySource: {mustSupport: true, index: 18}
  status: {mustSupport: true, index: 3}
  id: {mustSupport: true, index: 0}
  occurrence:
    mustSupport: true
    choices: []
    index: 15
  performer:
    mustSupport: true
    index: 22
    elements:
      actor:
        mustSupport: true
        index: 23
        elements:
          reference: {mustSupport: true, index: 24}
package_version: 0.3.0
class: profile
kind: resource
url: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 0.3.0
required: [vaccineCode, occurrence]