Upload Documents

uploaddocument

POST

uploaddocument

Description

Allows software vendors to create a new service with ACC; the submission of selected documents (in PDF & up to a maximum 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 documents that can be submitted through this service will grow over time; the up to date list of options is published within the relevant Specification; Appendix 1.

Resource Summary

Security

Type

multipart/form-data

URL

https://provider.api-compliance.acc.co.nz/api/v1/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)

Metadata as 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. Format example can be

            {
"contentType":"", (Mandatory)
"fileCreationDateTime":"yyyyMMddHHmmss",
"runId":"",
"claimReferenceNumber":"",
"consultingProviderName":"",
"dateOfConsult":"DD-MM-YYYY",
"metaDataForContentType":"",
"assessmentType":"",
"bodySite":"",
"clientNHINumber":"",
"clientFirstName":"",
"clientLastName":"",
"clientDOB":"DD-MM-YYYY",
"fileExtension":"", (Mandatory)
}

Attachments


Name Value Description
document
(required)

Actual document (PDF) to be uploaded

Request Body

Metadata as 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. Format example can be
 {
"contentType":"", (Mandatory)
"fileCreationDateTime":"yyyyMMddHHmmss",
"runId":"",
"claimReferenceNumber":"",
"consultingProviderName":"",
"dateOfConsult":"DD-MM-YYYY",
"metaDataForContentType":"",
"assessmentType":"",
"bodySite":"",
"clientNHINumber":"",
"clientFirstName":"",
"clientLastName":"",
"clientDOB":"DD-MM-YYYY",
"fileExtension":"", (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

  • 429

    Too Many Requests

  • 500

    Internal server error

  • 503

    Service not available