Specifications & Guides

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 

Outlines ACC's Design Primitives transport, URI design, standards, representation & more. [184 KB]

Specifies the API for adding a new diagnosis to a submitted claim, or changing / deleting an existing diagnosis. [366KB]

Claim API Software specification [717 KB]

Describes functions, components, and validation common to all the APIs [860 KB]

Specifies hot to use the HCSS API accept data for new reporting requirements [492 KB]

HCSS API Clause Definition [198 KB]

Specification to enable a health provider to find information about and ICP Case (Incapacity & WC Details) [268 KB]

Invoice API software specification [483 KB]

Specifies the API for submitting a medical certificate request for processing by the eGateway [645 KB]

Query Claims API software specification [458 KB]

Specification to enable a health provider to find information about claims that have been submitted to eChannel [598 KB]

Inbound Documents API software specification [401 KB]

Inbound Documents API software specification [363KB]

673
24