Claiming.com.au AIR API v2.0 #
Welcome to our detailed V2 testing environment for the Australian Immunisation Register (AIR) features of the Claiming.com.au API.
The AIR functions in V2 of the Claiming.com.au API includes:
- Fetching as access list - a list of AIR functions that AIR has authorised for a particular provider number
- Adding and updating vaccine details, including vaccines given overseas
- Adding a catchup date (for Family Assistance purposes)
- Adding any medical contraindications
- Adding natural immunity exemptions
- Adding or removing a risk factors indicator
- Adding or removing an indigenous indicator
- Fetching individual details recorded in AIR including:
- the immunisation history details
- the immunisation history as a PDF
- a list of vaccines due
- medical contraindications
- natural immunity exmptions
- vaccine trials
- the risk factors for additional vaccinations indicator, if set
- the indigenous status of the patient, if set
You will need oAuth credentials issued by Claiming.com.au to use the examples here as you develop your own integration. If you don’t already have them, contact us at support@claiming.com.au and we will help you to set up oAuth access to our developer environment. If you already have dev oAuth credentials, add them in the API tool environment variable.
Note that both the demo and sandbox server can only access dummy patients. Test data can be requested at support@claiming.com.au. Once you have completed integration testing we will issue oAuth credentials to access to the Claiming.com.au production environment.