Skip to main content

Patient portal appointment settings on the public API

Summary​

The Public API PracticePortalSettings type (returned by practice { portalSettings }) now exposes the practice's patient portal appointment settings: whether patients can see, cancel and reschedule their appointments, and the minimum notice for each action. The Booking type exposes patientPortalCancellationNoticeHours: the cancellation notice that applies to that booking in the patient portal.

What changed​

  • Added to PracticePortalSettings:
    • appointmentViewingEnabled: Boolean! — patients can see their appointments in the patient portal.
    • cancellationEnabled: Boolean! — patients can cancel their upcoming appointments in the patient portal.
    • cancellationNoticeHours: Int! — minimum notice, in hours before the appointment starts, to cancel in the patient portal.
    • reschedulingNoticeHours: Int! — minimum notice, in hours before the appointment starts, to reschedule in the patient portal.
  • PracticePortalSettings.reschedulingEnabled is now true only when rescheduling is enabled in the practice's patient portal settings and available for the practice. It previously reflected availability only, so it now returns false for practices that have not enabled rescheduling in their settings.
  • Added Booking.patientPortalCancellationNoticeHours: Int! — the cancellation notice of the Online Booking configuration that created the booking, otherwise the patient portal cancellationNoticeHours.
  • The new fields are additive; existing queries continue to work without requesting them.

Integration guidance​

  • Defaults: a practice that has never saved its patient portal settings returns appointmentViewingEnabled: true, cancellationEnabled: false, reschedulingEnabled: false and 48 for both notice periods.
  • Notice periods: hours before the appointment start. 0 means the action is allowed until the appointment starts.
  • Online Booking: for a booking made through an Online Booking configuration that still exists, patientPortalCancellationNoticeHours is that configuration's cancellation notice, whatever the patient portal setting. Rescheduling always uses reschedulingNoticeHours.
  • Scope: these fields describe what the patient portal offers. They do not change the behaviour of deleteBooking or updateBooking.
  • Freshness: settings can change at any time. Read them when the patient acts rather than caching them.

Example​

query PatientPortalAppointmentSettings {
practice {
portalSettings {
appointmentViewingEnabled
cancellationEnabled
cancellationNoticeHours
reschedulingEnabled
reschedulingNoticeHours
}
}
booking(id: "BOOKING_ID") {
id
start
patientPortalCancellationNoticeHours
}
}

See also​