Create Appointment

Component Details

v1.0.0

Basic Information

appmixer.cliniko.core.CreateAppointment

Create Appointment

1.0.0

Public

Books a new individual (one-on-one) appointment. End time is derived from the appointment type duration unless you set it explicitly.

Input Ports

in

FieldTypeDescription
Patient text Start typing to search your patients, or enter a Patient ID directly.
Practitioner text Start typing to pick a practitioner, or enter a Practitioner ID directly.
Business text Start typing to pick a business (clinic location), or enter a Business ID directly.
Appointment Type text Start typing to pick an appointment type, or enter an Appointment Type ID directly.
Starts At date-time Start of the appointment. Cliniko stores appointment times in UTC.
Ends At date-time Leave empty to use the duration configured on the appointment type.
Notes textarea -
Patient Case ID text Optional patient case (referral) this appointment belongs to.

Output Ports

out

FieldTypeDescription
Appointment ID string -
Patient ID string -
Patient Name string -
Practitioner ID string -
Business ID string -
Appointment Type ID string -
Patient Case ID string -
Starts At string -
Ends At string -
Notes string -
Patient Arrived boolean -
Did Not Arrive boolean -
Cancelled At string -
Cancellation Note string -
Cancellation Reason integer -
Cancellation Reason Description string -
Email Reminder Sent boolean -
SMS Reminder Sent boolean -
Invoice Status integer -
Treatment Note Status integer -
Telehealth URL string -
Archived At string -
Created At string -
Updated At string -

Full Metadata