# AIR-ig#1.27.0: Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)

## Pages

* [Home](index.md)
* [AIR Consumer State - Mappings](StructureDefinition-air-consumer-state-mappings.md)
* [Request Headers](requestHeaders.md)
* [AIR Consumer State - Testing](StructureDefinition-air-consumer-state-testing.md)
* [General Notes](generalNotes.md)
* [Onboarding](onboarding.md)
* [AIR Consumer State - XML Representation](StructureDefinition-air-consumer-state.profile.xml.md)
* [Immunisation Event Upsert](immunisationEventUpsert.md)
* [Immunisation Event Search](immunisationEventSearch.md)
* [AIR Consumer State - Definitions](StructureDefinition-air-consumer-state-definitions.md)
* [Immunisations](immunisations.md)
* [Artifacts Summary](artifacts.md)
* [Immunisation Event Create](immunisationEventCreate.md)
* [Data Quality Rules](dataQualityRules.md)
* [AIR Consumer State - JSON Representation](StructureDefinition-air-consumer-state.profile.json.md)
* [Business Context](business-context.md)
* [Profiles](profiles.md)
* [History](history.md)
* [Immunisation Event Update](immunisationEventUpdate.md)
* [API](API.md)
* [Immunisation Update Message](immunisationUpdateMessage.md)
* [Use Cases](use-cases.md)
* [AIR Consumer State](StructureDefinition-air-consumer-state.md)
* [AIR Consumer State - TTL Representation](StructureDefinition-air-consumer-state.profile.ttl.md)
* [Immunisation Event Read](immunisationEventRead.md)
* [Careplan View](careplanView.md)
* [Duplicate Record Handling](duplicateRecordHandling.md)
* [Compliance Testing Base API Tests](complianceTestingBaseAPITests.md)
* [Scheduled Events](scheduled-events.md)
* [Terminology](terminology.md)
* [Extensions](extensions.md)
* [](StructureDefinition-air-consumer-state.profile.history.md)
* [Rejection Rules](rejectionRules.md)

## Resources

### CodeSystems

* [Hl7v2 Result Code](CodeSystem-Hl7v2-result.md)
* [AIR AGVS Schedule Type](CodeSystem-air-agvs-schedule-type.md)
* [AIR AGVS Series Type](CodeSystem-air-agvs-series-type.md)
* [AIR AGVS](CodeSystem-air-agvs-type.md)
* [AIR Consumer State](CodeSystem-air-consumer-state.md)
* [AIR Consumer Sub Status](CodeSystem-air-consumer-sub-status.md)
* [AIR Event Type](CodeSystem-air-event-type-1.0.md)
* [AIR Forecast Status](CodeSystem-air-forecast-status.md)
* [AIR Immunisation Notification Action Code](CodeSystem-air-immunisation-notification-action-code-1.0.md)
* [AIR Operationoutcome Codes](CodeSystem-air-operationoutcome-code-1.0.md)
* [AIR Planned Event Date Type Code System](CodeSystem-air-planned-event-date-type.md)
* [AIR Planned Event Type](CodeSystem-air-planned-event-type-terms.md)
* [AIR Processing Terms](CodeSystem-air-processing-terms.md)
* [AIR Related Person Relationship Terms](CodeSystem-air-related-person-terms.md)
* [AIR Serology Protection Terms Code System](CodeSystem-air-serology-protection-terms.md)
* [AIR Status Reason Terms Code System](CodeSystem-air-status-reason-terms.md)
* [AIR Terms](CodeSystem-air-terms-code.md)
* [NZVX Immunisation Code](CodeSystem-immunisation-code.md)

### ValueSets

