Release 5 of the API includes 28 new endpoints and 16 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
Release notes are provided early, the actual release date will be communiated to all parties directly.
View Account Spec
Account Management
- CHANGE GET accounts - Added new field for account-type-uuid
- CHANGE POST accounts - Added new field for external-account-uuid
- CHANGE GET accounts/:account-uuid - Added new field for account-type-uuid
- PATCH /accounts - New endpoint
View Calendar Spec
Calendar Management
- GET tasks - New endpoint for retrieving tasks from day lists such as repeat prescriptions requests
- POST tasks - New endpoint to add tasks to task-lists (day lists)
- GET task-lists/task-lists-types - New endpoint
- GET task-lists - New endpoint for retrieving the day list columns.
- GET task-lists/:id - New endpoint
- CHANGE GET appointments - This list will now correctly not show non-practitioner tasks/appointments.
- CHANGE GET appointments - This now returns the online-booking flag
- CHANGE GET appointments/:uuid - This now returns the online-booking flag
- CHANGE GET appointments/deleted - This list will now correctly not show updated appointments
View Clinical Spec
Clinical
- GET /history/patient-formulary-summary - New endpoint to retrieve statistics on dispensed/prescribed items
- CHANGE POST billable-records - Update to include recorded microchip number, batch number and if it is part of a composite arrangement.
- CHANGE GET clinical/deleted - Corrected to not return updated records, only deleted records.
View Contact Spec
Contact Management
Contacts
- CHANGE GET contacts - Added missing title-uuid
- CHANGE GET contacts/:uuid - Added missing title-uuid
- CHANGE PATCH contacts - Added missing title-uuid
- CHANGE POST contacts - Added missing title-uuid
- DELETE contacts/:contact-uuid/addresses/:address-uuid - New endpoint
- DELETE contacts/:contact-uuid/numbers/:number-uuid - New endpoint
- DELETE contacts/:contact-uuid/emails/:email-uuid - New endpoint
Charity Eligibility
- GET contact/:contact-uuid/eligibility-registration - New endpoint for charity systems.
- GET eligibility/presented-identification/:elgibibility-identification-uuid - New endpoint for charity systems
- GET eligibility/presented-identification - New endpoint for charity systems.
- GET eligibility/presented-documents - New endpoint for charity systems.
- GET eligibility/presented-documents/:eligibility-document-uuid - New endpoint for charity systems.
- GET eligibility/activation-reasons/:activation_reason_uid - New endpoint for charity systems
- GET eligibility/activation-reasons - New endpoint for charity systems
Disciplines
- CHANGE GET practitioners - Added disciplines list.
- CHANGE GET practitioners/:uuid - Added disciplines list.
- GET practitioners/:uuid/disciplines - New endpoint
- POST practitioners/:uuid/disciplines - New endpoint
- DELETE practitioners/:uuid/disciplines - New endpoint
View Formulary Spec
Formulary Management
- CHANGE GET stock - Added new query parameter for request-repeat-prescription flag.
- POST composites - New endpoint
- POST stock - New endpoint
- POST services - New endpoint to add Services including Discount Codes
- PATCH stock - New endpoint
- PATCH services - New endpoint for updating Service formulary records, including discount codes.
View Location Spec
Location Management
- GET locations/:uuid/disciplines - New endpoint to support new functionality within Merlin.
- POST locations/:uuid/disciplines - New endpoint to support new functionality within Merlin.
- DELETE locations/:uuid/disciplines - New endpoint to support new functionality within Merlin.
- GET disciplines - New endpoint to support new functionality within Merlin.
If you have any questions please contact us.