- Learn More
- Inbound Data APIs
- Specifications & Guides
Specifications & Guides
Support
- FAQs
- Ask the Forum
- Having trouble? Get in touch
Common API Specification
The Common API Specification describes functions, components, and validation common to all the APIs, in particular:
-
Lists the APIs, source documents, and common terminology
-
Outlines the common API Processing for all endpoints
-
Describes common data types and error messages
-
Specifies common data inputs, formats and validations for submitting a request and queries applying to 2 or more APIs, respectively
-
Describes translation of Read (or diagnosis) codes between ACC’s system and SNOMED codes
We highly recommend reading the Common API Specification before any development; see below.
Design Primitives
We recommend reading the ACC Design Primitives document below for insight into how ACC has put its APIs together.
Individual API Specifications
We recommend reading the applicable individual API specification below, in parallel with working with the swagger.
Downloads
API Design Primitives v1.0.pdf
Outlines ACC's Design Primitives transport, URI design, standards, representation & more. [184 KB]
Change Diagnosis API Specification v1.2 - April 2024.pdf
Specifies the API for adding a new diagnosis to a submitted claim, or changing / deleting an existing diagnosis. [366KB]
Claim API Specification v41 - April 2024.pdf
Claim API Software specification [717 KB]
Common API Specification v1.14 - May 2024.pdf
Describes functions, components, and validation common to all the APIs [860 KB]
HCSS-API-2019-v09 (Portal) .pdf
Specifies hot to use the HCSS API accept data for new reporting requirements [492 KB]
HCSS API Definitions v0.09 - Updated July 2022.pdf
HCSS API Clause Definition [198 KB]
ICP Query (Get Incapacity & WC Details) API Specification v1.1 - October 2023.pdf
Specification to enable a health provider to find information about and ICP Case (Incapacity & WC Details) [268 KB]
Invoice API Specification v33 - April 2023.pdf
Invoice API software specification [483 KB]
Medical Certificate Specification V26 - April 2024.pdf
Specifies the API for submitting a medical certificate request for processing by the eGateway [645 KB]
Query Claims Status API Specification v1.4 - September 2023.pdf
Query Claims API software specification [458 KB]
Query Invoices & Payments API Specification v1.1 for May 2018 Release.pdf
Specification to enable a health provider to find information about claims that have been submitted to eChannel [598 KB]
Inbound Documents Specification - API v1.21 - February 2024.pdf
Inbound Documents API software specification [401 KB]
Inbound Documents Specification - API v2.11 - February 2024.pdf
Inbound Documents API software specification [363KB]