Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: Australian Immunisation Register Vaccine (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
coding:helixVaccineCode	Σ	0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
lotNumber		0..1	string	Vaccine Batch Number
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (preferred)
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (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	ImmunizationStatusCodes 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-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard
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.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern Value: AP http://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern Value: 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	https://helix.medicaldirector.com https://helix.medicaldirector.com

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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
Slices for extension				Content/Rules for all slices
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
Slices for identifier		1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
statusReason		0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode
Slices for coding				Content/Rules for all slices
coding:amtVaccineCode		0..0
coding:helixVaccineCode		0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
system		1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
lotNumber		0..1	string	Vaccine Batch Number
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (preferred)
protocolApplied
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.protocolApplied.targetDisease	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: Australian Immunisation Register Vaccine (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:helixVaccineCode	Σ	0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine Batch Number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (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Σ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: 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 Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (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 http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes 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-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard
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.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
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 Value: AP http://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern Value: 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	https://helix.medicaldirector.com https://helix.medicaldirector.com

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()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

• Helix Base Authoring Key (http://medicaldirector.com/helix-base/StructureDefinition/authoring-key)

Extensions

This structure refers to these extensions:

• http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.identifier (Open at End)

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: Australian Immunisation Register Vaccine (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
coding:helixVaccineCode	Σ	0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
lotNumber		0..1	string	Vaccine Batch Number
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (preferred)
Slices for performer	SΣ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by pattern:function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible)
actor	SΣ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: Reason Vaccine Administered (preferred)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (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	ImmunizationStatusCodes 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-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard
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.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.performer.function	extensible	Hl7VSProviderRoleAUExtended http://terminology.hl7.org.au/ValueSet/v2-0443-extended
Immunization.performer:administeredBy.function	extensible	Pattern Value: AP http://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern Value: 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	https://helix.medicaldirector.com https://helix.medicaldirector.com

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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
Slices for extension				Content/Rules for all slices
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
Slices for identifier		1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
statusReason		0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode
Slices for coding				Content/Rules for all slices
coding:amtVaccineCode		0..0
coding:helixVaccineCode		0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
system		1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
lotNumber		0..1	string	Vaccine Batch Number
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (preferred)
protocolApplied
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.statusReason	preferred	ReasonVaccineNotAdministered https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.protocolApplied.targetDisease	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	AUCoreImmunization	An immunisation statement in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:vaccine-serial-number	S	0..1	string	Vaccine vial serial number URL: http://hl7.org.au/fhir/StructureDefinition/vaccine-serial-number
extension:ConsentProvidedBy		0..1	string	Helix AU Core Immunisation Consent Provided By URL: http://helix.medicaldirector.com/Immunization/extension/ConsentProvidedBy
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Open At End by value:system
identifier:authoring-key	S	1..1	HelixBaseAuthoringKey	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: Reason Vaccine Not Administered (preferred)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:airVaccineCode	SΣ	0..1	Coding	AIR Vaccine Binding: Australian Immunisation Register Vaccine (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:helixVaccineCode	Σ	0..1	Coding	Helix Vaccine Binding: https://helix.medicaldirector.com (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://helix.medicaldirector.com
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(AU Core Patient)	Who was immunized
encounter	S	0..1	Reference(AU Core Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine Batch Number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: https://helix.medicaldirector.com (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Σ	1..1	Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)	Individual or organization who was performing
performer:administeredBy	Σ	0..1	BackboneElement	Immunisation Administered By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Administering performer
performer:approvedBy	Σ	0..1	BackboneElement	Immunisation Approved By
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	1..1	CodeableConcept	Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: OP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Approver
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: 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 Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied	S	0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://helix.medicaldirector.com (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 http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes 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-1 From https://tx.ontoserver.csiro.au/fhir
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard
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.vaccineCode.coding:helixVaccineCode	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard
Immunization.site	preferred	https://helix.medicaldirector.com https://helix.medicaldirector.com
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 Value: AP http://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard
Immunization.performer:approvedBy.function	extensible	Pattern Value: 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	https://helix.medicaldirector.com https://helix.medicaldirector.com

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()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()