Skip to main content

API R11

· 2 min read
Craig Herrington

Release 11 of the API includes 4 new endpoints and 5 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 Billing Spec

Billing​

  • GET invoice-contents/deleted - Returns any invoice lines that have been deleted with the option to query by the deleted date.
View Calendar Spec

Calendar Management​

  • CHANGE GET /waiting-times - The data returned has been optimised to return the waiting times for the last 24 hours regardless of timezone; No API schema changes.
View Communications Spec

Communications​

  • CHANGE POST /documents/upload - Backend Service updated to handle more storage providers; No API schema or behaviour changes.
View Contact Spec

Contact Management​

  • SPEC POST /contacts/:contact-uuid/data-consent - Updated behaviour and schema; A new field called terms-accepted has been added to record a terms and condition acceptance. Now when the data-consent-type-uuid is provided then the communication preferences are is collated into the consent history with the consent expiration automatically set. data-consent-type-uuid and/or terms-accepted is expected.
View Inventory Spec

Inventory Management​

  • POST /suppliers/:supplier-uid/supplier-lists - A new endpoint to post the latest price list to update formulary cost prices and orderable products within wholesale. Note: This API is asynchronous and will provide a job-uuid in response.
  • GET /suppliers/product-lists/:job-uuid/status - A new endpoint to retrieve the status of the submitted job for POST supplier-lists. The response will inform if it is running, completed or failed including any errors that occured.
View Patient Spec

Patient Management​

  • CHANGE GET /patients - last-visit-date field has been added to the body.
View Reminders Spec

Reminders​

  • CHANGE GET /patient-reminders - 2 fields added: modified-date and created-date along with 2 new query parameters: modified-start and modified-end .
  • GET /patient-reminders/deleted - New endpoint for retrieving reminders that have been deleted (rather than deactivated) which supports query parameters on location, contact, patient, due date and deleted date.

If you have any questions please contact us.