Version Notes

Version Notes #

This is Version 2 of the Claiming.com.au API

Version 2.0 (1 June 2021) is the initial release of v2 of our API.

We have designed v2 to be backwardly compatible with v1 so those making the transition should find it to be quite easy. To assist with the transition we have a separate v1 to v2 transition collection

The main points are:

  • v2 endpoints are fully compliant with the new Medicare Webservices.
  • Most v1 API endpoints rely on Medicare’s Client Adaptor technology. This will be deprecated in March 2022, so all vendors integrating with our API will need to transition to v2 well before then.
  • All v1 API functions are available in v2.
  • For clarity we have renamed auth_group to location throughout the API. The functionality is the same and the v1 syntax is still supported for backwards compatibility. To further simplify the request syntax, in v2 you can optionally use the actual MinorID string value SAPnnnnn in URLs and parameters. In v1 we used an integer as the UID. This is still supported in v2 for backwards compatibility. These three requests are synonymous for the location with id of 111 and MinorID of SAP12345:

New features in v2 #

v2 has a number of new functions:

  • Enhanced verification functionality. You can send a mix of information in a single verify request and the API will attempt to verify each type. Any request with Medicare information also returns the concession status of the patient.
  • Online Eligibility Checking. The new eligibility endpoint allows you to check certain Medicare eligibility criteria, and determine a patient’s Health Fund insurance levels, waiting periods and exclusions.
  • Overseas Claims functionality. We now support OVS type claims for visitors and students who are not eligible for Medicare but have insurance with a Fund.
  • Australian Immunisation Register. We have full AIR functionality, for further information see our AIR collection
  • ECLIPSE Participants endpoint. For those using any ECLIPSE functionality, we have introduced the participants function to retrieve the current list of Health Fund participating in ECLIPSE.
  • Callback functionality. For vendors wishing to receive ‘push’ notification of new processing reports and payments, we now have an optional callback functionality.
  • In Hospital Claims. We now support IHC claims for hospital services. Contact support@claiming.com.au if you’d like more information.

Version 2.1 #

This version 2.1 minor update adds the optional easyclaims endpoint. Medicare Easyclaim is a system that uses banking infrastructure and EFTPOS terminals to create and lodge Bulk Bill claims. This is know as the Easyclaim Web Service (BBeW).

The Claiming.com.au easyclaims endpoint is an alternative channel to retrieve BBeW Processing and Payment Reports for EasyClaims submitted through the banking infrastructure.

See the easyclaims node for sample requests and responses.