Upload Documents

uploaddocument

POST

uploaddocument

Description

Allows software vendors to create a new service with ACC; the submission of selected documents (in PDF format and up to a maximum size of 20MB) through the addition of set metadata. The documents are a secondary interaction generally linked to a Claim or resulting invoice.

Discussion with your customers will determine which documents would add value and whether they wish to submit the documents at the same time as they submit a claim / invoice or later or both.

The permitted contentType for a specific user group, and sample documents for each document type, are specified on the Developer Resource Centre: https://developer.acc.co.nz/sample-inbound-documents

Resource Summary

Security

Type

multipart/form-data

URL

https://apiservicesnpe.acc.co.nz/api/v2/documents

Supporting Documentation

Header Parameters


Name Values Description
ACC-CorrelationId
(required)

Unique UUID to track the incoming requests.

Body Parameters


Name Values Description
documentMetaData
(required)

Attachments


Name Value Description
document
(required)

Actual document (PDF) to be uploaded.

Request Body

Metadata as a JSON object. This should contain the additional information about the patient and the event that caused the document to be uploaded, such as claim number, event date, reason etc. An example:

{
    "contentType":"MMEXSPECR", (mandatory)
    "fileCreationDateTime":"2020041213113022", (yyyyMMddHHmmss)
    "runId":"666666",
    "claimReferenceNumber":"AC344433", (mandatory)
    "consultingProviderName":"Provider name",
    "dateOfConsult":"24-05-2020", (DD-MM-YYYY)
    "metaDataForContentType":"Metadata for content type string",
    "assessmentType":"Assessment type string",
    "bodySite":"Body site string",
    "clientNHINumber":"ABC1234",
    "clientFirstName":"First name", (mandatory)
    "clientLastName":"Last name", (mandatory)
    "clientDOB":"12-05-1956", (DD-MM-YYYY, mandatory)
    "fileExtension":"PDF" (mandatory)
}

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

    Accepted

  • 400

    Bad request, invalid request

  • 401

    Unauthorised, authentication error

  • 403

    Forbidden, unauthorised error

  • 500

    Internal server error