Providers #

For API purposes, a Provider is a medical or allied health professional with a unique Medicare provider number, providing a type of service, and linked to an location. Each Provider is uniquely linked to one location and is identified by their provider number issued by Medicare.

This is distinct from a Practitioner - we define a Practitioner as a person who may have several provider numbers. A Practioner may therefore have different provider numbers linked to the same or different locations or even different software.

The rule is - a provider number can be linked to only one Minor ID/location. A provider number can not be linked to more than one software product

Note: that for AIR purposes, the provider can either have a:

• Medicare Provider Number issued to doctors, midwives and nurse practitioners; OR
• AIR Immunisation Provider Number issued to other vaccine providers such as pharmacists, councils etc. This is in the format State Code, 5 digits, Check character e.g. N94300H

GET - List all providers at a location #

Get a current list of all providers at a location. If the provider has ever interacted with AIR thorugh our API, the resposne will show a list of authorised actions for that provider.

{{base_url}}/{{version}}/providers?location={{location_id}}

Headers:

Params

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": [
    {
      "providerNumber": "2433421X",
      "name": "IGOR FULLER",
      "active": true
    },
    {
      "providerNumber": "2433411Y",
      "name": "Ethel Boykin",
      "active": true
    }
  ],
  "total": 2,
  "offset": 0
}

Headers:

POST - Add a provider to a location #

You can add one or more providers at a time to a location.

If the provider number is already registered with the API or if the provider number fails the provider checksum routine you will get an error.

{{base_url}}/{{version}}/providers?location={{location_id}}

Headers

Body

{
	"name": "Dmitry Bailey",
	"providerNumber": "2438081F"
}

Params

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 ' \
--data '{
	"name": "John Doe",
	"providerNumber": "1234560T"
}'

Example Response:

Body:

{
  "providerNumber": "1234560T",
  "name": "John Doe",
  "active": true,
  "locked": null
}

Headers:

PUT - Update an existing provider in a location #

You can change the name of the provider, and toggle their ‘active’ flag.

{{base_url}}/{{version}}/providers/{{provider_number}}?location={{location_id}}

Headers

Body

{
	"name": "Dimitry Bailey",
	"providerNumber": "{{provider_number}}",
    "active": true
}

Params

Example Request:

curl --location --request PUT 'https://sandbox.claiming.com.au/v2/providers/1234560T?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
	"name": "Jenny Doe",
	"providerNumber": "1234560T"
}'

Example Response:

Body:

{
  "providerNumber": "1234560T",
  "name": "Jenny Doe",
  "active": true,
  "locked": null
}

Headers:

DELETE - Remove an existing provider from a location #

{{base_url}}/{{version}}/providers/{{provider_number}}?location={{location_id}}

Headers

Params

Example Request:

curl --location --request DELETE 'https://sandbox.claiming.com.au/v2/providers/1234560T?location=25' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data ''

Example Response:

Body:

OK

Headers: