Skip to main content

clinik.appointments

create

const { data, meta } = await clinik.appointments.create(request: AppointmentCreateRequest): Promise<ApiResponse<Appointment>>
FieldTypeRequiredDescription
statusstringYesproposed, pending, booked, arrived, fulfilled, cancelled, noshow, checked-in, waitlist
patientIdstringYesPatient reference
practitionerIdstringNoPractitioner reference
startstringNoStart time (ISO 8601)
endstringNoEnd time (ISO 8601)
minutesDurationnumberNoDuration in minutes
appointmentTypestringNoroutine, walkin, urgent, followup
serviceTypestringNoService being booked
serviceCategorystringNoService category
specialtystringNoRequired specialty
reasonCodestringNoReason for appointment
prioritynumberNo0 (routine) to 9 (urgent)
descriptionstringNoSubject line
commentstringNoAdditional comments
patientInstructionstringNoInstructions for patient
cancelationReasonstringNoReason for cancellation
basedOnIdstringNoServiceRequest this appointment assesses
requestedPeriodArray<{ start?, end? }>NoPreferred time windows
createdstringNoWhen initially created (defaults to now)
Same pattern as other resources. See Encounters for the shared interface.