Release 4 of the API includes 70 new endpoints and 6 changes to existing endpoints.
This update includes endpoints to map the legacy id's when migrating to our new API's, and includes many new and migrated capabilities.
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
- GET /account-categories/:account-category-uuid - New endpoint
- CHANGE GET Account-Management/Accounts - Added new field called external-account-uuid
- CHANGE GET Account-Management/Accounts/:account-uuid - Added new field called external-account-uuid
View Billing Spec
Billing
- GET /subscriptions/:uuid/entitlements - New endpoint
- GET /invoices/invoice-contents - New Endpoint to retrieve invoice lines (not restricted to invoice)
View Calendar Spec
Calendar Management
- GET /waiting-times - New endpoint for appointment waiting times from arrival to status change (treatment started, treated, paid, etc)
- GET /waiting-times/:location-uuid - New endpoint
- GET /availability/:location-uuid/blocks - New endpoint is available
View Clinical Spec
Clinical
More endpoints have been made available to support adding clinical notes, see release notes for release 3 for other supporting endpoints.
- POST /clinical-notes - New endpoint to submit the clinical protocol and related questions.
- GET /clinical-notes/protocols/questions - New endpoint
- GET /clinical-notes/clinical-codes - New endpoint
- GET /clinical-notes/clinical-category - New endpoint
- GET /clinical-notes/clinical-code-categories - New endpoint
- GET /clinical-notes/clinical-code-categories/:uuid/clinical-codes - New endpoint
- GET /clinical-notes/answers - New endpoint
View Communication Spec
Communication and Document Management
- CHANGE POST /communication-logs - Added new fields to record message content.
- GET /communication-logs - New endpoint
- GET /communication-logs/:log-uuid/documents - New endpoint
- GET /document-templates - New endpoint
- GET /document-templates/:uuid - New endpoint
- GET /documents - New endpoint
- GET /documents/:document-uuid - New endpoint
View Contact Spec
Contact Management
It is now possible to view and manage notes on the contact, manage purge exemptions and update numbers, email addresses and mailing addresses.
Contact Notes
- GET /contacts/notes - New endpoint
- GET /contacts/notes/:note-uuid - New endpoint
- GET /contacts/:contact-uuid/notes - New endpoint
- POST /contacts/:contact-uuid/notes - New endpoint
- PATCH /contacts/notes/:note-uuid - New endpoint
- DELETE /contacts/notes/:note-uuid - New endpoint
Purge exemptions
- POST /contacts/:contact-uuid/purge-exemption - New endpoint
- GET /contacts/:contact-uuid/purge-exemption - New endpoint
- DELETE /contacts/purge-exemption/:purge-exemption-uuid - New endpoint
Contact Channels
- PATCH /contacts/numbers - New endpoint
- PATCH /contacts/emails - New endpoint
- PATCH /contacts/addresses - New endpoint
Data consent and Legacy Id's
- GET /contacts/data-consent - New endpoint
- GET /migration-contact-legacy-id - New endpoint for mapping v2 API to this v3 API.
View Formulary Spec
Formulary Management
Formulary now has the capabilities to manage specific characteristics of the formulary records.
- CHANGE Fields starting with "Compliance-reminder-" have been renamed to "treatment-reminders-"
- GET /formulary-groups - New endpoint (code groups in Merlin UI)
Formulary Document Templates
- GET :formulary-uuid/document-templates - New endpoint
- POST :formulary-uuid/document-templates - New endpoint
- PATCH :formulary-uuid/document-templates - New endpoint
- DELETE :formulary-uuid/document-templates - New endpoint
Composites
- GET composites - New endpoint
- DELETE composites/:composite-uuid - New endpoint
Send-to List
- GET /send-to-actions - New endpoint
- POST :formulary-uuid/send-to-actions/:send-to-action-uuid - New endpoint
- PATCH formulary-management/:formulary-uuid/send-to-actions - New endpoint
- DELETE :formulary-uuid/send-to-actions/:send-to-action-uuid - New endpoint
Discount categories
- POST :formulary-uuid/discount-categories - New endpoint
- PATCH :formulary-uuid/discount-categories/:discount-category-uuid
- DELETE :formulary-uuid/discount-categories/:discount-category-uuid - New endpoint
Formulary Notes
- POST :formulary-uuid/notes - New endpoint
- PATCH :formulary-uuid/notes/:formulary-note-uuid - New endpoint
- DELETE :formulary-uuid/notes/:formulary-note-uuid - New endpoint
Dispensing Notes
- GET /dispensing-notes - New endpoint
- POST :formulary-uuid/dispensing-notes - New endpoint
- PATCH :formulary-uuid/dispensing-notes - New endpoint
- DELETE :formulary-uuid/dispensing-notes/:dispensing-note-uuid - New endpoint
Healthcare Plans
- GET /plan-locations - New endpoint
- GET /plan-groups - New endpoint
- GET /plans - New endpoint
- GET /plans/:uuid/contents - New endpoint
Legacy Identifiers
- GET /migration-formulary-legacy-id - New endpoint for mapping v2 API to this v3 API.
View Inventory Spec
Inventory Management
- GET /levels - New endpoint to retrieve current inventory levels
- CHANGE GET suppliers - Endpoint updated (removed description)
- CHANGE GET suppliers/:uuid - Endpoint updated (removed description)
- GET /manufacturer - New endpoint
- GET /manufacturer/:uuid - New endpoint
View Location Spec
Location Management
- GET /migration-location-legacy-id - New endpoint for mapping v2 API to this v3 API.
View Patient Spec
Patient Management
- PATCH /patient/:uuid/activate - New endpoint to reactivate a patient record
- PATCH /patients - New endpoint
- DELETE /patients/:uuid - New endpoint to deactivate a patient
- GET /migration-patient-legacy-id - New endpoint for mapping v2 API to this v3 API.
- GET /insurance-companies - New Endpoint
- GET /insurance-companies/:uuid - New Endpoint
Marathon over, have a 🍪
If you have any questions please contact us.