Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extensions


Extensions defined in this guide

IdUrlContext of UseDescriptionPurpose
air-administered-product https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product
Immunization

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.

air-age-given https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
Immunization

This extension calculates the patient age when a vaccination was administered. Although this could be calculated by the client based on patient date of birth, it is provided as a convenience.

air-agvs https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation

This extension to the AIR ImmunizationRecommendation profile is used to convey information about the antigen group vaccination schedule associated with a Scheduled Event, including the schedule type, the series type, the antigen group, and the version.

air-antigen-group-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension
Element

Describes the antigen group used in AGVS.

air-consumer-nir-opt-off https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Immunization

This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. Presence of this extension on the AIR Patient indicates that the consumer has opted off NIR and the extension includes the date that the consumer requested this to occur.

air-consumer-state https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Immunization

This extension is used in AIR to communicate the current state of an AIR Patient (AKA Consumer).

air-consumer-sub-status https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status
Immunization

This extension is used in AIR to communicate the current sub status of an AIR Patient (AKA Consumer).

air-created-by https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by
Immunization.meta

This extension is used in AIR to record the user who created the immunisation event record.

air-created-source-system https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system
Immunization.meta

This extension is used in AIR to record the system or software used to create the immunisation event record. Example values are ISM, PMS, and so on.

air-data-quality-assessment https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment
Element

The data quality assessment of this immunization record as calculated by AIR rules.

air-diluent https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent
Immunization

Immunization Diluent

air-disease-covered https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered
ImmunizationRecommendation.recommendation

The disease which a vaccine covers. Needed in ImmunizationRecommendation as the cardinality there is only single.

air-immunisation-notification-action http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action
MessageHeader

Indicates which parties should be notified of the event

air-mobile-site https://standards.digital.health.nz/fhir/air/StructureDefinition/air-mobile-site
Immunization

Immunization Facility Mobile Site

air-modified-by https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
(Immunization|Patient).meta

This extension is used in AIR to record the user who modified the immunisation event or patient record.

air-modified-source-system https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
(Immunization|Patient).meta

This extension is used in AIR to record the system or software used to update the immunisation event or patient record. Example values are ISM, PMS, and so on.

air-performed-activity-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-performed-activity
CarePlan.activity.extension

This Performed Activity adds an R5 field to the R4 CarePlan so that we can refer to an Immunization.

air-planned-activity-reference-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference
CarePlan.activity.extension

This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation.

air-planned-event-match-quality https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality
Element

The match quality of a planned event to an immunisation event as calculated by AIR rules.

air-planned-event-match https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match
Element

The match of a planned event to an immunisation event as calculated by AIR rules.

air-recommendation-id https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation

This extension is to hold the id of an individual Scheduled Event that is surfaced by AIR as part of an ImmunizationRecommendation resource.

air-related-person-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension
Immunization

This extension is to be used for communicating related person info in an AIR Immunisation Event. It holds the information transmitted in the HL7v2 NK1 segment.

air-reschedule-date https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date
Immunization

This extension is used on an AIR Immunization resource that is sent to AIR as part of a $bulk-update operation. It holds the date to which the Immunisation Event has been rescheduled.

air-schedule-type-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-schedule-type-extension
Element

Describes the schedule type used in AGVS.

air-scheduled-event https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation

The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.

air-series-type-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-series-type-extension
Element

Describes the series type used in AGVS.

air-serology-report-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension
Immunization

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.

air-timingAge-ISO8601-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-timingAge-ISO8601-extension
Element

Describes the series type used in AGVS.

air-trigger-extension https://standards.digital.health.nz/fhir/air/StructureDefinition/air-trigger-extension
Element

Describes the trigger type used in AGVS.

dq-violation https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation
Element

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.

dq-violations https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violations
Element

This describes an instance of an immunisation record violating one or more AIR data quality rules. Each such violation is described by a code, a type, a message, a pointer to the targeted element, and a weight. Refer to Data Quality Rules for codes that could be returned.