API R17

Release 17 of the API includes 8 new endpoints and 2 change 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 the week of 10-Feb-2025.

The Live API release date is 19-Feb-2025 between 20:00 and 00:00 UTC.

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

---

View Clinical Spec

Clinical

NEW GET /v1/api/clinical-notes/search

• This now allows searching of saved clinical notes by providing optional parameters from location, dates, patient, practitioner, appointment or account UUID's.

NEW GET /v1/api/clinical-notes

• Retrieve clinical notes by providing a list of clinical note uuid's (max 10).

NEW GET /v1/api/clinical-notes/{clinical-note-uuid}

• Retrieve clinical note by the specific note uuid.

NEW DELETE /v1/api/clinical-notes/{clinical-note-uuid}

• Delete a clinical note by the specific note uuid.

NEW PATCH /v1/api/clinical-notes

• Update the clinical note, this API requires the supply of the modified date of the clinical record to validate your delta of the record is the latest state.

CHANGE POST /v1/api/clinical-notes

• Added additional fields:
  • external-url-key Will restrict ownership of the note to your app, contact MWI Support to register a unique key within the tenant.
  • billing-uuid requirement has been removed.
  • clinical-date is no longer mandatory and will default to the current date and time.
  • answer-free-text has the maximum length defined.

---

View Communications Spec

Communications

NEW GET /v1/api/document-templates/{document-template-uuid}/content

• Response streams the template docx document.

NEW GET /v1/api/sms-templates

• Returns all SMS template content.

NEW GET /v1/api/sms-templates/{sms-uuid}

• Returns the specific SMS template content.

CHANGE GET /v1/api/document-templates

• New ENUM type added for PAYMENT-LINKS

---

If you have any questions please contact us.