NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: SDHRImmunization

Immunization resource for the Shared Digital Health Record. This profile constrains AIR Immunization content to the subset required for direct clinical care.

Usages:

• CapabilityStatements using this Profile: NZ Shared Digital Health Record API
• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1
Immunization.id	Σ This element is included in summaries.	1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:administeredProduct		0..1	CodeableConcept	AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required)
Immunization.Slices for extension.extension:AgeGiven		0..1	(Complex)	AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status Binding: AIR Status Reason Code (preferred)
Immunization.statusReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: AIR Vaccine Product (preferred)
Immunization.vaccineCode.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode.coding.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Immunization.vaccineCode.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1	dateTime	Vaccine administration date
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.display	Σ This element is included in summaries.	0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered Binding: AIR Body Site (preferred)
Immunization.site.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered Binding: AIR Route of Administration (preferred)
Immunization.route.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred)
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied		0..1	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	preferred	AIR Status Reason Code	⏿2.0.0	nzhts.digital.health.nz
Immunization.vaccineCode	Base	preferred	AIR Vaccine Product	⏿2.0.1	nzhts.digital.health.nz
Immunization.site	Base	preferred	AIR Body Site	⏿2.0.0	nzhts.digital.health.nz
Immunization.route	Base	preferred	AIR Route of Administration	⏿2.0.0	nzhts.digital.health.nz
Immunization.reasonCode	Base	preferred	AIR Indication Code	⏿2.0.1	nzhts.digital.health.nz
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
air-resched-1	error	Immunization	Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.	extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
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()
nz-performer-function-1	error	Immunization	If the performer function has a system, then it must have a code.	performer.function.coding.system.exists() implies performer.function.coding.code.exists()
nz-performer-function-2	error	Immunization	If the performer function has a code, then it must have a system.	performer.function.coding.code.exists() implies performer.function.coding.system.exists()
nz-reasonCode-1	error	Immunization	If the reasonCode aka indication has a system, then it must have a code.	reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
nz-reasonCode-2	error	Immunization	If the reasonCode aka indication has a code, then it must have a system.	reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
nz-route-1	error	Immunization	If the route of admin has a system, then it must have a code.	route.coding.system.exists() implies route.coding.code.exists()
nz-route-2	error	Immunization	if the route of admin has a code, then it must have a system.	route.coding.code.exists() implies route.coding.system.exists()
nz-site-1	error	Immunization	If the body site has a system, then it must have a code.	site.coding.system.exists() implies site.coding.code.exists()
nz-site-2	error	Immunization	If the body site has a code, then it must have a system.	site.coding.code.exists() implies site.coding.system.exists()
nz-status-reason-1	error	Immunization	If the status reason has a system, then it must have a code.	statusReason.coding.system.exists() implies statusReason.coding.code.exists()
nz-status-reason-2	error	Immunization	If the status reason has a code, then it must have a system.	statusReason.coding.code.exists() implies statusReason.coding.system.exists()
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

