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

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.29.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 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 Immunisation Update Message
17 Onboarding
18 Profiles
19 Rejection Rules
20 Request Headers
21 Terminology
22 Use Cases
23 Artifacts Summary
23.1 AIR FHIR Server Capability Statement
23.2 Bulk Update Immunisation Event
23.3 Patient History
23.4 Reassign Patient Schedules
23.5 Search for Immunisation Events Using Data Quality Parameters
23.6 Update AIR patient state
23.7 Upsert Immunisation Event
23.8 UpdateImmunisationRequestMessageDefinition
23.9 UpdateImmunisationResponseMessageDefinition
23.10 status-reason:not-in
23.11 status:not-in
23.12 AIR CarePlan Profile
23.13 AIR Immunization
23.14 AIR Immunization Recommendation
23.15 AIR Location Profile
23.16 AIR Message Header
23.17 AIR Patient Profile
23.18 AIR Practitioner Profile
23.19 AIR Related Person Profile
23.20 AIR Serology Report Profile
23.21 Immunization Dose Recommendation
23.22 Immunization Schedule Plan Definition
23.23 TEST AIR Immunization Recommendation Profile
23.24 AIR Administered Product Extension
23.25 AIR Age Given Extension
23.26 AIR Antigen Group Extension
23.27 AIR Antigen Group Vaccination Schedule
23.28 AIR Consumer NIR Opt Off
23.29 AIR Consumer State
23.30 AIR Consumer Sub Status
23.31 AIR Created By User
23.32 AIR Created Source System
23.33 AIR Data Quality Violation Array
23.34 AIR Data Quality Violation Detail
23.35 AIR Disease Covered
23.36 Air Immunisation Notification Action
23.37 AIR Modified By User
23.38 AIR Modified Source System
23.39 AIR Recommendation Id
23.40 AIR Related Person
23.41 AIR Reschedule Date Extension
23.42 AIR Scheduled Event
23.43 AIR Series Type Extension
23.44 AIR Series Type Extension
23.45 AIR Serology Report Extension
23.46 AIR Trigger Extension
23.47 Data Quality Assessment
23.48 Immunization Diluent
23.49 Immunization Facility Mobile Site
23.50 Performed Activity Extension
23.51 Planned Activity Reference Extension
23.52 Planned Event Match
23.53 Planned Event Match Quality
23.54 Schedule Type Extension
23.55 AIR Administered Product Code
23.56 AIR Antigen Group Code
23.57 AIR Body Site
23.58 AIR Consumer State Code
23.59 AIR Consumer Sub Status Code
23.60 AIR Diseases Covered
23.61 AIR Forecast Status
23.62 AIR HL7v2 Immunization Function Code
23.63 AIR Immunization Function Code (legacy)
23.64 AIR Indication Code
23.65 AIR Performer Health Worker Function
23.66 AIR Planned Event Date Type Code
23.67 AIR Processing Terms Code
23.68 AIR Related Person Relationship Code
23.69 AIR Route Code (Legacy HL7v2)
23.70 AIR Route of Administration
23.71 AIR Scheduled Event Type Code
23.72 AIR Serology Protection Code
23.73 AIR Status Reason Code
23.74 AIR Vaccine Product
23.75 Hl7v2_resultResult Code
23.76 AIR AGVS
23.77 AIR AGVS Schedule Type
23.78 AIR AGVS Series Type
23.79 AIR Consumer State
23.80 AIR Consumer Sub Status
23.81 AIR Event Type
23.82 AIR Forecast Status
23.83 AIR Immunisation Notification Action Code
23.84 AIR Operationoutcome Codes
23.85 AIR Planned Event Date Type Code System
23.86 AIR Planned Event Type
23.87 AIR Processing Terms
23.88 AIR Related Person Relationship Terms
23.89 AIR Serology Protection Terms Code System
23.90 AIR Status Reason Terms Code System
23.91 AIR Terms
23.92 Hl7v2 Result Code
23.93 NZVX Immunisation Code
23.94 AIR Route of Administration HL7v2 < -- > SNOMED
23.95 AIR Target Disease (SNOMED) < -- > AIR Vaccine (CVX)
23.96 AIR Vaccination Site HL7v2 < -- > SNOMED
23.97 AIR Vaccine Product TPUU (NZMT) < -- > AIR Vaccine (CVX)
23.98 Concept Map -- HL7v2 Immunization Function < -- > AIR Health Worker Function
23.99 Gender Code HL7v2 PID < -- > Administrative Gender used in FHIR R4
23.100 HL7v2 Serology Obs Value < -- > AIR Serology Protection Code
23.101 AIR Orchestration Service Immunisation Bundle Example
23.102 AIRBundleCarePlanExample
23.103 create-immunisation-operation-outcome-response
23.104 immunisation-update-request-message-1
23.105 immunisation-update-request-message-3
23.106 immunisation-update-response-message-match-quality
23.107 immunisation-update-response-message-meta-tag
23.108 Immunization Example 1
23.109 Immunization Example 2
23.110 Immunization Example with Match and Match Quality extension
23.111 Immunization Example with Match Quality extension
23.112 Planned Event Example
23.113 update-immunisation-request-response-message-1
23.114 update-immunisation-request-response-message-2
23.115 update-immunisation-response-message-1