Claim and Query Claim Status

claims/status/filter

GET

claims/status/filter

Description

One of a series of APIs that allows software vendors to give the ability for the Provider to see whether a claim has been accepted & what are the latest diagnoses if other Providers have been referred to.

This specific API returns the status of a selected claim submitted by the organisation sending the query.

A valid, authorised query from the following endpoint returns filtered 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.
*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

URL

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

Supporting Documentation

Query Parameters


Name Values Description
vendorId
(required)

vendorId

providerId
(required)

providerId

nhi
(required)

nhi

dateOfBirth
(required)

dateOfBirth


Request Body

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
  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error