Skip to main content

Booking — clinicalPathwayId

Summary​

The Public API Booking type now exposes read-only clinicalPathwayId, the clinical pathway identifier when the booking is linked to a pathway. Bookings without a pathway return null.

This complements the existing bookings(filters: { clinicalPathwayId }) list filter (see Clinical pathway ID list filters). Use this field when you need the pathway id from a single booking — for example a cancelled booking fetched by id.

This change is additive and read-only. There is no nested clinicalPathway on Booking, and create/update booking inputs are unchanged.

Query example​

query BookingPathway($bookingId: ID!) {
  booking(id: $bookingId) {
    id
    deleted
    clinicalPathwayId
  }
}

Cancelled bookings​

When a booking is cancelled it is soft-deleted (deleted: true) but retains its stored clinicalPathwayId. Querying booking(id) for a cancelled linked booking still returns the pathway id.

Active pathway appointment lists (bookings with filters.clinicalPathwayId, ClinicalPathway.assignedObjects.appointments) still exclude cancelled bookings — only get-by-id exposes the retained id on deleted rows.

Permissions​

Reading clinicalPathwayId on Booking requires seeBookings only. To fetch pathway details (episode, metadata, and so on), query clinicalPathway or clinicalPathways directly — that still requires seePathways.

See also​