* [AIR Administered Product Code](ValueSet-air-administered-product-code.md)
* [AIR Antigen Group Code](ValueSet-air-antigen-group-code.md)
* [AIR Consumer State Code](ValueSet-air-consumer-state-code.md)
* [AIR Consumer Sub Status Code](ValueSet-air-consumer-sub-status-code.md)
* [AIR Diseases Covered](ValueSet-air-disease-covered-code.md)
* [AIR Forecast Status](ValueSet-air-forecast-status-code.md)
* [AIR HL7v2 Immunization Function Code](ValueSet-air-hl7v2-imm-func-code.md)
* [AIR Immunization Function Code (legacy)](ValueSet-air-imm-func-code-code-legacy.md)
* [AIR Indication Code](ValueSet-air-indication-code.md)
* [AIR Performer Health Worker Function](ValueSet-air-performer-health-worker-function-code.md)
* [AIR Planned Event Date Type Code](ValueSet-air-planned-event-date-type-code.md)
* [AIR Processing Terms Code](ValueSet-air-processing-terms-code.md)
* [AIR Related Person Relationship Code](ValueSet-air-related-person-relationship-code.md)
* [AIR Route Code (Legacy HL7v2)](ValueSet-air-route-code-legacy.md)
* [AIR Route of Administration](ValueSet-air-route-code.md)
* [AIR Scheduled Event Type Code](ValueSet-air-scheduled-event-type-code.md)
* [AIR Serology Protection Code](ValueSet-air-serology-protection-code.md)
* [AIR Body Site](ValueSet-air-site-code.md)
* [AIR Status Reason Code](ValueSet-air-status-reason-code.md)
* [AIR Vaccine Product](ValueSet-air-vaccine-product-code.md)
* [Hl7v2_resultResult Code](ValueSet-hl7v2-result-1.0-code.md)

### Resource Profiles

* [Immunization Schedule Plan Definition](StructureDefinition-air-agvs-plan-definition.md)
* [AIR CarePlan Profile](StructureDefinition-air-careplan.md)
* [Immunization Dose Recommendation](StructureDefinition-air-dose-definition.md)
* [AIR Immunization Recommendation](StructureDefinition-air-immunization-recommendation.md)
* [AIR Immunization](StructureDefinition-air-immunization.md)
* [AIR Location Profile](StructureDefinition-air-location.md)
* [AIR Message Header](StructureDefinition-air-message-header.md)
* [AIR Patient Profile](StructureDefinition-air-patient.md)
* [AIR Practitioner Profile](StructureDefinition-air-practitioner.md)
* [AIR Related Person Profile](StructureDefinition-air-related-person-prf.md)
* [AIR Serology Report Profile](StructureDefinition-air-serology-report-profile.md)
* [TEST AIR Immunization Recommendation Profile](StructureDefinition-test-air-immunization-recommendation.md)

### Extensions

* [AIR Administered Product Extension](StructureDefinition-air-administered-product.md)
* [AIR Age Given Extension](StructureDefinition-air-age-given.md)
* [AIR Antigen Group Vaccination Schedule](StructureDefinition-air-agvs.md)
* [AIR Antigen Group Extension](StructureDefinition-air-antigen-group-extension.md)
* [AIR Consumer NIR Opt Off](StructureDefinition-air-consumer-nir-opt-off.md)
* [AIR Consumer State](StructureDefinition-air-recommendation-id.md)
* [AIR Consumer Sub Status](StructureDefinition-air-consumer-sub-status.md)
* [AIR Created By User](StructureDefinition-air-created-by.md)
* [AIR Created Source System](StructureDefinition-air-created-source-system.md)
* [Data Quality Assessment](StructureDefinition-air-data-quality-assessment.md)
* [Immunization Diluent](StructureDefinition-air-diluent.md)
* [AIR Disease Covered](StructureDefinition-air-disease-covered.md)
* [Air Immunisation Notification Action](StructureDefinition-air-immunisation-notification-action.md)
* [Immunization Facility Mobile Site](StructureDefinition-air-mobile-site.md)
* [AIR Modified By User](StructureDefinition-air-modified-by.md)
* [AIR Modified Source System](StructureDefinition-air-modified-source-system.md)
* [Performed Activity Extension](StructureDefinition-air-performed-activity-extension.md)
* [Planned Activity Reference Extension](StructureDefinition-air-planned-activity-reference-extension.md)
* [Planned Event Match Quality](StructureDefinition-air-planned-event-match-quality.md)
* [Planned Event Match](StructureDefinition-air-planned-event-match.md)
* [AIR Recommendation Id](StructureDefinition-air-recommendation-id.md)
* [AIR Related Person](StructureDefinition-air-related-person-extension.md)
* [AIR Reschedule Date Extension](StructureDefinition-air-reschedule-date.md)
* [Schedule Type Extension](StructureDefinition-air-schedule-type-extension.md)
* [AIR Scheduled Event](StructureDefinition-air-scheduled-event.md)
* [AIR Series Type Extension](StructureDefinition-air-series-type-extension.md)
* [AIR Serology Report Extension](StructureDefinition-air-serology-report-extension.md)
* [AIR Series Type Extension](StructureDefinition-air-timingAge-ISO8601-extension.md)
* [AIR Trigger Extension](StructureDefinition-air-trigger-extension.md)
* [AIR Data Quality Violation Detail](StructureDefinition-dq-violation.md)
* [AIR Data Quality Violation Array](StructureDefinition-dq-violations.md)

