Providers

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 a 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. There are no restrictions on linking a Practioners different provider numbers 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

GET - List all providers at a location #

Get a current list of all providers at a location

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

Headers:

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
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": 1921,
      "providerNumber": "2433411Y",
      "name": "test 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
        },
        {
          "name": "Get immunisation record in PDF",
          "code": "CIRPDF",
          "hasAccess": false
        },
        {
          "name": "Get COVID-19 digital certificate in PDF",
          "code": "GETCOV19PDF",
          "hasAccess": false
        }
      ]
    }
  ],
  "total": 1,
  "offset": 0
}

Headers:

HeaderValue
Servernginx/1.19.3T
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length7061
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS

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 you will get an error.

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

Headers

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
location{{location_id}}

Body

{
	"name": "John Doe",
	"providerNumber": "1234560T"
}

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:

HeaderValue
Servernginx/1.19.3T
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length83
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS

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

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
location{{location_id}}

Body

{
	"name": "Jane Doe",
	"providerNumber": "1234560T",
    "active": true
}

Example Request:

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

Example Response:

Body:

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

Headers:

HeaderValue
Servernginx/1.21.0
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length83
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS

DELETE - Remove an existing provider from a location #

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

Headers

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
location{{location_id}}

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:

{
  "status": "OK",
  "message": "Provider 1234560T was successfully deleted from SAP01078"
}

Headers:

HeaderValue
Servernginx/1.19.3T
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length88
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS