Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.2.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.2.0-SNAPSHOT) 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 Compliance Testing Nems Tests
7 Compliance Testing Nzhts Tests
8 Compliance Testing Read API Tests
9 Compliance Testing Write API Tests
10 Data Quality Rules
11 Duplicate Record Handling
12 Extensions
13 General Notes
14 History
15 Immunisation Event Create
16 Immunisation Event Read
17 Immunisation Event Search
18 Immunisation Event Update
19 Immunisation Event Upsert
20 Immunisation Update Message
21 Onboarding
22 Profiles
23 Rejection Rules
24 Request Headers
25 Terminology
26 Use Cases
27 Artifacts Summary
27.1 AIR FHIR Server Capability Statement
27.2 Bulk Update Immunisation Event
27.3 Patient History
27.4 Reassign Patient Schedules
27.5 Search for Immunisation Events Using Data Quality Parameters
27.6 Update AIR patient state
27.7 Upsert Immunisation Event
27.8 UpdateImmunisationRequestMessageDefinition
27.9 UpdateImmunisationResponseMessageDefinition
27.10 status-reason:not-in
27.11 status:not-in
27.12 AIR CarePlan Profile
27.13 AIR Immunization
27.14 AIR Immunization Recommendation
27.15 AIR Location Profile
27.16 AIR Message Header
27.17 AIR Patient Profile
27.18 AIR Practitioner Profile
27.19 AIR Related Person Profile
27.20 AIR Serology Report Profile
27.21 Immunization Dose Recommendation
27.22 Immunization Schedule Plan Definition
27.23 TEST AIR Immunization Recommendation Profile
27.24 AIR Administered Product Extension
27.25 AIR Age Given Extension
27.26 AIR Antigen Group Extension
27.27 AIR Antigen Group Vaccination Schedule
27.28 AIR Consumer NIR Opt Off
27.29 AIR Consumer State
27.30 AIR Consumer Sub Status
27.31 AIR Created By User
27.32 AIR Created Source System
27.33 AIR Data Quality Violation Array
27.34 AIR Data Quality Violation Detail
27.35 AIR Disease Covered
27.36 Air Immunisation Notification Action
27.37 AIR Modified By User
27.38 AIR Modified Source System
27.39 AIR Recommendation Id
27.40 AIR Related Person
27.41 AIR Reschedule Date Extension
27.42 AIR Scheduled Event
27.43 AIR Series Type Extension
27.44 AIR Series Type Extension
27.45 AIR Serology Report Extension
27.46 AIR Trigger Extension
27.47 Data Quality Assessment
27.48 Immunization Diluent
27.49 Immunization Facility Mobile Site
27.50 Performed Activity Extension
27.51 Planned Activity Reference Extension
27.52 Planned Event Match
27.53 Planned Event Match Quality
27.54 Schedule Type Extension
27.55 AIR Administered Product Code
27.56 AIR Antigen Group Code
27.57 AIR Body Site
27.58 AIR Consumer State Code
27.59 AIR Consumer Sub Status Code
27.60 AIR Diseases Covered
27.61 AIR Forecast Status
27.62 AIR HL7v2 Immunization Function Code
27.63 AIR Immunization Function Code (legacy)
27.64 AIR Indication Code
27.65 AIR Performer Health Worker Function
27.66 AIR Planned Event Date Type Code
27.67 AIR Processing Terms Code
27.68 AIR Related Person Relationship Code
27.69 AIR Route Code (Legacy HL7v2)
27.70 AIR Route of Administration
27.71 AIR Scheduled Event Type Code
27.72 AIR Serology Protection Code
27.73 AIR Status Reason Code
27.74 AIR Vaccine Product
27.75 Hl7v2_resultResult Code
27.76 AIR AGVS
27.77 AIR AGVS Schedule Type
27.78 AIR AGVS Series Type
27.79 AIR Consumer State
27.80 AIR Consumer Sub Status
27.81 AIR Event Type
27.82 AIR Forecast Status
27.83 AIR Immunisation Notification Action Code
27.84 AIR Operationoutcome Codes
27.85 AIR Planned Event Date Type Code System
27.86 AIR Planned Event Type
27.87 AIR Processing Terms
27.88 AIR Related Person Relationship Terms
27.89 AIR Serology Protection Terms Code System
27.90 AIR Status Reason Terms Code System
27.91 AIR Terms
27.92 Hl7v2 Result Code
27.93 NZVX Immunisation Code
27.94 AIR Route of Administration HL7v2 < -- > SNOMED
27.95 AIR Target Disease (SNOMED) < -- > AIR Vaccine (CVX)
27.96 AIR Vaccination Site HL7v2 < -- > SNOMED
27.97 AIR Vaccine Product TPUU (NZMT) < -- > AIR Vaccine (CVX)
27.98 Concept Map -- HL7v2 Immunization Function < -- > AIR Health Worker Function
27.99 Gender Code HL7v2 PID < -- > Administrative Gender used in FHIR R4
27.100 HL7v2 Serology Obs Value < -- > AIR Serology Protection Code
27.101 AIR Orchestration Service Immunisation Bundle Example
27.102 AIRBundleCarePlanExample
27.103 immunisation-update-request-message-1
27.104 immunisation-update-request-message-3
27.105 immunisation-update-response-message-meta-tag
27.106 Immunization Example 1
27.107 Immunization Example 2
27.108 Immunization Example with Failed Reschedule date
27.109 Immunization Example with Match and Match Quality extension
27.110 Immunization Example with Match Quality extension
27.111 Planned Event Example
27.112 update-immunisation-request-response-message-1
27.113 update-immunisation-request-response-message-2
27.114 update-immunisation-response-message-1