Release Notes

Type

Summary

Integrated Home and Community Services API                                                            

Due to contract changes the number of endpoints for this service has decreased from 5 to 3. In addition, the remaining 3 endpoints have had the fields and validations changed to align with the data required going forward.

The endpoints being retired are:

·       Service_Consultation

·       Service_Review

The endpoints being updated are:

·       Service_Commencement will be named Service_Commencement_Declines

·       Service_Completion

·       Supplier_Review

Type

Summary

Medical Certificate and Change of Diagnosis API                                                               

We have made a minor enhancement to these products.

• Character limit for the "diagnosisDescription" field has been increased from 100 to 255 characters (including spaces)

Claim Query API                                                     

We have made a number of minor changes to our Claim Query API product. The following describes the changed behaviour:

• ACC45 number in both “acc45Number” and “claimNumber” fields
  There was an issue where the response for claim query would provide the ACC45 Number i.e. AA12345, in both the Claim Number and ACC45 number fields. This will be resolved and the appropriate claim identifiers will be returned in the relevant field.

• Reduce page size to be consistent with other APIs
  For the GET claims/status/filter endpoint, we had previously set the default page size to 100 as to not impact anyone who had not built in pagination yet. We have now set this to a reduced defaulted value of 25.

• Diagnosis Type in Query Claim Status returns as NULL when it is a mandatory field
  When querying a claim status, the returned response for the diagnosis code type would be null, but will now present a valid value of 1, 2, or 3 dependant on the injury code category.

Medical Certificate API

Non-breaking change providing the following enhancement:

Allow the additional diagnosis side location ‘Bilateral’ to be used for an Injury diagnosis (in addition to Left, Right and Not Applicable)

Change of Diagnosis API

Non-breaking change providing the following enhancement:

Allow the additional diagnosis side location ‘Bilateral’ to be used for an Injury diagnosis (in addition to Left, Right and Not Applicable)

Type

Summary

Inbound Documents API: (Version 2.2)                                                   

Enhancements to support an additional set of documents to be processed automatically downstream from the Inbound Documents API, supporting the Integrated Care Pathway Musculoskeletal contract go live. Additional validations added to trim uneccssary spaces provided as part of the submission, improving ACCs ability to process the document.

For all documents please see Developer Resource Centre | Sample Inbound Documents for details.

Type

Summary

Inbound Documents API: (Version 2.1)                                                    

Minor extension to the number of documents able to be submitted to ACC via the Inbound Documents API, primarily to support Integrated Care Pathway Musculoskeletal go live in early 2024. Additional validations added restricting the use of special characters within metadata, improving ACCs ability to process the submission.

For all documents please see Developer Resource Centre | Sample Inbound Documents for details.

Type

Summary

Claim API                                                            

Non-breaking change to Claim v2 providing the following enhancements:

• Allow the additional gender values of ‘Another Gender’ and ‘Unknown’ to be captured for a Patient (in addition to Male and Female)
• Allow the additional diagnosis side location ‘Bilateral’ to be used for an Injury diagnosis (in addition to Left and Right)
• Extend the maximum allowed length of patient names to 40 characters for first name/middle name and 50 characters for surname
• Return a more user-friendly error message when a technical problem is encountered during an attempted SNOMED code translation.

Type

Summary

Inbound Documents API:  (Version 2.0)                                                                

Extended the number of documents able to be submitted to ACC via the Inbound Documents API, to now support most of the regularly used document types (near on 500 now available). Additional validations to the metadata also included to improve ACCs ability to process the submission. For all documents now available, please see Developer Resource Centre | Sample Inbound Documents for details.

For all documents please see Developer Resource Centre | Sample Inbound Documents for details.

Type

Summary

Inbound Documents API:  (Version 1.2)                                        

Extended documents able to be submitted to ACC via the inbound documents API to include documents relating to acquired brain injury, dental and hearing loss.

For all documents please see Developer Resource Centre | Sample Inbound Documents for details.

Type

Summary

Claim API                      

Non-breaking change to Claim v2 to make the claim number an optional field. If claim number is not specificed upon submission, then the API will generate the claim number and it will appear in the API response message.

Claim API

New endpoint added for Claim API auto-numbering. This is to allow a GET request to retrieve a claim number which can then be used to submit a claim.

Claim API

The "referralReason" field is made optional.

Claim API

Claim API specification updated to reflect changes.

Type

Summary

All APIs

Response timeout increased from 30 seconds to 3 minutes. This is to accomodate large invoice payment queries which can take a while to respond.

Claim Query API

