NZ Shared Digital Health Record API
1.1.6 - release
NZ Shared Digital Health Record API
1.1.6 - release
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
| Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product | Version: 1.1.6 | |||
| Active as of 2026-07-14 | Computable Name: AIRAdministeredProduct | |||
This extension to the AIR Immunization profile pre-adopts the FHIR R5 construct of the same name. In AIR, the (mandatory) vaccineCode element should be used to transmit a CVX or NZVX code for the vaccine, while the (optional) administeredProduct element should be used to transmit an NZMT TPUU code fot he vaccine.
Context of Use
This extension may be used on the following element(s)
Immunization
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Extension |
Extension | AIR Administered Product Extension | ||
  extension |
..0 | |||
| url |
"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product" | |||
  value[x] |
CodeableConcept | Binding: AIR Administered Product Code  (required) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Administered Product Extension | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| 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 | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Administered Product Code (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type CodeableConcept: This extension to the AIR Immunization profile pre-adopts the FHIR R5 construct of the same name. In AIR, the (mandatory) vaccineCode element should be used to transmit a CVX or NZVX code for the vaccine, while the (optional) administeredProduct element should be used to transmit an NZMT TPUU code fot he vaccine.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
Extension | AIR Administered Product Extension | ||
| extension |
..0 | |||
| url |
"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product" | |||
| value[x] |
CodeableConcept | Binding: AIR Administered Product Code (required) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Administered Product Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| 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 | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Administered Product Code (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type CodeableConcept: This extension to the AIR Immunization profile pre-adopts the FHIR R5 construct of the same name. In AIR, the (mandatory) vaccineCode element should be used to transmit a CVX or NZVX code for the vaccine, while the (optional) administeredProduct element should be used to transmit an NZMT TPUU code fot he vaccine.
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | required |
AIR Administered Product Code
|
⏿2.0.4 | nzhts.digital.health.nz |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|