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-serology-report-extension | Version: 1.1.6 | |||
| Active as of 2026-07-14 | Computable Name: AIRSerologyReport | |||
This extension allows an AIR Immunization instance to contain information from a serology report that describes a patient's expected level of immune protection from Hepatitis B infection. Note that this extension could be updated to cover additional diseases in the future.
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 Serology Report Extension | ||
  extension |
..0 | |||
| url |
"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension" | |||
  value[x] |
Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Serology Report Extension Constraints: ext-1 | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Additional content defined by implementations 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-serology-report-extension" | |
| value[x] |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type Reference: This extension allows an AIR Immunization instance to contain information from a serology report that describes a patient's expected level of immune protection from Hepatitis B infection. Note that this extension could be updated to cover additional diseases in the future.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
Extension | AIR Serology Report Extension | ||
| extension |
..0 | |||
| url |
"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension" | |||
| value[x] |
Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Serology Report Extension Constraints: ext-1 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Additional content defined by implementations 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-serology-report-extension" | |
| value[x] |
0..1 | Reference(https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type Reference: This extension allows an AIR Immunization instance to contain information from a serology report that describes a patient's expected level of immune protection from Hepatitis B infection. Note that this extension could be updated to cover additional diseases in the future.
Other representations of profile: CSV, Excel, Schematron
| 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 | Extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|