My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: ADHA Record of Immunisation from Australian Immunisation Register

The purpose of this profile is to represent a record of an immunisation event held by the Australian Immunisation Register for the electronic exchange of digital health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

Usage:

• Examples for this Resource Profile: Immunization/air-covid-01, Immunization/air-covid-02, Immunization/air-covid-03, Immunization/air-dip-01... Show 9 more, Immunization/air-dip-02, Immunization/air-dip-03, Immunization/air-dip-04, Immunization/air-dip-05, Immunization/air-hepb-01, Immunization/air-infl-01, Immunization/air-infl-02, Immunization/air-infl-03 and Immunization/mds

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

This structure is derived from ADHAImmunizationCore

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
identifier		1..*	Identifier	Business identifier
status		1..1	code	completed | entered-in-error | not-done Fixed Value: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered
coding		1..*	Coding	Code defined by a terminology system
occurrence[x]		1..1	dateTime	Vaccine administration date
primarySource	S	1..1	boolean	Indicates context the data was recorded in Fixed Value: true
lotNumber	S	0..1	string	Batch number
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
targetDisease		1..*	CodeableConcept	Antigen
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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	1..*	Identifier	Business identifier
status	?!SOΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SOΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example) Additional Bindings Purpose Australian Medicines Terminology Vaccine Preferred Australian Immunisation Register Vaccine Preferred Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding:airVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣC	1..1	Reference(ADHA Core Patient)	Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter	S	0..1	Reference(ADHA Core Encounter)	Encounter immunization was part of
occurrence[x]	SOΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
primarySource	SOΣ	1..1	boolean	Indicates context the data was recorded in Fixed Value: true Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
lotNumber	S	0..1	string	Batch number
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ΣC	1..1	Reference(ADHA Authoring PractitionerRole | ADHA Core Organization)	Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present
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	SOΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	1..*	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	1..*	CodeableConcept	Antigen Binding: Vaccination Target Disease (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet Additional Bindings Purpose Documentation Australian Medicines Terminology Vaccine Preferred This value set is for use when AMT (Australian Medicines Terminology) codes are preferred. Australian Immunisation Register Vaccine Preferred This value set is for use when AIR (Australian Immunisation Register) codes are preferred. http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode	required	AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode	required	AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats) https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern: OP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.protocolApplied.targetDisease	preferred	VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 from https://tx.ontoserver.csiro.au/fhir

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
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	1..*	Identifier	Business identifier
status	?!SOΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SOΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example) Additional Bindings Purpose Australian Medicines Terminology Vaccine Preferred Australian Immunisation Register Vaccine Preferred Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding:airVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text	Σ	0..1	string	Plain text representation of the concept
patient	SOΣC	1..1	Reference(ADHA Core Patient)	Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter	S	0..1	Reference(ADHA Core Encounter)	Encounter immunization was part of
occurrence[x]	SOΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SOΣ	1..1	boolean	Indicates context the data was recorded in Fixed Value: true Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	S	0..1	string	Batch number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (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ΣC	1..1	Reference(ADHA Authoring PractitionerRole | ADHA Core Organization)	Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present
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	SOΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (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 imm-1: One of documentType or reference SHALL be present
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	1..*	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	1..*	CodeableConcept	Antigen Binding: Vaccination Target Disease (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	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet Additional Bindings Purpose Documentation Australian Medicines Terminology Vaccine Preferred This value set is for use when AMT (Australian Medicines Terminology) codes are preferred. Australian Immunisation Register Vaccine Preferred This value set is for use when AIR (Australian Immunisation Register) codes are preferred. http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode	required	AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode	required	AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats) https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.route	preferred	ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern: OP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 from https://tx.ontoserver.csiro.au/fhir

This structure is derived from ADHAImmunizationCore

Summary

Mandatory: 5 elements
Must-Support: 2 elements
Fixed: 2 elements

Differential View

This structure is derived from ADHAImmunizationCore

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
identifier		1..*	Identifier	Business identifier
status		1..1	code	completed | entered-in-error | not-done Fixed Value: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered
coding		1..*	Coding	Code defined by a terminology system
occurrence[x]		1..1	dateTime	Vaccine administration date
primarySource	S	1..1	boolean	Indicates context the data was recorded in Fixed Value: true
lotNumber	S	0..1	string	Batch number
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
targetDisease		1..*	CodeableConcept	Antigen
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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	1..*	Identifier	Business identifier
status	?!SOΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SOΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example) Additional Bindings Purpose Australian Medicines Terminology Vaccine Preferred Australian Immunisation Register Vaccine Preferred Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding:airVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
patient	SOΣC	1..1	Reference(ADHA Core Patient)	Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter	S	0..1	Reference(ADHA Core Encounter)	Encounter immunization was part of
occurrence[x]	SOΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
primarySource	SOΣ	1..1	boolean	Indicates context the data was recorded in Fixed Value: true Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
lotNumber	S	0..1	string	Batch number
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ΣC	1..1	Reference(ADHA Authoring PractitionerRole | ADHA Core Organization)	Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present
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	SOΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	1..*	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	1..*	CodeableConcept	Antigen Binding: Vaccination Target Disease (preferred)
doseNumber[x]	S	1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet Additional Bindings Purpose Documentation Australian Medicines Terminology Vaccine Preferred This value set is for use when AMT (Australian Medicines Terminology) codes are preferred. Australian Immunisation Register Vaccine Preferred This value set is for use when AIR (Australian Immunisation Register) codes are preferred. http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode	required	AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode	required	AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats) https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern: OP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.protocolApplied.targetDisease	preferred	VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 from https://tx.ontoserver.csiro.au/fhir

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ADHAImmunizationCore	Record of immunisation event held on the Australian Immunisation Register
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	1..*	Identifier	Business identifier
status	?!SOΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SOΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example) Additional Bindings Purpose Australian Medicines Terminology Vaccine Preferred Australian Immunisation Register Vaccine Preferred Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:amtVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Medicines Terminology Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
coding:airVaccineCode	SOΣ	0..1	Coding	Code defined by a terminology system Binding: Australian Immunisation Register Vaccine (required) Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
text	Σ	0..1	string	Plain text representation of the concept
patient	SOΣC	1..1	Reference(ADHA Core Patient)	Who was immunized inv-dh-imm-01: At least reference or a valid identifier shall be present Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
encounter	S	0..1	Reference(ADHA Core Encounter)	Encounter immunization was part of
occurrence[x]	SOΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SOΣ	1..1	boolean	Indicates context the data was recorded in Fixed Value: true Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
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	S	0..1	string	Batch number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Immunisation Anatomical Site (preferred)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (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ΣC	1..1	Reference(ADHA Authoring PractitionerRole | ADHA Core Organization)	Individual or organization who was performing inv-dh-imm-02: At least reference or a valid identifier shall be present
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	SOΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (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 imm-1: One of documentType or reference SHALL be present
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	1..*	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	1..*	CodeableConcept	Antigen Binding: Vaccination Target Disease (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	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-3 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet Additional Bindings Purpose Documentation Australian Medicines Terminology Vaccine Preferred This value set is for use when AMT (Australian Medicines Terminology) codes are preferred. Australian Immunisation Register Vaccine Preferred This value set is for use when AIR (Australian Immunisation Register) codes are preferred. http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:amtVaccineCode	required	AustralianMedicinesTerminologyVaccine https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:airVaccineCode	required	AustralianImmunisationRegisterVaccine (a valid code from https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats) https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	ImmunisationAnatomicalSite https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.route	preferred	ImmunisationRouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern: OP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	ReasonVaccineAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 from https://tx.ontoserver.csiro.au/fhir
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccinationTargetDisease https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 from https://tx.ontoserver.csiro.au/fhir

This structure is derived from ADHAImmunizationCore

Summary

Mandatory: 5 elements
Must-Support: 2 elements
Fixed: 2 elements

Other representations of profile: CSV, Excel, Schematron