Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.0.0-SNAPSHOT - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.0.0-SNAPSHOT - ci-build
New Zealand
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
These are ValueSets that have been defined in this guide for coded elements.
Each ValueSet resource has a globally unique url (the Canonical url) that is used to unambiguously identify it. This url generally should resolve to the to the FHIR ValueSet resource, though the infrastructure to support this is not yet in place. There's a specific note in the spec on ValueSet identification.
The FHIR spec has much more detail on the use of Terminology in FHIR.
| ValueSet | Purpose | Canonical url |
| AIR Administered Product Code | NZMT TPUU codes for use in populating the administeredProduct element in an AIR Immunization resource. | https://nzhts.digital.health.nz/fhir/ValueSet/air-administered-product-code |
| AIR Antigen Group Code | SNOMED CT Codes used in AIR to identify an Antigen Group. These codes are drawn from the SNOMED medicinal product hierarchy. The AIR Antigen Group is used in the ImmunizationRecommendation resource that is produced when a user requests a patient's list of Planned Events. | https://nzhts.digital.health.nz/fhir/ValueSet/air-antigen-group-code |
| AIR Body Site | Body sites value set for AIR immunisations | https://nzhts.digital.health.nz/fhir/ValueSet/air-site-code |
| AIR Consumer State Code | Represents the current state of an AIR Consumer. | https://nzhts.digital.health.nz/fhir/ValueSet/air-consumer-state-code |
| AIR Consumer Sub Status Code | Represents the current sub status of an AIR Consumer. | https://nzhts.digital.health.nz/fhir/ValueSet/air-consumer-sub-state-code |
| AIR Diseases Covered | Diseases that are covered by the immunization programmes and schedules that are managed or referred to in the AIR system. | https://nzhts.digital.health.nz/fhir/ValueSet/air-disease-covered-code |
| AIR Forecast Status | This value set includes the codes used in AIR to communicate the status of a planned event. | https://nzhts.digital.health.nz/fhir/ValueSet/air-forecast-status-code |
| AIR HL7v2 Immunization Function Code | This value set holds health worker function codes used in legacy NIR messaging. Its purpose in AIR is to enable a mapping to semantically equivalent AIR Terms codes. These codes should NOT be used in FHIR payloads. | https://nzhts.digital.health.nz/fhir/ValueSet/air-hl7v2-imm-func-code |
| AIR Immunization Function Code (legacy) | This value set holds legacy health worker function codes. Its purpose in AIR is to enable a mapping to semantically equivalent AIR Terms codes. These codes should NOT be used in FHIR payloads. | https://nzhts.digital.health.nz/fhir/ValueSet/air-imm-func-code-legacy |
| AIR Indication Code | Coded values to describe the reason an immunisation was given. Initially drawn from legacy NIR codes and CIR SNOMED codes. | https://nzhts.digital.health.nz/fhir/ValueSet/air-indication-code |
| AIR Performer Health Worker Function | A value set of codes for the functions performed by the people who are involved in administering immunisations in Aotearoa. Note that the preferred terms are AP, OP, VC, VHW and IP. The other terms in this value set will be deprecated in the future. Note that the following codes are considered as Administering Providers: AP, IP, LMC, OIS, PV, VC, VHW, WCP. The following code is considered an Ordering Provider: GP. | https://nzhts.digital.health.nz/fhir/ValueSet/air-performer-health-worker-function-code |
| AIR Planned Event Date Type Code | Coded values to describe the dates associated with a Planned Event, such as the Due Date, the Earliest Date to Give, and so on. Also codes pretaining to the Planned Event record in AIR, such as the date it was created and the date the Planned Event moved in Final status. | https://nzhts.digital.health.nz/fhir/ValueSet/air-planned-event-date-type-code |
| AIR Processing Terms Code | This Value Set contains meta tags that AIR uses to signal processing outcomes. | https://nzhts.digital.health.nz/fhir/ValueSet/air-processing-terms-code |
| AIR Related Person Relationship Code | This value set is used to encode the relationship of a related person to the vaccine consumer. It is a subset of the FHIR Patient Relationship Type value set and includes some customised codes and displays for NZ usage. | https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code |
| AIR Route Code (Legacy HL7v2) | A value set to hold the legacy HL7v2 codes for route of admin. | https://nzhts.digital.health.nz/fhir/ValueSet/air-route-code-legacy |
| AIR Route of Administration | Route of administration value set for AIR immunisations | https://nzhts.digital.health.nz/fhir/ValueSet/air-route-code |
| AIR Scheduled Event Type Code | This value set lists the codes to be used to describe scheduled event type in AIR. | https://nzhts.digital.health.nz/fhir/ValueSet/air-scheduled-event-type-code |
| AIR Serology Protection Code | This value set includes all codes from the AIR Serology Protection code system. | https://nzhts.digital.health.nz/fhir/ValueSet/air-serology-protection-code |
| AIR Status Reason Code | Values to use in the status reason field of an immunisation event. | https://nzhts.digital.health.nz/fhir/ValueSet/air-status-reason-code |
| AIR Vaccine Product | Allowable values for CVX and NZVX codes used to populate the vaccineCode element in an AIR Immunization resource. | https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code |
| Hl7v2_resultResult Code | Hl7v2_result Result Code | https://nzhts.digital.health.nz/fhir/ValueSet/hl7v2-result |
These are code systems that have been defined in this guide. They define specific concepts that are included in ValueSets. It is preferable to use an international code system such as SNOMED, ICD or LOINC - but this is not always possible.
Each CodeSystem resource has a globally unique url (the canonical url) that is used to unambiguously identify it. The url generally refers to a description of the codesystem, rather than to the FHIR CodeSystem resource.
The FHIR spec has much more detail on the use of Terminology in FHIR
| CodeSystem | Purpose | Canonical url |
| AIR AGVS | This is a code system for representing the type of AGVS attached to a Scheduled Event | https://standards.digital.health.nz/ns/air-agvs-type |
| AIR AGVS Schedule Type | This is a code system for representing the type of AGVS schedule attached to a Scheduled Event | https://standards.digital.health.nz/ns/air-agvs-schedule-type |
| AIR AGVS Series Type | This is a code system for representing the type of AGVS series attached to a Scheduled Event | https://standards.digital.health.nz/ns/air-agvs-series-type |
| AIR Consumer State | This is a code system for representing the current state of an AIR Patient (AKA Consumer). | https://standards.digital.health.nz/ns/air-consumer-state |
| AIR Consumer Sub Status | This is a code system for representing the current sub status of an AIR Patient (AKA Consumer). | https://standards.digital.health.nz/ns/air-consumer-sub-status |
| AIR Event Type | Identifies AIR events. | https://standards.digital.health.nz/ns/air-event-type |
| AIR Forecast Status | This code system includes the codes used in AIR to communicate a planned event status that are not already included in http://terminology.hl7.org/CodeSystem/immunization-recommendation-status. | https://standards.digital.health.nz/ns/air-forecast-status |
| AIR Immunisation Notification Action Code | Describes the action taken by Orchestration server in response to an Immunisation Notification request message | https://standards.digital.health.nz/ns/air-immunisation-notification-action-code |
| AIR Operationoutcome Codes | Describes the AIR-specific errors | https://standards.digital.health.nz/ns/air-operationoutcome-code |
| AIR Planned Event Date Type Code System | This code system includes the codes used in AIR to communicate a date associated with a planned event, such as the due date or the earliest date to give. | https://standards.digital.health.nz/ns/air-planned-event-date-type |
| AIR Planned Event Type | This code system includes values for the types of Planned Events used in AIR. | https://standards.digital.health.nz/ns/air-scheduled-event-type-terms |
| AIR Processing Terms | This Code System contains meta tags that AIR uses to signal processing outcomes | https://standards.digital.health.nz/ns/air-processing-terms |
| AIR Related Person Relationship Terms | This code system includes the relationship type codes used in the NIR HL7v2 messasing NK1 segment Relationship field. | https://standards.digital.health.nz/ns/air-legacy-related-person-terms |
| AIR Serology Protection Terms Code System | This local code system includes the terms used in legacy HL7 messages and FHIR requests related to serology reports for protection status for diseases such as Hepatitis B. | https://standards.digital.health.nz/ns/air-serology-protection-terms |
| AIR Status Reason Terms Code System | This AIR code system includes the terms used in NIR HL7v2 messages to populate the RXA-18 field and and in FHIR payloads to populate immunization.statusReason. | https://standards.digital.health.nz/ns/air-status-reason-terms |
| AIR Terms | This is a code system for terms needed in AIR ImmSoT that don't come from an external standard | https://standards.digital.health.nz/ns/air-terms-code |
| Hl7v2 Result Code | Hl7v2 Result Code | https://standards.digital.health.nz/ns/hl7v2-result |
| NZVX Immunisation Code | Antigen code set for vaccines administered in New Zealand (NZVX). | https://standards.digital.health.nz/ns/immunisation-code |
| ConceptMap | Purpose | Canonical url |
| AIR Route of Administration HL7v2 < -- > SNOMED | This maps the AIR Route of Administration from HL7v2 messaging to SNOMED CT NZ. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-route-map |
| AIR Target Disease (SNOMED) < -- > AIR Vaccine (CVX) | This map connects vaccine-preventable diseases (identified by SNOMED codes) to the vaccines that target them (identified by CVX codes). This mapping facilitates searching ImmSOT using the targetDisease search parameter. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-target-disease-map |
| AIR Vaccination Site HL7v2 < -- > SNOMED | This maps the vaccination site codes listed in the NIR Message Spec v4.5, Sep 2020 (HL7 Table 0162) to SNOMED CT NZ. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-site-map |
| AIR Vaccine Product TPUU (NZMT) < -- > AIR Vaccine (CVX) | This map connects vaccine products as identified by the Therapeutic Product Unit of Use (TPUU) code in the New Zealand Medicines Terminology (NZMT) to the vaccines as identified by CVX codes. This mapping facilitates translating TPUU codes stored in ImmSOT to a CVX code that can be received by legacy PMS systems. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-vaccine-product-map |
| Concept Map -- HL7v2 Immunization Function < -- > AIR Health Worker Function | This maps HL7 Immunization Function Codes and Provider Roles to AIR Health Worker Function Codes. HL7v2 codes are from V2 table 0443 (Provider Role) and map to message segments as defined in CodeSystem: providerRole. HL7v3 codes are from CodeSystem: ParticipationType | https://nzhts.digital.health.nz/fhir/ConceptMap/air-health-worker-function-map |
| Gender Code HL7v2 PID < -- > Administrative Gender used in FHIR R4 | This maps the gender codes listed in the NIR Message Spec v4.5, Sep 2020 (HL7 Table 0001) to the codes returned by the NHI Service. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-gender-code-map |
| HL7v2 Serology Obs Value < -- > AIR Serology Protection Code | This maps the codes used to report serology protection status in NIR HL7v2 messaging (OBX-5) to the counterpart codes used in the FHIR observation.interpretation field. Note that this map only includes those codes where the code is different between HL7v2 and FHIR standards. | https://nzhts.digital.health.nz/fhir/ConceptMap/air-serology-protection-code-map |