AIR #
These endpoints allow you to report and update vaccinations directly to the Australian Immunisation Register, fetch the immunisation history details and a PDF, check if medical contraindications etc are recorded in the AIR database. See Services Australia for more information on AIR. See the Department of Health for more information for COVID-19 vaccination providers.
The examples demonstrate the different calls that are available in our AIR API. This sandbox environment uses bogus patients and providers and doesn’t transmit immunisation records to the live AIR environment.
There are some important UI requirements when building AIR applications using our API.
- As with all aspects of this API, your end users must be authenticated, and must be health care providers or their authorised staff.
- Individual information retrieved through the API can only be used for patient care, including assessing suitability for vaccination. No other purpose is authorised and is a breach of our terms of service
- The published list of vaccine codes should be available as a dropdown list in the UI where required. The current list can be found on this Services Australia page of Vaccine Code Formats or use our vaccine list endpoints to fetch the currently cached list.
- Significant errors, warnings and information messages and their codes must be displayed to the end users. Where specific text is required to comply with AIR requirements this is noted in the relevant section below.