Changelog

All notable changes to this project will be documented in this file.

2.0

2024-11-06

Added

• Appointment payload now returns updatedEta field to provide an Specialists estimated time of arrival for the appointment

2024-09-16

Deprecated

• AppointmentProduct (POST requests to /v2/appointment using products) no longer requires productId, as partnerProductConfigId is now the only required field. productId is now deprecated and will eventually be removed from the api.

2024-07-24

Changed

• POST requests to /v2/appointment now accept a products field so that partners can attach any configured products to their appointments

Added

• GET /v2/product endpoint to return a list of configured products that can be added to appointments

2024-05-09

Added

• GET /v2/appointment-group/{id}
• POST /v2/appointment-group
• PATCH /v2/appointment-group/{id}/rebook
• PATCH /v2/appointment-group/{id}/cancel

2024-03-26

Added

• the PATCH /v2/appointment-requests/{id}/cancel endpoint. This endpoint cancels any appointment request that has a cancelable status.

2024-02-15

Removed

• If you're using Getlabs Webhooks, appointment details no longer send: appointment.cancelNote. Replaced with appointment.cancellationNote See Changelog on 2023-11-10.

2023-12-29

Added

• the GET /v2/appointment/{id}/collected-data endpoint. This endpoint returns the responses of any product related data on an appointment, eg: biometrics.

2023-11-15

Added

• the GET /v2/appointment/external-id/{id} endpoint

Changed

• POST requests to /v2/appointment now accept an externalId field so that partners can house their appointment identifier in our system for easier integration

2023-11-10

Fixed

• Webhook calls were incorrectly sending appointment.cancelNote instead of appointment.cancellationNote as described in the Appointment schema. For backwards compatibility both are now included. appointment.cancelNote to be removed in 2024

Deprecated

• appointment.cancelNote to be removed on 2024-02-15

2023-11-07

Added

• the POST /v2/appointment endpoint might return a 422 if a patient currently has an appt booked for that day
• added openapi.json file download

Changed

• POST to /v2/appointment/:appointmentId/lab-order-details incorrectly documented that a 200 was returned, in fact it's a 201
• rearranged schemas alphabetically for readability

2023-10-12

Added

• added patient fields that are editable to PatientUpdateDto

2023-10-05

Added

• editable to Patient schema

2023-09-25

Added

• ability to filter appointment requests by appointmentId

2023-09-05

Added

• products to Appointment schema
• products and enablePushNotifications to Account schema

2023-08-30

Added

• patientId parameter for Appointment_List
• GET /appointment?patientId={patientId} to retrieve appointments by patient

2023-08-15

Added

• cancellationOrigin to Appointment schema
• GET /appointment/:id/reschedules endpoint to retrieve reschedule history for an appointment

2023-07-07

Added

• bookingUrl property to AppointmentRequest schema

2023-03-20

Changed

Patient matching functionality based on email, DOB and birth sex retired. Each call to the Patient Create endpoint will result in a new patient record being created, regardless of matching properties. In order to avoid creating duplicate patient records in the upcoming release, it is advised to either:

1. Store the patient ID returned from the initial patient creation request in your application and use it in subsequent API calls
2. Pass a unique externalId value when creating/updating patients that can later be used to lookup the patient

2023-03-08

Added

• added GET /patient/external-id/:id for patient lookup via Partner's identifier

2023-01-24

Changed

• removed required fields which were readonly for the following Schema properties:
  • File.id
  • Patient.id
  • ExtendedFile.id
  • Account.skipLabOrder

2022-12-19

Added

• patient object to AppointmentRequest schema
• support for ordering in /v2/appointment-requests list

Removed

• patientId and partnerId from AppointmentRequest schema [breaking change]

2022-12-14

Changed

• labOrderDetails is now optional when creating an appointment request

2022-12-9

Added

• external id to Patient schema

2022-12-7

Added

• skipLabOrder to Account schema

2022-11-23

Added

• timezone to Address schema

2022-11-16

Added

• /v2/appointment-request endpoints to create and read appointment requests (Private Beta)

2022-11-14

Added

• /v2/appointment status and state filters introduced

2022-10-28

Added

• specialRequest to Appointment schema

2022-10-09

Added

• pronouns to Patient Schema

2022-10-03

Added

• /v2/appointment/list to facilitate listing of Appointment data

2022-09-28

Added

• /v2/account and Account Schema

2022-08-09

Added

• Added maintenance-mode header to all response calls and documentation on how to check if api is in maintenance mode

2022-07-22

Added

• First offical release of 2.0 API

Security

• updating OAuth endpoint to match JWT bearer spec and adjusting GrantTypes to match spec

1.0

2022-07-21

Added

• "parkingInstructions" to AppointmentBook Schema

Changed

• updated API docs on lab order detail to document calling doctor

2022-07-19

Added

• api booking on behalf, "BehalfOf" to AppointmentBook Schema

2022-03-21

Added

• First initial release of 1.0 API