Skip to main content

API R13

· 5 min read
Craig Herrington

Release 13 of the API includes 10 new endpoints and 19 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

The UAT API will be updated week commencing 19th August 24.

The Live API may be updated week commencing 26th August 24, no downtime is expected.

All Domains​

  • Update to all services from code maintenance.
View Billing Spec

Billing​

  • CHANGE GET /invoices - Added 3 new fields for insured totals (Net, Tax and Gross) where an insurance activity is recorded against the invoice.
  • OPTIMISED GET /payments - Performance has been improved when requesting using the modified dates.
  • CHANGE GET /subscriptions - Added new modified date query parameters
View Calendar Spec

Calendar Management​

  • CHANGE GET /availability - Resolved issued which could present a blocked slot as available.
  • CHANGE POST /appointments - Resolved issue which could allow booking of appointment into a blocked slot.
  • OPTIMISED GET /appointments - Improved Performance for requests with large results.
  • OPTIMISED GET /appointments/deleted - Improved Performance for requests with large results.
View Clinical Spec

Clinical​

  • CHANGE GET /vital-metrics/weight - The weight field now allows up to 8 decimal places to be returned for precise conversion.
  • CHANGE POST /vital-metrics/weight - The weight field now allows up to 8 decimal places to be submitted for precise conversion.
  • CHANGE GET /history - 4 new fields added with label instructions when available:
    • dispense-instruction
    • dispense-additional-information
    • dispense-commence-date
    • dispense-practitioner-uuid
  • NEW GET /advanced-prescriptions/suspend-reasons - New endpoint with reasons against advanced prescriptions, this is related to other upcoming advanced prescription endpoints.
  • NEW GET /advanced-prescriptions/suspend-reasons/:uuid - New endpoint.
View Contact Spec

Contact Management​

  • CHANGE POST contacts/:uuid/eligibility-registration - Resolved issue for charity eligibility registration causing a 500 error.
  • CHANGE GET /contacts/:uuid/data-consent - Now returns all data consent history records not only the 'client terms' records.
  • CHANGE GET /contacts/numbers - Multiple changes have been implemented to support international numbers
    • clean-numbers now marked as deprecated but still provides data as before.
    • New fields added:
      • country-iso - Shows the 2 character ISO code for the country.
      • country-code - The country's calling code e.g. 44
      • e164 - The number formatted in e164 format.
      • international - The number formatted in the international format.
      • note - The number field no longer accepted non-numeric characters, these are now stored in this field.
    • number field now shows a formatted number in the national format.
    • Added query parameter search-field which allows you to search by clean-number (default), number and e164 fields.
  • CHANGE GET /contacts/:uuid/numbers - Added new fields as above but does not include the query paramter.
  • CHANGE POST /contacts/:uuid/numbers - Added new fields and validation requirements:
    • New fields added:
      • country-iso - Optional if e164 number is provided otherwise recommended to supply as system default will be used.
      • e164 - Optional - Will take priority during validation.
      • notes - Optional for any user notes.
POST Validation

We use a library to validate and generate other number formats from the supplied information.

If not using e164 we suggest providing the country-iso especially if the number does not match the practices country.

number field

Existing data for customers may hold non-numeric characters in the number field.

The new fields and clean-number fields are all sanitized.

View Formulary Spec

Formulary Management​

  • CHANGE GET /stock & GET /services - Added query parameters to filter by:
    • code
    • description
    • formulary-type-uuid
    • treatment-category-uuid
    • legal-category-uuid
    • formulary-group-uuid
    • healthplan-group-uuid
    • location-uuid - This will filter out records hidden at this location (location-deviations).
  • OPTIMISED GET /location-deviations - Improved performance when filtering with location and/or formulary uuid's.
  • CHANGE GET, POST & PATCH /stock - Added new fields for prescription preferences:
    • prescription-instruction-prefix-uuid
    • prescription-measure-uuid
    • prescription-frequency-measure
    • prescription-written-not-allowed
    • prescription-advanced-calculate-dosage
    • prescription-advanced-child-mandatory
    • prescription-advanced-dispense-suggested
    • marketing-authorisation-number
  • NEW GET /active-ingredient-measures - New endpoint for measures used for advanced prescriptions.
  • NEW GET /active-ingredient-measures/:uuid - New endpoint.
  • NEW GET /active-ingredients - New endpoint with active ingredients for advanced prescriptions.
  • NEW GET /active-ingredients/:uuid - New endpoint.
  • NEW GET /:formulary-uuid/active-ingredients - New endpoint for retrieving active ingredients assigned to a formulary stock record.
  • NEW POST /:formulary-uuid/active-ingredients - New endpoint to assigning active ingredients with measures and strengths to a stock record.
  • NEW PATCH /:formulary-uuid/active-ingredients/:active-ingredient-uuid - New endpoint to update the active ingredient on the specified stock record.
  • NEW DELETE /:formulary-uuid/active-ingredients/:active-ingredient-uuid - New endpoint to remove the ingredient from a stock record.
View Patient Spec

Patient Management​

  • OPTIMISED GET /patients - Improved performance of this endpoint.

If you have any questions please contact us.