Skip to main content

Booking

A booking.

type Booking {
  id: ID!
  deleted: Boolean
  cancellationReason: String
  doctorName: String
  doctor: User
  location: BookingLocation
  appointment: Appointment
  start: DateTime!
  end: DateTime!
  patient: Patient
  patientId: ID
  bookingJourney: Journey
  createdAt: DateTime
  updatedAt: DateTime
  videoUrl: String
  comments: String
  reference: String
  metadata: [MetadataEntry!]
  billed: Boolean
  patientMessagesSent: SendPatientMessages
  status: BookingStatus
  onlineBookingPaymentStatus: String
  clinicalPathwayId: ID
}

Fields​

Booking.id ● ID! non-null scalar​

Booking.deleted ● Boolean scalar​

Booking.cancellationReason ● String scalar​

Booking.doctorName ● String scalar​

Booking.doctor ● User object​

Booking.location ● BookingLocation object​

Booking.appointment ● Appointment object​

Booking.start ● DateTime! non-null scalar​

Booking.end ● DateTime! non-null scalar​

Booking.patient ● Patient object​

Booking.patientId ● ID scalar​

Booking.bookingJourney ● Journey object​

Booking.createdAt ● DateTime scalar​

Booking.updatedAt ● DateTime scalar​

Booking.videoUrl ● String scalar​

Booking.comments ● String scalar​

Booking.reference ● String scalar​

Booking.metadata ● [MetadataEntry!] list object​

Booking.billed ● Boolean scalar​

This field is set to true if the booking has been billed.

Booking.patientMessagesSent ● SendPatientMessages object​

Booking.status ● BookingStatus enum​

Public booking status. Confirmed maps to payment.status done or null. Pending reservations use the existing payment-status lifecycle and expiry timing.

Booking.onlineBookingPaymentStatus ● String scalar​

This field contains the payment status for online bookings.

Booking.clinicalPathwayId ● ID scalar​

The clinical pathway id this booking is linked to, if any.

Returned By​

booking query ● bookingsById query

Member Of​

BookingData object ● BookingResponsePayload object ● ClinicalPathwayAssignedObjects object ● MarkBookingPaymentProcessingPayload object ● Patient object ● PatientBookingsData object