Skip to main content

API R6

· 4 min read
Craig Herrington

Release 6 of the API includes 21 new endpoints and 11 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 originally published 10th May 2023.

Release notes are provided early, the actual release date will be communiated to all parties directly.

All Areas​

  • New Header - X-Correlation-Id header has been added to all endpoints. Use this to provide the unique identifier of your request for tracking through the MWI architecture. If this is not provided, we will provide a randomly generated UUID in the header response for your use.
View Billing Spec

Billing​

  • CHANGE GET subscriptions - Added new field for plan-uuid
  • GET /payments/summary - New endpoint to provide a summary of all payments between the provided filter dates.
  • CHANGE GET subscription-entitlement - Removed whitespace from field names (entitlement-content-uuid and quantity-used).
View Calendar Spec

Calendar Management​

  • DELETE tasks/:task-uuid - New endpoint for removing tasks from day lists such as repeat prescriptions requests
  • GET task-lists/locations - New endpoint for identifying which task-lists are present for locations.
  • POST availability - New endpoint for adding new availability
  • GET migration-appointment-legacy-id - New endpoint for mapping v2 API id's to this v3 API.
  • CHANGE GET task-list - Resolved an issue with the deactivated bool not returning the correct state.
View Clinical Spec

Clinical​

  • POST clinical-document - New endpoint to allocate an uploaded document to a clinical history. (This does not include upload of documents, due soon.)
  • GET prescriptions/mwi-pharmacy/cancel-request-statuses - New endpoint to show the status of a cancellation request.
  • GET prescriptions/mwi-pharmacy/species - New endpoint to see the MWI Pharmacy species for prescriptions.
  • GET prescriptions/mwi-pharmacy/statuses - New endpoint to see the MWI Pharmacy status for prescriptions.
  • GET prescription/dosage-measure - New endpoint for prescription instruction measures.
  • GET prescriptions/instruction-prefixes - New endpoint for prescription label prefixes.
  • GET prescriptions/statuses - New endpoint for all available prescription statuses.
  • GET prescriptions - New endpoint for prescriptions recorded.
  • GET prescriptions/:uuid - New endpoint for a specific prescription.
View Contact Spec

Contact Management​

  • PATCH :contact-uuid/communication-preferences - New endpoint to update communication preferences
  • CHANGE GET /practitioners/locations - No longer returns task-list entities.
  • CHANGE GET contacts/:contact-uuid/emails - Now has clean-email-address field with additional field text removed.
  • CHANGE GET contacts/emails - Now has clean-email-address field and the email search filter utilises the clean-email-address field only.
  • CHANGE GET contacts/:contact-uuid/numbers - Now has clean-number field with additional field text removed.
  • CHANGE GET contacts/numbers - Now has clean-number field and the number search filter utilises the clean-number field only.
  • POST contacts/:contact-uuid/eligibility-registration - New endpoint for charity systems. To be used in conjunction with /patient-management/patients/eligibility-deactivate
View Communication Spec

Communication & Document Management​

  • POST documents/upload - New endpoint to upload a new document to Merlin by stream, use the response with clinical-document to add the document to the patient history.
View Formulary Spec

Formulary Management​

  • PATCH location-deviations - New endpoint
View Inventory Spec

Inventory Management​

  • CHANGE batches - New field stock-level
  • CHANGE batches/:uuid - New field stock-level
View Patient Spec

Patient Management​

  • POST patients/:patient-uuid/eligibility-activation - New endpoint for charity systems to activate patient subsidy for the specified patient.
  • POST patients/eligibility-deactivate - New endpoint for charity system to deactivate eligibility subsidy on all patients for a specified account.
  • POST patients/:patient-uuid/eligability-deactivate - New endpoint to deactivate eligibility subsidy for a specified animal.

If you have any questions please contact us.