Updated the Claim Query by NHI + DOB (claims/status/filter) to now by default return 75 results instead of 25. This is to accomodate searching for client records, which may have more than 25 claims within a 5 year period. 

Medical Certificate API              

Introduced an optional field called "returnToNormalWorkDate" within the "workCapacity" section of the medical certificate.
Format: YYYY-MM-DD
The date on which the patient is expected to return to normal work duties (without restrictions).

Error responses associated with this field:

1. If an Incapacity is specified, the returnToNormalWorkDate (currently <input date>) must be after the last end date of the latest incapacity period (currently <lastToDate>).

2. The returnToNormalWorkDate cannot be before the accident date.

All APIs

During scheduled maintenance outages, APIs will now return a specific error message to notify users when they call the API

{"errors": [{
   "message": "This ACC API service is currently unavailable as it is undergoing maintenance. Please try again later.",
   "field": null
}]}

Type

Summary

Inbound Documents API             

Release of a new service providing the initial ability to send the following seven (7) documents types in PDF format:

• Extension of treatment requests – ACC32 (MMEX32PHY)
• Discharge and Operation reports (MMEXDISOP)
• Surgery requests and documentation (MMEXEARTP)
• Radiology reports (MMEXESHTI)
• High Tech Imaging (MMEXHSHTI)
• Guided Injection requests (MMEXPRAPR)
• Specialist / GP / Other treatment provider notes (MMEXSPECR).

Only one (1) document, up to a maximum size of 20 Mb, can be submitted per request.

Type

Summary

Invoice API

Changed the purchaseOrderNumber field max character length from '7' to '10'. This is to accomodate the change to purchase order numbers which will start to be issued with 8 digits.

Claim status query API                    

Resolved a defect where the claim status query API was incorrectly translating READ diagnosis codes to SNOMED, when in fact the diagnosis type was ICD10. Now, the API does not translate the diagnosis into SNOMED if the code is registered as ICD10.

Type

Summary

Claim API

Resolve a defect causing injury comments to sometimes be dropped

Invoicing query API

Resolve a defect causing an internal server error response when querying failed invoice submissions with invoice lines > 4

Claim API

Change the max value for restricted hours from '8' to '24'

Claim status query API              

Resolve an issue where an error is returned when querying a claim that has a value for injuryResolvedFromDate

Claim status query spec          

Minor spec change to show it's a list of key-value pairs when using POST claims/status query

Claim spec

Claim spec section 7.2.1 incorrectly states the employer name requirement.

To be updated so that it is shows required if employmentStatusCode is 1, and either:

- this is a work accident, or

- the claimant can't continue normal work;

otherwise, it's optional.

Claim spec

Section 9 of the Claim spec has a diagram for Fitness for work. It needs an extra decision row for the employment status code.

Invoice spec

The Invoice API spec section 5.1 refers 'invoice/invoiceNumber', but the JSON name implemented is 'invoice/invoiceID'.

Spec to be updated to reflect the API.

Claim swagger doc

The swagger has the NHI number as required, swagger update to make it optional to match the API.

Invoice/Claim query

Users that are tied to an organisation name that has special characters in the database are unable to use queries as it results in error 'must only contain alphanumeric characters (incl. blank)'.

Fixed to allow special characters in organisation names to return results from the database.

Claim Spec

Update the spec to include an error condition for workInjury field 'Work accident may not be true when inPaidEmployment is false.'

Claim API

Remove the error condition for return to work date "returnToNormalWorkDate is later than the first or only toDate + 1 day, and not later than the first or only fromDate + 15 days"

That is to allow a date gap in between the last ‘to date’ and the ‘return to normal work date’. This also means that the return to work date is optional.

Type

Summary

Invoice

‘invoiceId’ optional field to allow PMS vendors to use their own invoice numbers.

Invoice

API to automatically make alphabetic characters in the schedule number uppercase, preventing duplicates.

Invoice

New business rule: The invoice number must still start with a digit or letter (not 'W');  each remaining character can be a letter, digit, space, hyphen, or underscore.

Invoice

A 'success' response to a submitted invoice now uses 'invoiceId' consistently for the invoice number.

Claim

Make the validation on employer's name and address match the legacy system, that is:

• required when the claimant is an employee, and the claim is for a work accident, or the claimant can't continue normal work
• otherwise, employer's name and address are both optional.

Claim

Make the date range for a full incapacity period inclusive, as in the legacy system.  So 'fully unfit for work' from 10 Apr to 20 Apr:  11 days.

Claim spec             

Allow a maximum combined period of 14 days.  As implemented—this is a specification change only.

Claim

Make the employer's postcode and country optional.