This structure is derived from AIRImmunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: sdhr-imm-status-1
Immunization.id		1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.meta
Immunization.meta.id		0..0		Unique id for inter-element referencing
Immunization.meta.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.meta.Slices for extension.extension:DataQualityAssessment		0..0		Data Quality Assessment
Immunization.meta.Slices for extension.extension:PlannedEventMatch		0..0		Planned Event Match
Immunization.meta.Slices for extension.extension:PlannedEventMatchQuality		0..0		Planned Event Match Quality
Immunization.meta.Slices for extension.extension:CreatedBy		0..0		AIR Created By User
Immunization.meta.Slices for extension.extension:ModifiedBy		0..0		AIR Modified By User
Immunization.meta.source		0..0		Identifies where the resource comes from
Immunization.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Immunization.meta.tag		0..0		Tags applied to this resource
Immunization.implicitRules		0..0		A set of rules under which this content was created
Immunization.language		0..0		Language of the resource content
Immunization.text		0..0		Text summary of the resource, for human interpretation
Immunization.contained		0..0		Contained, inline Resources
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:Diluent		0..0		Immunization Diluent
Immunization.Slices for extension.extension:MobileSiteId		0..0		Immunization Facility Mobile Site
Immunization.Slices for extension.extension:relatedPersonExtension		0..0		AIR Related Person
Immunization.Slices for extension.extension:serologyReportExtension		0..0		AIR Serology Report Extension
Immunization.Slices for extension.extension:rescheduleDateExtension		0..0		AIR Reschedule Date Extension
Immunization.modifierExtension		0..0		Extension
Immunization.identifier		0..0		Business identifier
Immunization.status		1..1	code	Status of the immunization event
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status
Immunization.vaccineCode
Immunization.vaccineCode.id		0..0		Unique id for inter-element referencing
Immunization.vaccineCode.extension		0..0		Extension
Immunization.vaccineCode.coding
Immunization.vaccineCode.coding.id		0..0		Unique id for inter-element referencing
Immunization.vaccineCode.coding.extension		0..0		Extension
Immunization.vaccineCode.coding.version		0..0		Version of the system - if relevant
Immunization.patient		1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.patient.display		0..0		Text alternative for the resource
Immunization.recorded		0..0		When the immunization was first captured in the subject's record
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.display		0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered
Immunization.performer
Immunization.performer.id		0..0		Unique id for inter-element referencing
Immunization.performer.extension		0..0		Extension
Immunization.performer.modifierExtension		0..0		Extension
Immunization.performer.function		0..1	CodeableConcept	Role performed by the vaccinator
Immunization.performer.actor		1..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner)	Identifier or reference for the vaccinator
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied
Immunization.protocolApplied.id		0..0		Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..0		Extension
Immunization.protocolApplied.modifierExtension		0..0		Extension
Immunization.protocolApplied.series		0..0		Name of vaccine series
Immunization.protocolApplied.authority		0..0		Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Immunization.protocolApplied.seriesDoses[x]		0..0		Recommended number of doses for immunity
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1
Immunization.id	Σ This element is included in summaries.	1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.meta.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.meta.Slices for extension.extension:CreatedSourceSystem		0..1	string	AIR Created Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system
Immunization.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Immunization.meta.Slices for extension.extension:CreatedDate		0..1	instant	The instant when this resource ID was first associated with content on this server URL: http://hl7.org/fhir/StructureDefinition/firstCreated
Immunization.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Immunization.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Immunization.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Immunization.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:administeredProduct		0..1	CodeableConcept	AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required)
Immunization.Slices for extension.extension:AgeGiven		0..1	(Complex)	AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status Binding: AIR Status Reason Code (preferred)
Immunization.statusReason.id		0..1	string	Unique id for inter-element referencing
Immunization.statusReason.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.statusReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.statusReason.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: AIR Vaccine Product (preferred)
Immunization.vaccineCode.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode.coding.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Immunization.vaccineCode.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.patient.id		0..1	string	Unique id for inter-element referencing
Immunization.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.patient.type	Σ This element is included in summaries.	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).
Immunization.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1	dateTime	Vaccine administration date
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.id		0..1	string	Unique id for inter-element referencing
Immunization.location.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.location.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.location.type	Σ This element is included in summaries.	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).
Immunization.location.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.location.display	Σ This element is included in summaries.	0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered Binding: AIR Body Site (preferred)
Immunization.site.id		0..1	string	Unique id for inter-element referencing
Immunization.site.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.site.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.site.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered Binding: AIR Route of Administration (preferred)
Immunization.route.id		0..1	string	Unique id for inter-element referencing
Immunization.route.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.route.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.route.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	Role performed by the vaccinator Binding: AIR Performer Health Worker Function (extensible)
Immunization.performer.function.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.function.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.performer.function.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.performer.function.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner)	Identifier or reference for the vaccinator
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred)
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied		0..1	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	preferred	AIR Status Reason Code	⏿2.0.0	nzhts.digital.health.nz
Immunization.vaccineCode	Base	preferred	AIR Vaccine Product	⏿2.0.1	nzhts.digital.health.nz
Immunization.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Immunization.location.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Immunization.site	Base	preferred	AIR Body Site	⏿2.0.0	nzhts.digital.health.nz
Immunization.route	Base	preferred	AIR Route of Administration	⏿2.0.0	nzhts.digital.health.nz
Immunization.performer.​function	Base	extensible	AIR Performer Health Worker Function	⏿2.0.2	nzhts.digital.health.nz
Immunization.reasonCode	Base	preferred	AIR Indication Code	⏿2.0.1	nzhts.digital.health.nz
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
air-resched-1	error	Immunization	Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.	extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
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()
nz-performer-function-1	error	Immunization	If the performer function has a system, then it must have a code.	performer.function.coding.system.exists() implies performer.function.coding.code.exists()
nz-performer-function-2	error	Immunization	If the performer function has a code, then it must have a system.	performer.function.coding.code.exists() implies performer.function.coding.system.exists()
nz-reasonCode-1	error	Immunization	If the reasonCode aka indication has a system, then it must have a code.	reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
nz-reasonCode-2	error	Immunization	If the reasonCode aka indication has a code, then it must have a system.	reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
nz-route-1	error	Immunization	If the route of admin has a system, then it must have a code.	route.coding.system.exists() implies route.coding.code.exists()
nz-route-2	error	Immunization	if the route of admin has a code, then it must have a system.	route.coding.code.exists() implies route.coding.system.exists()
nz-site-1	error	Immunization	If the body site has a system, then it must have a code.	site.coding.system.exists() implies site.coding.code.exists()
nz-site-2	error	Immunization	If the body site has a code, then it must have a system.	site.coding.code.exists() implies site.coding.system.exists()
nz-status-reason-1	error	Immunization	If the status reason has a system, then it must have a code.	statusReason.coding.system.exists() implies statusReason.coding.code.exists()
nz-status-reason-2	error	Immunization	If the status reason has a code, then it must have a system.	statusReason.coding.code.exists() implies statusReason.coding.system.exists()
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

