Authorisation Access #
Providers must be authorised by AIR to access information. In some cases this will need to be set up by the provider with AIR before they can use our API to access information.
Note: Medical practitioners, midwifes and nurse practitioners with a Medicare provider number are automatically recognised as vaccination providers and are authorised to record or get immunisation data on the AIR. There should be no need to register with AIR separately.
Other vaccination providers without a Medicare provider number can apply to become a recognised vaccination provider through AIR. See this Services Australia page to register as a vaccination provider Note that some vaccination provider types must be endorsed by their state or territory health department, so carefully read the instructions on the form before submitting it to Services Australia.
On the first attempt to make any AIR call, the API will check if the provider has AIR Authorisation Access. If the information provider number is validated then the API will fetch details of their eligibility to access to specific AIR functions. This will be recorded in the provider record on the API database. You can view this by fetching the provider list for this location.
When making other calls to our AIR endpoints, you can use one or more of: the provider number, the HPIO number ot the HPII number to identify the provider
NOTE This API cannot look up Healthcare Identifiers. See this page on the Services Australia website for more information on Health Identifiers.
GET - List all providers at a location
#
The current list of all providers at a location will show AIR Access details for the providers who have attempted at least one call to AIR. The current AIR functions are listed here. In practice a provider who is authorised to access AIR would generally have access to all these functions.
- IDV - Identify individual details
- RECENC - Record encounter
- RECUPD - Update vaccination encounter
- GETIHS - Get immunisation history details
- IHSPDS - Get immunisation history statement in PDF format
- GETMEDCON - Get medical contraindication history
- GETNATIMM - Get natural immunity history
- GETVACTRL - Get vaccine trial history
- NXTDUE - Record planned catchup date
- IDGST - Update Indigenous status
- ADINDT - Add/Remove additional vaccine indicator for high risks
- NATIMM - Record natural immunity
- MEDCON - Record medical contraindication
This Access list is read-only, to change it the provider must contact AIR directly.
{{base_url}}/{{version}}/providers?location={{location_id}}
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Params
| Param | value |
|---|---|
| location | {{location_id}} |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/providers?location=25' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"items": [
{
"id": 640,
"providerNumber": "2408271B",
"name": "Merril Lachlan",
"active": true
},
{
"id": 1369,
"providerNumber": "2433421X",
"name": "Igor Fuller",
"active": true,
"airAuthorisationList": [
{
"name": "Identify individual details",
"code": "IDV",
"hasAccess": true
},
{
"name": "Update Indigenous status",
"code": "IDGST",
"hasAccess": true
},
{
"name": "Add/Remove additional vaccine indicator",
"code": "ADINDT",
"hasAccess": true
},
{
"name": "Record natural immunity",
"code": "NATIMM",
"hasAccess": true
},
{
"name": "Record medical contraindication",
"code": "MEDCON",
"hasAccess": true
},
{
"name": "Update vaccination encounter",
"code": "RECUPD",
"hasAccess": true
},
{
"name": "Record encounter",
"code": "RECENC",
"hasAccess": true
},
{
"name": "Record planned catchup date",
"code": "NXTDUE",
"hasAccess": true
},
{
"name": "Get immunisatiom history statement in PDF",
"code": "IHSPDS",
"hasAccess": true
},
{
"name": "Get immunisation history details",
"code": "GETIHS",
"hasAccess": true
},
{
"name": "Get medical contraindication history",
"code": "GETMEDCON",
"hasAccess": true
},
{
"name": "Get natural immunity history",
"code": "GETNATIMM",
"hasAccess": true
},
{
"name": "Get vaccine trial history",
"code": "GETVACTRL",
"hasAccess": true
}
]
},
{
"id": 1371,
"providerNumber": "2433411Y",
"name": "Ethel Boykin",
"active": true,
"airAuthorisationList": [
{
"name": "Identify individual details",
"code": "IDV",
"hasAccess": true
},
{
"name": "Update Indigenous status",
"code": "IDGST",
"hasAccess": true
},
{
"name": "Add/Remove additional vaccine indicator",
"code": "ADINDT",
"hasAccess": true
},
{
"name": "Record natural immunity",
"code": "NATIMM",
"hasAccess": true
},
{
"name": "Record medical contraindication",
"code": "MEDCON",
"hasAccess": true
},
{
"name": "Update vaccination encounter",
"code": "RECUPD",
"hasAccess": true
},
{
"name": "Record encounter",
"code": "RECENC",
"hasAccess": true
},
{
"name": "Record planned catchup date",
"code": "NXTDUE",
"hasAccess": true
},
{
"name": "Get immunisatiom history statement in PDF",
"code": "IHSPDS",
"hasAccess": true
},
{
"name": "Get immunisation history details",
"code": "GETIHS",
"hasAccess": true
},
{
"name": "Get medical contraindication history",
"code": "GETMEDCON",
"hasAccess": true
},
{
"name": "Get natural immunity history",
"code": "GETNATIMM",
"hasAccess": true
},
{
"name": "Get vaccine trial history",
"code": "GETVACTRL",
"hasAccess": true
}
]
},
{
"id": 1373,
"providerNumber": "2148961J",
"name": "Pathology Provider",
"active": true,
"airAuthorisationList": [
{
"name": "Identify individual details",
"code": "IDV",
"hasAccess": true
},
{
"name": "Update Indigenous status",
"code": "IDGST",
"hasAccess": true
},
{
"name": "Add/Remove additional vaccine indicator",
"code": "ADINDT",
"hasAccess": true
},
{
"name": "Record natural immunity",
"code": "NATIMM",
"hasAccess": true
},
{
"name": "Record medical contraindication",
"code": "MEDCON",
"hasAccess": true
},
{
"name": "Update vaccination encounter",
"code": "RECUPD",
"hasAccess": true
},
{
"name": "Record encounter",
"code": "RECENC",
"hasAccess": true
},
{
"name": "Record planned catchup date",
"code": "NXTDUE",
"hasAccess": true
},
{
"name": "Get immunisatiom history statement in PDF",
"code": "IHSPDS",
"hasAccess": true
},
{
"name": "Get immunisation history details",
"code": "GETIHS",
"hasAccess": true
},
{
"name": "Get medical contraindication history",
"code": "GETMEDCON",
"hasAccess": true
},
{
"name": "Get natural immunity history",
"code": "GETNATIMM",
"hasAccess": true
},
{
"name": "Get vaccine trial history",
"code": "GETVACTRL",
"hasAccess": true
}
]
},
{
"id": 1374,
"providerNumber": "2437521F",
"name": "Emile Jackson",
"active": true
},
{
"id": 1376,
"providerNumber": "T45718B",
"name": "KNUT HEALTH78",
"active": true,
"airAuthorisationList": [
{
"name": "Identify individual details",
"code": "IDV",
"hasAccess": true
},
{
"name": "Update Indigenous status",
"code": "IDGST",
"hasAccess": true
},
{
"name": "Add/Remove additional vaccine indicator",
"code": "ADINDT",
"hasAccess": true
},
{
"name": "Record natural immunity",
"code": "NATIMM",
"hasAccess": false
},
{
"name": "Record medical contraindication",
"code": "MEDCON",
"hasAccess": false
},
{
"name": "Update vaccination encounter",
"code": "RECUPD",
"hasAccess": true
},
{
"name": "Record encounter",
"code": "RECENC",
"hasAccess": true
},
{
"name": "Record planned catchup date",
"code": "NXTDUE",
"hasAccess": true
},
{
"name": "Get immunisatiom history statement in PDF",
"code": "IHSPDS",
"hasAccess": true
},
{
"name": "Get immunisation history details",
"code": "GETIHS",
"hasAccess": true
},
{
"name": "Get medical contraindication history",
"code": "GETMEDCON",
"hasAccess": true
},
{
"name": "Get natural immunity history",
"code": "GETNATIMM",
"hasAccess": true
},
{
"name": "Get vaccine trial history",
"code": "GETVACTRL",
"hasAccess": true
}
]
},
{
"id": 1377,
"providerNumber": "N94300H",
"name": "AIR Test Provider",
"active": true
},
{
"id": 1378,
"providerNumber": "1234560T",
"name": "Ethel Boykin",
"active": true
}
],
"total": 8,
"offset": 0
}
Headers:
| Header | Value |
|---|---|
| Server | nginx/1.19.3 |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 5022 |
| Connection | keep-alive |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |