Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

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

Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 API
... 3 Business Context
... 4 Careplan View
... 5 Compliance Testing Base API Tests
... 6 Data Quality Rules
... 7 Duplicate Record Handling
... 8 Extensions
... 9 General Notes
... 10 History
... 11 Immunisation Event Create
... 12 Immunisation Event Read
... 13 Immunisation Event Search
... 14 Immunisation Event Update
... 15 Immunisation Event Upsert
... 16 Immunisations
... 17 Immunisation Update Message
... 18 Onboarding
... 19 Profiles
... 20 Rejection Rules
... 21 Request Headers
... 22 Scheduled Events
... 23 Terminology
... 24 Use Cases
... 25 Artifacts Summary
.... 25.1 AIR FHIR Server Capability Statement
.... 25.2 Bulk Update Immunisation Event
.... 25.3 Patient History
.... 25.4 Reassign Patient Schedules
.... 25.5 Search for Immunisation Events Using Data Quality Parameters
.... 25.6 Update AIR patient state
.... 25.7 Upsert Immunisation Event
.... 25.8 UpdateImmunisationRequestMessageDefinition
.... 25.9 UpdateImmunisationResponseMessageDefinition
.... 25.10 status-reason:not-in
.... 25.11 status:not-in
.... 25.12 AIR CarePlan Profile
.... 25.13 AIR Immunization
.... 25.14 AIR Immunization Recommendation
.... 25.15 AIR Location Profile
.... 25.16 AIR Message Header
.... 25.17 AIR Patient Profile
.... 25.18 AIR Practitioner Profile
.... 25.19 AIR Related Person Profile
.... 25.20 AIR Serology Report Profile
.... 25.21 Immunization Dose Recommendation
.... 25.22 Immunization Schedule Plan Definition
.... 25.23 TEST AIR Immunization Recommendation Profile
.... 25.24 AIR Administered Product Extension
.... 25.25 AIR Age Given Extension
.... 25.26 AIR Antigen Group Extension
.... 25.27 AIR Antigen Group Vaccination Schedule
.... 25.28 AIR Consumer NIR Opt Off
.... 25.29 AIR Consumer State
.... 25.30 AIR Consumer Sub Status
.... 25.31 AIR Created By User
.... 25.32 AIR Created Source System
.... 25.33 AIR Data Quality Violation Array
.... 25.34 AIR Data Quality Violation Detail
.... 25.35 AIR Disease Covered
.... 25.36 Air Immunisation Notification Action
.... 25.37 AIR Modified By User
.... 25.38 AIR Modified Source System
.... 25.39 AIR Recommendation Id
.... 25.40 AIR Related Person
.... 25.41 AIR Reschedule Date Extension
.... 25.42 AIR Scheduled Event
.... 25.43 AIR Series Type Extension
.... 25.44 AIR Series Type Extension
.... 25.45 AIR Serology Report Extension
.... 25.46 AIR Trigger Extension
.... 25.47 Data Quality Assessment
.... 25.48 Immunization Diluent
.... 25.49 Immunization Facility Mobile Site
.... 25.50 Performed Activity Extension
.... 25.51 Planned Activity Reference Extension
.... 25.52 Planned Event Match
.... 25.53 Planned Event Match Quality
.... 25.54 Schedule Type Extension
.... 25.55 AIR Administered Product Code
.... 25.56 AIR Antigen Group Code
.... 25.57 AIR Body Site
.... 25.58 AIR Consumer State Code
.... 25.59 AIR Consumer Sub Status Code
.... 25.60 AIR Diseases Covered
.... 25.61 AIR Forecast Status
.... 25.62 AIR HL7v2 Immunization Function Code
.... 25.63 AIR Immunization Function Code (legacy)
.... 25.64 AIR Indication Code
.... 25.65 AIR Performer Health Worker Function
.... 25.66 AIR Planned Event Date Type Code
.... 25.67 AIR Processing Terms Code
.... 25.68 AIR Related Person Relationship Code
.... 25.69 AIR Route Code (Legacy HL7v2)
.... 25.70 AIR Route of Administration
.... 25.71 AIR Scheduled Event Type Code
.... 25.72 AIR Serology Protection Code
.... 25.73 AIR Status Reason Code
.... 25.74 AIR Vaccine Product
.... 25.75 Hl7v2_resultResult Code
.... 25.76 AIR AGVS
.... 25.77 AIR AGVS Schedule Type
.... 25.78 AIR AGVS Series Type
.... 25.79 AIR Consumer State
.... 25.80 AIR Consumer Sub Status
.... 25.81 AIR Event Type
.... 25.82 AIR Forecast Status
.... 25.83 AIR Immunisation Notification Action Code
.... 25.84 AIR Operationoutcome Codes
.... 25.85 AIR Planned Event Date Type Code System
.... 25.86 AIR Planned Event Type
.... 25.87 AIR Processing Terms
.... 25.88 AIR Related Person Relationship Terms
.... 25.89 AIR Serology Protection Terms Code System
.... 25.90 AIR Status Reason Terms Code System
.... 25.91 AIR Terms
.... 25.92 Hl7v2 Result Code
.... 25.93 NZVX Immunisation Code
.... 25.94 AIR Route of Administration HL7v2 < -- > SNOMED
.... 25.95 AIR Target Disease (SNOMED) < -- > AIR Vaccine (CVX)
.... 25.96 AIR Vaccination Site HL7v2 < -- > SNOMED
.... 25.97 AIR Vaccine Product TPUU (NZMT) < -- > AIR Vaccine (CVX)
.... 25.98 Concept Map -- HL7v2 Immunization Function < -- > AIR Health Worker Function
.... 25.99 Gender Code HL7v2 PID < -- > Administrative Gender used in FHIR R4
.... 25.100 HL7v2 Serology Obs Value < -- > AIR Serology Protection Code
.... 25.101 AIR Orchestration Service Immunisation Bundle Example
.... 25.102 AIRBundleCarePlanExample
.... 25.103 create-immunisation-operation-outcome-response
.... 25.104 immunisation-update-request-message-1
.... 25.105 immunisation-update-request-message-3
.... 25.106 immunisation-update-response-message-match-quality
.... 25.107 immunisation-update-response-message-meta-tag
.... 25.108 Immunization Example 1
.... 25.109 Immunization Example 2
.... 25.110 Immunization Example with Match and Match Quality extension
.... 25.111 Immunization Example with Match Quality extension
.... 25.112 Planned Event Example
.... 25.113 update-immunisation-request-response-message-1
.... 25.114 update-immunisation-request-response-message-2
.... 25.115 update-immunisation-response-message-1