This structure is derived from AIRImmunization

Summary

Mandatory: 1 element(1 nested mandatory element)
Prohibited: 35 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1
Immunization.id	Σ This element is included in summaries.	1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:administeredProduct		0..1	CodeableConcept	AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required)
Immunization.Slices for extension.extension:AgeGiven		0..1	(Complex)	AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status Binding: AIR Status Reason Code (preferred)
Immunization.statusReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: AIR Vaccine Product (preferred)
Immunization.vaccineCode.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode.coding.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Immunization.vaccineCode.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1	dateTime	Vaccine administration date
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.display	Σ This element is included in summaries.	0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered Binding: AIR Body Site (preferred)
Immunization.site.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered Binding: AIR Route of Administration (preferred)
Immunization.route.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred)
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied		0..1	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	preferred	AIR Status Reason Code	⏿2.0.0	nzhts.digital.health.nz
Immunization.vaccineCode	Base	preferred	AIR Vaccine Product	⏿2.0.1	nzhts.digital.health.nz
Immunization.site	Base	preferred	AIR Body Site	⏿2.0.0	nzhts.digital.health.nz
Immunization.route	Base	preferred	AIR Route of Administration	⏿2.0.0	nzhts.digital.health.nz
Immunization.reasonCode	Base	preferred	AIR Indication Code	⏿2.0.1	nzhts.digital.health.nz
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
air-resched-1	error	Immunization	Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.	extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
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()
nz-performer-function-1	error	Immunization	If the performer function has a system, then it must have a code.	performer.function.coding.system.exists() implies performer.function.coding.code.exists()
nz-performer-function-2	error	Immunization	If the performer function has a code, then it must have a system.	performer.function.coding.code.exists() implies performer.function.coding.system.exists()
nz-reasonCode-1	error	Immunization	If the reasonCode aka indication has a system, then it must have a code.	reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
nz-reasonCode-2	error	Immunization	If the reasonCode aka indication has a code, then it must have a system.	reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
nz-route-1	error	Immunization	If the route of admin has a system, then it must have a code.	route.coding.system.exists() implies route.coding.code.exists()
nz-route-2	error	Immunization	if the route of admin has a code, then it must have a system.	route.coding.code.exists() implies route.coding.system.exists()
nz-site-1	error	Immunization	If the body site has a system, then it must have a code.	site.coding.system.exists() implies site.coding.code.exists()
nz-site-2	error	Immunization	If the body site has a code, then it must have a system.	site.coding.code.exists() implies site.coding.system.exists()
nz-status-reason-1	error	Immunization	If the status reason has a system, then it must have a code.	statusReason.coding.system.exists() implies statusReason.coding.code.exists()
nz-status-reason-2	error	Immunization	If the status reason has a code, then it must have a system.	statusReason.coding.code.exists() implies statusReason.coding.system.exists()
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

