Claim and Query Claim Status

claims/claimid

GET

claims/summary/claimid

Description

This API allows for a provider to query the details of a submitted claim by specifying the 40 character claim ID. Returns results limited to the organisation that submitted the claims.

The details include all the fields that were submitted within the claim.

A valid, authorised query from the following endpoint returns complete details of the selected claim request, in its submitted status whether Failed or Receipted.

Results generally include, for each claim retrieved:

  • ACC45 number or Eos number
  • claim number
  • cover status
  • injury details*
  • partial NHI number*
  • accident date*
  • diagnoses*, including for each diagnosis:
    • code type and code, with the SNOMED code if available
    • diagnosis action, description, and side
    • the registration status (see Table 4 for possible values)
    • any error codes
  • the result code (0 or 1) for each diagnosis.

To learn more about the overall API process check out Get ConnectedLearn More and our Release Notes.

Other API Query related solutions you may find of interest can be found in Potential Query API Solutions and Query APIs – Detail that may assist.

 

* If the claim is sensitive, or the patient is working for an accredited employer, the starred details are not available.

Resource Summary

Security

Type

application/json

Category

Query Claims

URL

https://provider.api-compliance.acc.co.nz/api/v2/claims

Supporting Documentation

Query Parameters


Name Values Description
claimId
(required)

claimId


Request Body

claimId

Operations

When using the API Key custom token in the Operations portion for any selected API below, set NAME to 'apikey', VALUE to My Apps, Consumer Key value, and select the HEADER option before clicking SET.

Basic HTTP authentication

Set

OAuth 2 authentication

Set

API Key custom token

Set

Working...

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 200

    Ok

  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error