description: This profile defines an immunisation structure including core localisation concepts for use in an Australian context.
package_name: rs/hl7.fhir.au.base
derivation: constraint
name: AUBaseImmunisation
type: Immunization
elements:
  vaccineCode:
    short: Vaccine product for administration
    index: 0
    elements:
      coding:
        index: 1
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            amtVaccineCode:
              match: {system: null}
              schema: {short: AMT Vaccine, index: 2}
              max: 1
            airVaccineCode:
              match: {system: null}
              schema: {short: AIR Vaccine, index: 3}
              max: 1
  patient: {short: Patient immunised, index: 4}
  manufacturer: {short: Vaccine product manufacturer, index: 5}
  site:
    short: Body site vaccine was administered
    index: 6
    elements:
      coding: {index: 7}
  route:
    short: Route of vaccination
    index: 8
    elements:
      coding:
        index: 9
        slicing:
          rules: open
          discriminator:
          - {path: system, type: value}
          min: null
          slices:
            snomedRoute:
              match: {system: null}
              schema: {short: Immunisation Route of Administration (SNOMED CT), index: 10}
              max: 1
  practitioner:
    short: Immunisation performer(s)
    index: 11
    slicing:
      rules: open
      discriminator:
      - {path: role.coding, type: value}
      min: null
      slices:
        administeredBy:
          match:
            role:
              coding: {code: AP, system: 'http://hl7.org/fhir/v2/0443', display: Administering Provider}
          schema:
            short: Immunisation Administered By
            index: 12
            elements:
              role:
                short: Administering role
                index: 13
                elements:
                  coding:
                    pattern:
                      type: Coding
                      value: {code: AP, system: 'http://hl7.org/fhir/v2/0443', display: Administering Provider}
                    type: Coding
                    index: 14
                  text:
                    pattern: {type: string, value: Administering Provider}
                    type: string
                    index: 15
                required: [coding, text]
              actor: {short: Administering practitioner, index: 16}
            required: [role]
        approvedBy:
          match:
            role:
              coding: {code: OP, system: 'http://hl7.org/fhir/v2/0443', display: Ordering Provider}
          schema:
            short: Immunisation Approved By
            index: 17
            elements:
              role:
                short: Approver role
                index: 18
                elements:
                  coding:
                    pattern:
                      type: Coding
                      value: {code: OP, system: 'http://hl7.org/fhir/v2/0443', display: Ordering Provider}
                    type: Coding
                    index: 19
                  text:
                    pattern: {type: string, value: Ordering Provider}
                    type: string
                    index: 20
                required: [coding, text]
              actor: {short: Approving practitioner, index: 21}
            required: [role]
  explanation:
    short: Explanation for (non)vaccination
    index: 22
    elements:
      reason:
        short: Reason vaccine administered
        index: 23
        elements:
          coding:
            index: 24
            slicing:
              rules: open
              discriminator:
              - {path: system, type: value}
              min: null
              slices:
                snomedReason:
                  match: {system: null}
                  schema: {short: Reason Vaccine Administered (SNOMED CT), index: 25}
                  max: 1
      reasonNotGiven:
        short: Reason immunisation did not occur
        index: 26
        elements:
          coding:
            index: 27
            slicing:
              rules: open
              discriminator:
              - {path: system, type: value}
              min: null
              slices:
                snomedReasonCode:
                  match: {system: null}
                  schema: {short: Coded Reason (SNOMED CT), index: 28}
  vaccinationProtocol:
    short: Vaccination protocol
    index: 29
    elements:
      targetDisease:
        short: Vaccine disease target
        index: 30
        elements:
          coding:
            index: 31
            slicing:
              rules: open
              discriminator:
              - {path: system, type: value}
              min: null
              slices:
                snomedTargetDisease:
                  match: {system: null}
                  schema: {short: Vaccination Target Disease (SNOMED CT), index: 32}
                  max: 1
                targetDiseaseNoInformation:
                  match: {system: null}
                  schema:
                    short: No Information for Target Disease
                    pattern:
                      type: Coding
                      value: {code: NI, system: 'http://hl7.org/fhir/v3/NullFlavor', display: NoInformation}
                    type: Coding
                    index: 33
                  max: 1
      doseStatus:
        short: Vaccine relation to protocol
        index: 34
        elements:
          coding:
            index: 35
            slicing:
              rules: open
              discriminator:
              - {path: coding, type: value}
              min: null
              slices:
                doseStatusNotAvailable:
                  match: {coding: null}
                  schema:
                    short: Dose Status Not Available
                    pattern:
                      type: Coding
                      value: {code: NAVU, system: 'http://hl7.org/fhir/v3/NullFlavor', display: Not available}
                    type: Coding
                    index: 36
                  max: 1
package_version: 1.0.2
class: profile
kind: resource
url: http://hl7.org.au/fhir/StructureDefinition/au-immunization
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.0.1