Skip to main content

API R12

· 2 min read
Craig Herrington

Release 12 of the API includes 9 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 on 14-June-2024 during UK working hours.

The Live API will be updated on 19-June-2024 between 21:00 and 23:00 BST.

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

View Contact Spec

Contact Management​

  • Added 2 query parameters for region-uuid and array of location-uuids; You can supply a maximum of 10 locations.
    • CHANGE GET /contacts/numbers
    • CHANGE GET /contacts/emails
region-uuid

region-uuid is only applicable for tenants using region visibility logic in Merlin.

The region will assigned to the location in the /locations endpoint if available.

View Patient Spec

Patient Management​

  • Added 3 note fields conditions, notes and notes-popup to the payload or response in the following endpoints:
    • CHANGE GET /patients
    • CHANGE GET /patients/:patient-uuid
    • CHANGE POST /patients
    • CHANGE PATCH /patients
View Reminders Spec

Reminders​

  • OPTIMISED GET /patient-reminders - Optimisation on this endpoints data querying.
  • OPTIMISED GET /patient-reminders/deleted - Optimisation on this endpoints data querying.
  • OPTIMISED GET /treatment-reminders - Optimisation on this endpoints data querying.

If you have any questions please contact us.