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

Profiles


Profiles defined in this guide

IdUrlDescription
air-agvs-plan-definition https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-agvs-plan-definition

Defines an immunization schedule with a series of doses, including custom extensions.

air-careplan https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-careplan

This defines how a consumer’s assigned immunisation schedule is represented. Planned events are represented as ImmunizationRecommendation resources, indicating doses that are scheduled based on clinical guidelines and timing. Corresponding Immunization resources are linked to the relevant planned activity in the CarePlan.

air-dose-definition https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-dose-definition

Defines a dose recommendation in an immunization schedule.

air-immunization-recommendation https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-immunization-recommendation

AIR uses this immunizationRecommendation profile to communicate the details of scheduled events.

air-immunization https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-immunization

This is the AIR Immunization Profile, to be used for immunisation records inbound to ImmSoT. It includes a number of constraints designed to enforce ImmSoT's lean data model approach.

air-location https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-location

Ths profile constrains the NZ Location Profile to meet the requirements of AIR.

air-message-header https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-message-header

This profile derived from MessageHeader implements extensions to message header required for Immunisation event messaging.

air-patient https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-patient

This profile derived from NZPatient implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).

air-practitioner https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/air-practitioner

This profile derived from NZPractitioner implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).

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

This profile of the FHIR R4 RelatedPerson resource includes only the fields used in AIR. The AIR use of this profile specifically includes the use cases covered by the NK1 segment in NIR HL7v2 messaging.

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

This profile on the FHIR r4 Observation resource serves to exchange serology report information in support of the legacy NIR data flow that attaches serology info to an existing immunization record and re-sends it. It is cut down substantially from the base Observation resource.

test-air-immunization-recommendation https://fhir-ig-uat.digital.health.nz/air/StructureDefinition/test-air-immunization-recommendation

This profile is for testing the design of the ImmunizationRecommendation profile that will be used to convey information about planned events.