Differential View

This structure is derived from AIRImmunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: sdhr-imm-status-1
Immunization.id		1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.meta
Immunization.meta.id		0..0		Unique id for inter-element referencing
Immunization.meta.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.meta.Slices for extension.extension:DataQualityAssessment		0..0		Data Quality Assessment
Immunization.meta.Slices for extension.extension:PlannedEventMatch		0..0		Planned Event Match
Immunization.meta.Slices for extension.extension:PlannedEventMatchQuality		0..0		Planned Event Match Quality
Immunization.meta.Slices for extension.extension:CreatedBy		0..0		AIR Created By User
Immunization.meta.Slices for extension.extension:ModifiedBy		0..0		AIR Modified By User
Immunization.meta.source		0..0		Identifies where the resource comes from
Immunization.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Immunization.meta.tag		0..0		Tags applied to this resource
Immunization.implicitRules		0..0		A set of rules under which this content was created
Immunization.language		0..0		Language of the resource content
Immunization.text		0..0		Text summary of the resource, for human interpretation
Immunization.contained		0..0		Contained, inline Resources
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:Diluent		0..0		Immunization Diluent
Immunization.Slices for extension.extension:MobileSiteId		0..0		Immunization Facility Mobile Site
Immunization.Slices for extension.extension:relatedPersonExtension		0..0		AIR Related Person
Immunization.Slices for extension.extension:serologyReportExtension		0..0		AIR Serology Report Extension
Immunization.Slices for extension.extension:rescheduleDateExtension		0..0		AIR Reschedule Date Extension
Immunization.modifierExtension		0..0		Extension
Immunization.identifier		0..0		Business identifier
Immunization.status		1..1	code	Status of the immunization event
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status
Immunization.vaccineCode
Immunization.vaccineCode.id		0..0		Unique id for inter-element referencing
Immunization.vaccineCode.extension		0..0		Extension
Immunization.vaccineCode.coding
Immunization.vaccineCode.coding.id		0..0		Unique id for inter-element referencing
Immunization.vaccineCode.coding.extension		0..0		Extension
Immunization.vaccineCode.coding.version		0..0		Version of the system - if relevant
Immunization.patient		1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.patient.display		0..0		Text alternative for the resource
Immunization.recorded		0..0		When the immunization was first captured in the subject's record
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.display		0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered
Immunization.performer
Immunization.performer.id		0..0		Unique id for inter-element referencing
Immunization.performer.extension		0..0		Extension
Immunization.performer.modifierExtension		0..0		Extension
Immunization.performer.function		0..1	CodeableConcept	Role performed by the vaccinator
Immunization.performer.actor		1..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner)	Identifier or reference for the vaccinator
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied
Immunization.protocolApplied.id		0..0		Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..0		Extension
Immunization.protocolApplied.modifierExtension		0..0		Extension
Immunization.protocolApplied.series		0..0		Name of vaccine series
Immunization.protocolApplied.authority		0..0		Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Immunization.protocolApplied.seriesDoses[x]		0..0		Recommended number of doses for immunity
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	AIRImmunization	Immunization event information Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1, sdhr-imm-status-1
Immunization.id	Σ This element is included in summaries.	1..1	id	Unique identifier for the immunization event assigned by ImmSOT
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.meta.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.meta.Slices for extension.extension:CreatedSourceSystem		0..1	string	AIR Created Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system
Immunization.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Immunization.meta.Slices for extension.extension:CreatedDate		0..1	instant	The instant when this resource ID was first associated with content on this server URL: http://hl7.org/fhir/StructureDefinition/firstCreated
Immunization.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Immunization.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Immunization.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Immunization.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Closed by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:administeredProduct		0..1	CodeableConcept	AIR Administered Product Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product Binding: AIR Administered Product Code (required)
Immunization.Slices for extension.extension:AgeGiven		0..1	(Complex)	AIR Age Given Extension URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	Status of the immunization event Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason for the immunization event status Binding: AIR Status Reason Code (preferred)
Immunization.statusReason.id		0..1	string	Unique id for inter-element referencing
Immunization.statusReason.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.statusReason.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.statusReason.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: AIR Vaccine Product (preferred)
Immunization.vaccineCode.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.vaccineCode.coding.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.coding.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system
Immunization.vaccineCode.coding.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.coding.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	NHI of the person who was immunized
Immunization.patient.id		0..1	string	Unique id for inter-element referencing
Immunization.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.patient.type	Σ This element is included in summaries.	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).
Immunization.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1	dateTime	Vaccine administration date
Immunization.location		0..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location)	Facility where the immunization event occurred
Immunization.location.id		0..1	string	Unique id for inter-element referencing
Immunization.location.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.location.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.location.type	Σ This element is included in summaries.	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).
Immunization.location.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.location.display	Σ This element is included in summaries.	0..1	string	Facility name supplied by SDHR from the included AIR Location
Immunization.lotNumber		0..1	string	Vaccine batch or lot number
Immunization.expirationDate		0..1	date	Vaccine batch expiry date
Immunization.site		0..1	CodeableConcept	Body site where the vaccine was administered Binding: AIR Body Site (preferred)
Immunization.site.id		0..1	string	Unique id for inter-element referencing
Immunization.site.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.site.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.site.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.route		0..1	CodeableConcept	Route by which the vaccine was administered Binding: AIR Route of Administration (preferred)
Immunization.route.id		0..1	string	Unique id for inter-element referencing
Immunization.route.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.route.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.route.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	Role performed by the vaccinator Binding: AIR Performer Health Worker Function (extensible)
Immunization.performer.function.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.function.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.performer.function.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
Immunization.performer.function.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner)	Identifier or reference for the vaccinator
Immunization.reasonCode		0..*	CodeableConcept	Clinical or funding indication for the immunization Binding: AIR Indication Code (preferred)
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Condition, observation, or report supporting the indication
Immunization.protocolApplied		0..1	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine-preventable disease targeted by this dose Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1	positiveInt	Dose number administered
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	preferred	AIR Status Reason Code	⏿2.0.0	nzhts.digital.health.nz
Immunization.vaccineCode	Base	preferred	AIR Vaccine Product	⏿2.0.1	nzhts.digital.health.nz
Immunization.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Immunization.location.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Immunization.site	Base	preferred	AIR Body Site	⏿2.0.0	nzhts.digital.health.nz
Immunization.route	Base	preferred	AIR Route of Administration	⏿2.0.0	nzhts.digital.health.nz
Immunization.performer.​function	Base	extensible	AIR Performer Health Worker Function	⏿2.0.2	nzhts.digital.health.nz
Immunization.reasonCode	Base	preferred	AIR Indication Code	⏿2.0.1	nzhts.digital.health.nz
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
air-resched-1	error	Immunization	Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.	extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()
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()
nz-performer-function-1	error	Immunization	If the performer function has a system, then it must have a code.	performer.function.coding.system.exists() implies performer.function.coding.code.exists()
nz-performer-function-2	error	Immunization	If the performer function has a code, then it must have a system.	performer.function.coding.code.exists() implies performer.function.coding.system.exists()
nz-reasonCode-1	error	Immunization	If the reasonCode aka indication has a system, then it must have a code.	reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()
nz-reasonCode-2	error	Immunization	If the reasonCode aka indication has a code, then it must have a system.	reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()
nz-route-1	error	Immunization	If the route of admin has a system, then it must have a code.	route.coding.system.exists() implies route.coding.code.exists()
nz-route-2	error	Immunization	if the route of admin has a code, then it must have a system.	route.coding.code.exists() implies route.coding.system.exists()
nz-site-1	error	Immunization	If the body site has a system, then it must have a code.	site.coding.system.exists() implies site.coding.code.exists()
nz-site-2	error	Immunization	If the body site has a code, then it must have a system.	site.coding.code.exists() implies site.coding.system.exists()
nz-status-reason-1	error	Immunization	If the status reason has a system, then it must have a code.	statusReason.coding.system.exists() implies statusReason.coding.code.exists()
nz-status-reason-2	error	Immunization	If the status reason has a code, then it must have a system.	statusReason.coding.code.exists() implies statusReason.coding.system.exists()
sdhr-imm-status-1	error	Immunization	SDHR does not return immunization records that AIR has marked as entered in error.	status != 'entered-in-error'

This structure is derived from AIRImmunization

Summary

Mandatory: 1 element(1 nested mandatory element)
Prohibited: 35 elements

Other representations of profile: CSV, Excel, Schematron