AU Base Implementation Guide
4.2.0-preview - Working Australia flag

This page is part of the Australian Base IG (v4.2.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AUBaseImmunisation - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the au-immunization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Immunization
ShortAn immunisation statement in an Australian healthcare context
2. Immunization.statusReason
BindingThe codes SHOULD be taken from Reason Vaccine Not Administered .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
4. Immunization.vaccineCode
6. Immunization.vaccineCode.coding
SlicingThis element introduces a set of slices on Immunization.vaccineCode.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
8. Immunization.vaccineCode.coding:amtVaccineCode
Slice NameamtVaccineCode
ShortAMT Vaccine
Control0..1
BindingThe codes SHOULD be taken from Australian Medicines Terminology Vaccine .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
10. Immunization.vaccineCode.coding:amtVaccineCode.system
Control1..?
Fixed Valuehttp://snomed.info/sct
12. Immunization.vaccineCode.coding:airVaccineCode
Slice NameairVaccineCode
ShortAIR Vaccine
Control0..1
BindingThe codes SHALL be taken from Australian Immunisation Register Vaccine .
(required to https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
14. Immunization.vaccineCode.coding:airVaccineCode.system
Control1..?
Fixed Valuehttps://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
16. Immunization.manufacturer
Definition

Physical vaccine product manufacturer.

18. Immunization.site
BindingThe codes SHOULD be taken from Immunisation Anatomical Site .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
20. Immunization.route
BindingThe codes SHOULD be taken from Immunisation Route of Administration .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
22. Immunization.performer
SlicingThis element introduces a set of slices on Immunization.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ function
24. Immunization.performer.function
BindingUnless not suitable, these codes SHALL be taken from hl7VS-providerRole - AU Extended
(extensible to http://terminology.hl7.org.au/ValueSet/v2-0443-extended
26. Immunization.performer:administeredBy
Slice NameadministeredBy
ShortImmunisation Administered By
Control0..1
28. Immunization.performer:administeredBy.function
ShortAdministering role
Control1..?
Pattern Value{
  "coding" : [{
    "system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
    "code" : "AP"
  }]
}
30. Immunization.performer:administeredBy.actor
ShortAdministering performer
32. Immunization.performer:approvedBy
Slice NameapprovedBy
ShortImmunisation Approved By
Control0..1
34. Immunization.performer:approvedBy.function
ShortApprover role
Control1..?
Pattern Value{
  "coding" : [{
    "system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
    "code" : "OP"
  }]
}
36. Immunization.performer:approvedBy.actor
ShortApprover
38. Immunization.reasonCode
BindingThe codes SHOULD be taken from Reason Vaccine Administered .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
40. Immunization.protocolApplied
42. Immunization.protocolApplied.targetDisease
BindingThe codes SHOULD be taken from Vaccination Target Disease .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1