Essential Reading

Comments

To comment or give feedback on our APIs go to the relevant  API forum.

Summary

See "Provider API User Interface – Introduction" within API Overview Documentation

Benefits

Makes it easier for the Provider to do things right first time.

Allows the software vendor to add value:

  • Provides 'interactions' in a way that flow within your application.

  • Extract and automate an API request from / to your stored database.

Authentication and access

Our APIs need an API key as well as a valid Health Secure Digital Certificate to submit requests in production and compliance environments. The Health Secure Digital Certificate is the same certificate Providers use to submit payloads using the current online service. This certificate is used to authenticate who the user submitting the request is. We need to authorise the certificate, contact Digital Operations to make sure the certificate is set up.

Specific terms of use

Claim: Any registered health practitioner with ACC can submit a claim, however for a claim to be registered the practitioner must be qualified. More information on who can register claims can be found on our "Who can lodge claims for different injuries" page.

Claim and Medical Certificate: Only medical practitioners (General Practitioners and Nurse Practitioners) can submit the time off work component.

Query Claim Status: Any registered health practitioner with ACC can use this service to find out basic claim details for a client.

Change of Diagnosis: Any registered health practitioner with ACC can change diagnosis where appropriate. More information about this can be found on the "Who can lodge claims for different injuries" page. 

Invoice & Query Invoice / Payment Status: These services are available if user is an authorised Vendor with ACC. This can be for clinical and non-clinical services provided on ACC's behalf.

Throttling and non-functional requirements

1. We've applied throttling to these APIs to protect against DDoS attacks. We've applied a limit of 50 requests per minute per API key.

2. These APIs will be available 23.5 x 6.5 which is figurative only and indicates that there's some time needed for planned maintenance windows and emergency fixes.

Testing

When testing, please use your own digital certificate and test vendor ID and provider ID details when submitting to the complianceenvironment. Each digital certificate will have specific permissions that it can access. If you do not have a digital certificate available or have not been issued a test vendor ID and/or a provider ID then contact the digital operations team via the contact us form.

Claim numbers that can be used in the compliance environment will also be allocated to each developer as there is a set number range that is available to submit into. These numbers for the compliance environment can be requested from the digital operations team through the contact us form.

The developer digital certificate, test provider ID, vendor ID and claim numbers will not be able to be used for production/live submissions.

Suggested scenarios to test

Our scenarios to test against for claims, claim queries and medical certificate and/or invoices, invoice queries and payment status should be completed and copies of the payload and response data should be kept as they will need to be passed to the digital operations team for verification purposes. Some tests will require screenshots of your system or the printed output from your system to be given to ACC to verify as well. There may be further testing and requirements which will be at ACC's discretion.

Production requirements

Once you've completed testing of your app in our compliance environment and want to put it into production, then you need to send a message requesting production access:

  • Contact the Digital Operations team at ACC via the contact us page.

  • Complete the Name, Email and Message fields in the form.

  • Select 'Request for production access' in the 'What are you contacting us about' field.

We'll contact you to discuss the process of getting your app into production as some apps will require certain criteria and testing scenarios to be completed before this access can be approved. The testing scenarios can be found here but there may be further testing and requirements which will be at ACC's discretion