Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required) ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required) ele-1: All FHIR elements must have a @value or children
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. ele-1: All FHIR elements must have a @value or children
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:mtVaccineCode	Σ	0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
code	SΣ	1..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient)	Who was immunized ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
display	Σ	0..1	string	External Name of Patient ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrence[x]:occurrenceDateTime	SΣ	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children
recorded	S	0..1	dateTime	When the immunization was first captured in the subject's record ele-1: All FHIR elements must have a @value or children
lotNumber	S	1..1	string	Vaccine lot number ele-1: All FHIR elements must have a @value or children
expirationDate	S	0..1	date	Vaccine expiration date ele-1: All FHIR elements must have a @value or children
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required) ele-1: All FHIR elements must have a @value or children
Slices for performer	SΣ	2..2	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeredBy	Σ	1..1	BackboneElement	Immunisation Administered By ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer ele-1: All FHIR elements must have a @value or children
performer:approvedBy	Σ	1..1	BackboneElement	Immunisation Approved By ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver ele-1: All FHIR elements must have a @value or children
note	SΣ	0..*	Annotation	Additional immunization notes ele-1: All FHIR elements must have a @value or children
protocolApplied		0..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
meta
lastUpdated	S	0..1	instant	When the resource version last changed
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
identifier		0..0
status		1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required)
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
Slices for coding				Content/Rules for all slices
coding:amtVaccineCode		0..0
coding:airVaccineCode		0..0
coding:mtVaccineCode		0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred)
system	S	1..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
patient	S	1..1	Reference(Patient)	Who was immunized
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
display		0..1	string	External Name of Patient
Slices for occurrence[x]		1..1	dateTime	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	S	1..1	dateTime	Vaccine administration date
recorded	S	0..1	dateTime	When the immunization was first captured in the subject's record
lotNumber	S	1..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required)
doseQuantity		0..0
performer	S	2..2	BackboneElement	Who performed event
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
Slices for performer				Content/Rules for all slices
performer:administeredBy		1..1	BackboneElement	Immunisation Administered By
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy		1..1	BackboneElement	Immunisation Approved By
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	S	0..*	Annotation	Additional immunization notes
reasonCode		0..0
reasonReference		0..0
isSubpotent		0..0
subpotentReason		0..0
education		0..0
programEligibility		0..0
reaction		0..0
protocolApplied
Slices for doseNumber[x]		1..1	positiveInt, string	Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required)
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:mtVaccineCode	Σ	0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (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	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	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(Patient)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	External Name of Patient
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	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	S	1..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required)
Slices for performer	SΣ	2..2	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	Σ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeredBy	Σ	1..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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	1..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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
protocolApplied		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		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred)
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG
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.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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 14 elements

Extensions

This structure refers to these extensions:

• http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.occurrence[x]
• The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required) ele-1: All FHIR elements must have a @value or children
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required) ele-1: All FHIR elements must have a @value or children
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. ele-1: All FHIR elements must have a @value or children
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:mtVaccineCode	Σ	0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred) ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
code	SΣ	1..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
display	SΣ	0..1	string	Representation defined by the system ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient)	Who was immunized ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
display	Σ	0..1	string	External Name of Patient ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrence[x]:occurrenceDateTime	SΣ	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children
recorded	S	0..1	dateTime	When the immunization was first captured in the subject's record ele-1: All FHIR elements must have a @value or children
lotNumber	S	1..1	string	Vaccine lot number ele-1: All FHIR elements must have a @value or children
expirationDate	S	0..1	date	Vaccine expiration date ele-1: All FHIR elements must have a @value or children
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required) ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required) ele-1: All FHIR elements must have a @value or children
Slices for performer	SΣ	2..2	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function ele-1: All FHIR elements must have a @value or children
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeredBy	Σ	1..1	BackboneElement	Immunisation Administered By ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer ele-1: All FHIR elements must have a @value or children
performer:approvedBy	Σ	1..1	BackboneElement	Immunisation Approved By ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver ele-1: All FHIR elements must have a @value or children
note	SΣ	0..*	Annotation	Additional immunization notes ele-1: All FHIR elements must have a @value or children
protocolApplied		0..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
meta
lastUpdated	S	0..1	instant	When the resource version last changed
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
identifier		0..0
status		1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required)
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
Slices for coding				Content/Rules for all slices
coding:amtVaccineCode		0..0
coding:airVaccineCode		0..0
coding:mtVaccineCode		0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (preferred)
system	S	1..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
patient	S	1..1	Reference(Patient)	Who was immunized
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
display		0..1	string	External Name of Patient
Slices for occurrence[x]		1..1	dateTime	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	S	1..1	dateTime	Vaccine administration date
recorded	S	0..1	dateTime	When the immunization was first captured in the subject's record
lotNumber	S	1..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required)
doseQuantity		0..0
performer	S	2..2	BackboneElement	Who performed event
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
Slices for performer				Content/Rules for all slices
performer:administeredBy		1..1	BackboneElement	Immunisation Administered By
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy		1..1	BackboneElement	Immunisation Approved By
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	S	0..*	Annotation	Additional immunization notes
reasonCode		0..0
reasonReference		0..0
isSubpotent		0..0
subpotentReason		0..0
education		0..0
programEligibility		0..0
reaction		0..0
protocolApplied
Slices for doseNumber[x]		1..1	positiveInt, string	Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	AUBaseImmunisation	An immunisation statement in an Australian healthcare context status-reason-validation: Status reason must be provided if status is 'not-done' note-validation: Note must not exceed 4096 characters
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
vaccineSerialNumber	S	1..1	string	Vaccine vial serial number URL: http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: Status for Immunisation (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (required)
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:mtVaccineCode	Σ	0..1	Coding	Code defined by a terminology system Binding: Immunisation Vaccine Value Set (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	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/vaccine-code
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	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(Patient)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	External Name of Patient
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	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	S	1..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: Codes for Immunization Site of Administration (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: Immunisation Route of Administration (required)
Slices for performer	SΣ	2..2	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	Σ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeredBy	Σ	1..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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	1..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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
protocolApplied		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		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccination Target Disease (preferred)
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
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.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Immunization.status	required	ImmunisationStatus https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-status from this IG
Immunization.statusReason	required	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:mtVaccineCode	preferred	VaccineCodeVS (a valid code from Immunisation Vaccine Codes) https://alexapi.medtechglobal.com.au/fhir/ValueSet/vaccine-code-vs from this IG
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	required	ImmunisationSite https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunisation-site from this IG
Immunization.route	required	ImmunisationRouteCodes https://alexapi.medtechglobal.com.au/fhir/ValueSet/immunization-route from this IG
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.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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
note-validation	error	Immunization	Note must not exceed 4096 characters : note.text.empty() or note.text.length() <= 4096
status-reason-validation	error	Immunization	Status reason must be provided if status is 'not-done' : status = 'completed' or (status = 'not-done' and statusReason.empty().not())