### CapabilityStatements

* [AIR FHIR Server Capability Statement](CapabilityStatement-AIRCapabilityStatement.md)

### ConceptMaps

* [Gender Code HL7v2 PID < -- > Administrative Gender used in FHIR R4](ConceptMap-air-gender-code-map.md)
* [Concept Map -- HL7v2 Immunization Function < -- > AIR Health Worker Function](ConceptMap-air-health-worker-function-map.md)
* [AIR Route of Administration HL7v2 < -- > SNOMED](ConceptMap-air-route-map.md)
* [HL7v2 Serology Obs Value < -- > AIR Serology Protection Code](ConceptMap-air-serology-protection-code-map.md)
* [AIR Vaccination Site HL7v2 < -- > SNOMED](ConceptMap-air-site-map.md)
* [AIR Target Disease (SNOMED) < -- > AIR Vaccine (CVX)](ConceptMap-air-target-disease-map.md)
* [AIR Vaccine Product TPUU (NZMT) < -- > AIR Vaccine (CVX)](ConceptMap-air-vaccine-product-map.md)

### ImplementationGuides

* [Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)](index.md)

### MessageDefinitions

* [UpdateImmunisationRequestMessageDefinition](MessageDefinition-UpdateImmunisationRequestMessageDefinition.md)
* [UpdateImmunisationResponseMessageDefinition](MessageDefinition-UpdateImmunisationResponseMessageDefinition.md)

### OperationDefinitions

* [Search for Immunisation Events Using Data Quality Parameters](OperationDefinition-Data-quality.md)
* [Bulk Update Immunisation Event](OperationDefinition-Immunization-bulk-update.md)
* [Upsert Immunisation Event](OperationDefinition-Immunization-upsert.md)
* [Patient History](OperationDefinition-Patient-History.md)
* [Reassign Patient Schedules](OperationDefinition-Reassign-patient-schedules.md)
* [Update AIR patient state](OperationDefinition-Update-patient-state.md)

### SearchParameters

* [StatusSearchParameter](SearchParameter-Immunization-Status.md)
* [StatusReasonSearchParameter](SearchParameter-Immunization-StatusReason.md)

### Examples

* [72178030 (Bundle)](Bundle-72178030.md)
* [82020190 (Bundle)](Bundle-82020190.md)
* [AIRBundleCarePlanExample (Bundle)](Bundle-AIRBundleCarePlanExample.md)
* [AIRBundleOrchestrationExample (Bundle)](Bundle-AIRBundleOrchestrationExample.md)
* [update-immunisation-response-message-1 (Bundle)](Bundle-update-immunisation-response-message-1.md)
* [imm-example-1 (Immunization)](Immunization-imm-example-1.md)
* [imm-example-2 (Immunization)](Immunization-imm-example-2.md)
* [imm-example-match-quality (Immunization)](Immunization-imm-example-match-quality.md)
* [imm-example-match (Immunization)](Immunization-imm-example-match.md)
* [immunisation-update-response-message-match-quality (Immunization)](Immunization-immunisation-update-response-message-match-quality.md)
* [immunisation-update-response-message-meta-tag (Immunization)](Immunization-immunisation-update-response-message-meta-tag.md)
* [ir1 (ImmunizationRecommendation)](ImmunizationRecommendation-ir1.md)
* [create-immunisation-operation-outcome-response (OperationOutcome)](OperationOutcome-create-immunisation-operation-outcome-response.md)
* [update-immunisation-request-response-message-1 (OperationOutcome)](OperationOutcome-update-immunisation-request-response-message-1.md)
* [update-immunisation-request-response-message-2 (OperationOutcome)](OperationOutcome-update-immunisation-request-response-message-2.md)
