Claiming API AIR Documentation

Welcome to Claiming.com.au AIR API

Welcome to our detailed V2 testing environment for the Australian Immunisation Register (AIR) features of the Claiming.com.au API. This collection also covers the required endpoints for authenticating with the API, creating locations and adding providers. Our support staff are able to assist you with these steps to meet your particular needs. We have also included the optional verify endpoints should you wish to implement that functionality.

The AIR functions in V2 of the Claiming.com.au API include

  • 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.

Getting Started #

  1. Obtain oAuth credentials - Contact support@claiming.com.au
  2. Set up API - Setup your preferred API tool
  3. Explore the API - Browse the documentation sections in the sidebar

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.