Usage scenarios

The following are supported usage scenarios for this profile:

• Query for a patient’s immunisations
• Record or update an immunisation record for a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

• IPA-Immunization
• and MAY be conformant to
  • Immunization (IPS) if patient is supported as Immunization.patient.reference
  • US Core Immunization noting that US Core extensibly binds to CVX which is not an AU vaccine terminology

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

• Use the status code: not-done to represent that an immunization was not given.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AUBaseImmunisation

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
identifier	S	0..*	Identifier	Business identifier
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	S	0..1	Coding	AMT Vaccine
coding:airVaccineCode	S	0..1	Coding	AIR Vaccine
patient	S	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	S	1..1	dateTime, string	Vaccine administration date
performer	S	0..*	BackboneElement	Who performed event
function	S	0..1	CodeableConcept	What type of performance was done
actor	S	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
note	S	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted
doseNumber[x]	S	1..1	positiveInt, string	Dose number within series
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	SΣ	0..1	Coding	AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCode	example	VaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCode	required	https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.function	extensible	Pattern: AP
Immunization.performer:approvedBy.function	extensible	Pattern: OP
Immunization.reasonCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.protocolApplied.targetDisease	preferred	https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	SΣ	0..1	Coding	AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred)
route		0..1	CodeableConcept	How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCode	example	VaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCode	required	https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.site	preferred	https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
Immunization.route	preferred	https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.function	extensible	Pattern: AP
Immunization.performer:approvedBy.function	extensible	Pattern: OP
Immunization.reasonCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	preferred	https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

Differential View

This structure is derived from AUBaseImmunisation

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
identifier	S	0..*	Identifier	Business identifier
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	S	0..1	Coding	AMT Vaccine
coding:airVaccineCode	S	0..1	Coding	AIR Vaccine
patient	S	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	S	1..1	dateTime, string	Vaccine administration date
performer	S	0..*	BackboneElement	Who performed event
function	S	0..1	CodeableConcept	What type of performance was done
actor	S	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
note	S	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted
doseNumber[x]	S	1..1	positiveInt, string	Dose number within series
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	SΣ	0..1	Coding	AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCode	example	VaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCode	required	https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.function	extensible	Pattern: AP
Immunization.performer:approvedBy.function	extensible	Pattern: OP
Immunization.reasonCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.protocolApplied.targetDisease	preferred	https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:amtVaccineCode	SΣ	0..1	Coding	AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (preferred)
route		0..1	CodeableConcept	How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred)
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred)
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3
Immunization.vaccineCode	example	VaccineAdministeredValueSet
Immunization.vaccineCode.coding:amtVaccineCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1
Immunization.vaccineCode.coding:airVaccineCode	required	https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.site	preferred	https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1
Immunization.route	preferred	https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended
Immunization.performer:administeredBy.function	extensible	Pattern: AP
Immunization.performer:approvedBy.function	extensible	Pattern: OP
Immunization.reasonCode	preferred	https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	preferred	https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1

This structure is derived from AUBaseImmunisation

Summary

Must-Support: 19 elements

Structures

This structure refers to these other structures:

• AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
• AU Core Encounter (http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter)
• AU Core Practitioner (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner)
• AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
• AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number

Slices

This structure defines the following Slices:

• The element Immunization.vaccineCode.coding is sliced based on the value of value:system

Maturity: 0

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching using the patient search parameter:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/Immunization?patient={Type/}[id] or optionallyGET [base]/Immunization?patient.identifier=[system|][code]

   Example:

   1. GET [base]/Immunization?patient=5678
   2. GET [base]/Immunization?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
   3. GET [base]/Immunization?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient (how to search by reference and how to search by token)

2. SHALL support searching using the combination of the patient and status search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/Immunization?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

   Example:

   1. GET [base]/Immunization?patient=5678&status=not-done

   Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and status (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the combination of the patient and date search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
   • SHALL support these date comparators: gt,lt,ge,le
   • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/Immunization?patient={Type/}[id]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/Immunization?patient=5678&date=ge2020-01-01T00:00:00Z
   2. GET [base]/Immunization?patient.identifier=http://example.org/fhir/mrn|12345&date=ge2020-01-01T00:00:00Z

   Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and date. (how to search by reference and how to search by date)

2. SHOULD support searching using the combination of the patient and vaccine-code search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
   • SHOULD support multipleOr search on vaccine-code (e.g.vaccine-code={system|}[code],{system|}[code],...)

   GET [base]/Immunization?patient={Type/}[id]&vaccine-code={system|}[code]{,{system|}[code],...}

   Example:

   1. GET [base]/Immunization?patient=5678&vaccine-code=https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats|COMIRN,http://snomed.info/sct|1525011000168107
   2. GET [base]/Immunization?patient.identifier=http://example.org/fhir/mrn|12345&vaccine-code=https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats|COMIRN,http://snomed.info/sct|1525011000168107

   Implementation Notes: Fetches a bundle of all Immunization resources for the specified patient and immunization code(s). SHOULD support search by multiple codes. (how to search by reference and how to search by token)