Skip to main content

API R14

· 2 min read
Craig Herrington

Release 14 of the API includes 7 new endpoints and 6 changes to existing endpoints.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

Release Date

The UAT API will be updated week commencing 30th September 24.

The Live API release date is to be confirmed, no downtime is expected.

View Billing Spec

Billing​

NEW GET /v1/api/:billing-uuid/invoices

  • New endpoint to return all invoices for an account with a filter option for unpaid-only.

CHANGE POST /v1/api/payments

  • Added new payload field isDeposit to allow recording of payments in advance of treatment without automatic allocation.
View Calendar Spec

Calendar Management​

CHANGE GET /v1/api/appointments/:appointment-uuid/statuses

  • Added display-order with priority in ascending order
  • Added the denormalised status description.
View Clinical Spec

Clinical​

NEW GET /v1/api/prescriptions/deleted

  • New endpoint to retrived deleted product prescriptions (basic prescriptions).

CHANGE GET /v1/api/prescriptions

  • Added modified-start and modified-end query parameters.

NEW GET /v1/api/advanced-prescriptions

  • New endpoint retrieve a range of advanced prescriptions (active ingredient prescription).

NEW GET /v1/api/advanced-prescriptions/:adv-prescription-uuid

  • New endpoint retrieve an advanced prescriptions (active ingredient prescription).

NEW GET /v1/api/advanced-prescriptions/action-history

  • New endpoint retrieve the activity on an a range of advanced prescriptions (active ingredient prescription).

NEW GET /advanced-prescriptions/:adv-prescription-uuid/action-history

  • New endpoint retrieve the activity on an advanced prescription (active ingredient prescription).
View Formulary Spec

Formulary Management​

CHANGE GET /v1/api/stock

  • Added modified-date to the body.

CHANGE GET /v1/api/services

  • Added modified-date to the body.
View Patient Spec

Patient Management​

CHANGE GET /v1/api/patients/{patient-uuid}/eligibility-activation

  • A defect 🐛 has been fixed, this was incorrectly responding that eligibility was already active.
View Reminder Spec

Reminders​

NEW GET /v1/api/treatment-reminders/deleted

  • A new endpoint which will return deleted treatment reminders (compliance reminders).
  • Includes query parameters allowing for delta requests on reminder date and deleted date.

If you have any questions please contact us.