Skip to main content

API R27

· 2 min read
Craig Herrington

Release 27 of the API includes 3 new endpoints and changes to 3 existing endpoints.

Release Date

The UAT API will be updated on 25-Nov-2025.

The Live API release date is 03-Dec-2025.

Times may change without notice, no downtime of the API is expected.

View Billing Spec

Billing​

NEW GET /v1/api/insurance/claim-items/patient/:patient-uuid

  • A new endpoint to retrieve a list of all insurance items against a patient. Optional query parameter insurance-claim-ref can be provided to filter items by claim reference.
  • New scope required: billing-acc:insurance:read

CHANGE GET /v1/api/payments

  • The endpoint now excludes returned payments from the response, returning only active payments.

CHANGE GET /v1/api/invoices/invoice-contents

  • New optional query parameter insurance-claim-ref added. When provided, only invoice contents with a matching insurance claim reference will be returned. A value of 0 will return a 400 error.
View Clinical Spec

Clinical Management​

NEW GET /v1/api/clinical-documents

  • A new endpoint to retrieve a list of clinical history documents. Supports optional query parameters for patient-uuid, modified-start, and modified-end for filtering.
  • Uses existing scope: clinical:history:read
View Communications Spec

Communication and Documents​

NEW GET /v1/api/documents/:document-uuid/content

  • A new endpoint to retrieve the file content of a document as an octet stream.
  • New scope required: document-mgt:docs-contents:read
  • Note: This endpoint is rate limited and may return status code 429 (Too Many Requests) if the rate limit is exceeded.
View Patient Spec

Patient Management​

CHANGE GET /v3/api/patient-subsidy-categories

  • Resolved an issue where the V3 API behavior did not align with the Merlin UI.

If you have any questions please contact us.