Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission. For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html
This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed
or info@snomed.org
.
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.0.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions ( src
)
HL7® FHIR® New Zealand Base Implementation Guide v2.0 ( src
)
The Immunisation API is a RESTful API that provides access to the AIR. The API supports industry-standard FHIR® representations in data of common entities, relationships, artefacts and events encountered in a health context, such as such as Immunization, Patient, Practitioner and so forth. ( src
)
This is the FHIR® Implementation Guide (IG) for the Aotearoa Immunisation Register (AIR) API (application programming interface). This API exposes Health NZ’s Immunisation Source of Truth (ImmSoT) service via the Digital Services Hub (DSH). ImmSoT is the repository of all immunisation data for the AIR. ( src
)
The Aotearoa Immunisation Register (AIR) holds a collection of "Scheduled Events", where each Scheduled Event represents a dose of vaccine to be administered to a person in the future. As an example, when a newborn is enrolled into AIR, a Scheduled Event is created for each dose listed in the National Immunisation Schedule
.
The Aotearoa Immunisation Register (AIR) holds a collection of "Immunisation Events", where each Immunisation Event represents a dose of vaccine that has been administered to a person (or in certain instances, a dose that has NOT been administered for a defined reason). An Immunisation Event is created for each dose given (or declined) according to recommendations published in the National Immunisation Schedule
.
This describes one particular AIR data quality rule violation for an Immunization. Each rule violation includes a code, a type, a message, the FHIRPath expression to the element where the error occurred, and the weighting associated with the rule. Refer to Data Quality Rules
and AIR Data Quality Violation Code
value set for codes and messages that could be returned.
Complex Extension: This describes one particular AIR data quality rule violation for an Immunization. Each rule violation includes a code, a type, a message, the FHIRPath expression to the element where the error occurred, and the weighting associated with the rule. Refer to Data Quality Rules
and AIR Data Quality Violation Code
value set for codes and messages that could be returned.
The NIR
was in place nationwide from 2005 until its retirement with the roll-out of AIR in December, 2023. Its original purpose was to collect comprehensive information about childhood immunisation rates, as well as support the MeNZB immunisation programme. As a consequence, a clear record of childhood immunisation for children born since 2005 was available, however comprehensive information about immunisation for people aged 15 years and over was not.
To access a list of NHI test identifiers follow this link
and search for text NHI Test Data
. To specifically test the new NHI number format, go to Upcoming Changes to the NHI
and download the spreadsheet under the heading 'Change to the check digit algorithm'.
To access a list of NHI test identifiers follow this link
and search for text NHI Test Data
. To specifically test the new NHI number format, go to Upcoming Changes to the NHI
and download the spreadsheet under the heading 'Change to the check digit algorithm'.
GIVEN
my application is a subscriber to the immunisation history (Search Immunisation) API WHEN
an API call is made THEN
the Request-Context header properties are populated as specified in the schema and base-64 encoded. The schema is defined in: https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context.json
Te whatu ora will validate your request and verify it includes the request context information.
The subscriber's Application sets the following fields in the Request-Context HTTP header: userIdentifier:
the subscriber's Application logged in user. facilityIdentifier:
the HPI-F code assigned to the Facility secondaryIdentifier:
If the person triggering the request is not registered with any New Zealand health body on the list provided, values must remain empty (empty string). userRole
and purposeOfUse
are also required.
The subscriber's Application sets the following fields in the Request-Context HTTP header: userIdentifier:
the subscriber's Application logged in user. facilityIdentifier:
the HPI-F code assigned to the Facility secondaryIdentifier:
If the person triggering the request is not registered with any New Zealand health body on the list provided, values must remain empty (empty string). userRole
and purposeOfUse
are also required.
The application demonstrates the ability to display clinically important elements and data is displayed
in the expected format as specified in the Aotearoa Immunisation Register (AIR) FHIR Implementation Guide https://fhir-ig-uat.digital.health.nz/air/index.html
The application demonstrates the ability to display the maximum allowable sizes for all immunisation
data fields as specified in the Aotearoa Immunisation Register (AIR) FHIR Implementation Guide https://fhir-ig-uat.digital.health.nz/air/index.html
The health worker system must be one of the following:
https://standards.digital.health.nz/ns/air-vhw-id
https://standards.digital.health.nz/ns/hpi-person-id
https://standards.digital.health.nz/ns/medical-council-id
https://standards.digital.health.nz/ns/nursing-council-id
https://standards.digital.health.nz/ns/air-cir-id
https://standards.digital.health.nz/ns/pharmacy-council-id
https://standards.digital.health.nz/ns/paramedic-council-id
https://standards.digital.health.nz/ns/midwifery-council-id
https://HCA
A health worker identification number must pass the checksum criteria when the health worker system is https://standards.digital.health.nz/ns/hpi-person-id
Request-Context header field secondaryIdentifier MUST be the end user’s CPN where available. Otherwise, any secondary identifier that is held for the user. This value is mandatory and must be correct and accurate, due to legal requirements. If the person triggering the request is not registered with any New Zealand health body on the list provided at standards.digital.health.nz
, the value must remain empty (empty string).
Immunisation status and statusReason SHOULD correspond, according to the table below. Events not complying with this rule are not able to be categorised, reported or matched to a planned event. This table is available from the NZHTS as a Concept Map: AIR Immunization Status < – > AIR Status Reason
.
Request access to digital assets, providing application and use case details using the Digital Services Hub Support form
. Once this has been approved you will receive credentials to the Mock+ environment, which hosts stubs that API consumers can use for early testing.
Compliance Test environment access will be provided in coordination with AIR product team support.
Preview the AIR compliance tests
in this Implementation Guide under the Compliance Testing menu item.
Test evidence to be provided includes screen shots and API responses. A demo of your application to an AIR test analyst may be requested.
Estimates of expected loads and volumes will be required for HNZ capacity planning and rate limiting. Load and volume testing could be required depending on use case.
Coordination will be required if HPI and NHI compliance is required.
Regular catch-ups and escalation pathways will be available.
