Version Notes #

This is Version 2.0 of the Claiming.com.au Australian Immunisation Register (AIR) API.

Version 2.0 #

Version 2.0 Notes released 1 March 2021.

This version includes endpoints for the following AIR webservices functions:

Encounters - new fields for:
vaccine serial numbers;
Health Identifiers for provider and patient;
recording vaccines that were given overseas
Authorisation Access List - a list of AIR functions that a particular provider has been authorised by AIR to use, built into the /provider endpoint
Vaccine Codes - an endpoint to fetch and search the current list of vaccine codes, and equivalent vaccines
Individual Details - an endpoint to fetch the following
immunisation history (set by the user or others)
due vaccines
medical contraindication exemptions, if any have been recorded^
natural immunity exemptions, if any have been recorded^
indigenous status, if recorded in AIR ^
an Additional Vaccines Required indicator for certain high risk groups^
any vaccine trials the individual is enrolled in
an Action Required indicator if the individual has encounters that require correction.

(^ = these can be set by the user, and will be visible to others with AIR access)

Version 1.0 Notes released 1 July 2020.

This version is the initial release of our Claiming.com.au AIR API for the following AIR webservices functions:

Encounters - AIR version 1.0 (doesn’t support vaccine serial numbers or Health Idenitifiers)
Catchup Date if applicable, the date the individual is required to be up-to-date with any vaccinations due for Family Assistance purposes