Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Appointments

Create a new appointment with schedule item

post/Appointments

Request body

clientIdstring required
patientIdstring nullable

Patient under care. Required for normal patient-scoped appointments; must be null for group-visit appointment types (those provide string? CreateAppointmentRequest.PatientGroupId instead). The service-layer validates based on the chosen AppointmentType's IsGroupVisit flag.

patientGroupIdstring nullable

Patient group under care for litter / herd appointment types. Mutually exclusive with string? CreateAppointmentRequest.PatientId; the appointments_subject_chk CHECK constraint enforces exactly-one at the DB level.

reasonForVisitstring required
notesstring nullable
customAttributesstring nullable
appointmentTypeIdstring nullable

The type of appointment (e.g., Wellness Exam, Dental Cleaning).

titlestring required
startTimestring date-time required
endTimestring date-time required
descriptionstring nullable
typestring required
locationIdstring required
assignedToIdstring nullable
scheduleCustomAttributesstring nullable
isTravelAppointmentboolean
travelDestinationAddressstring nullable
travelDestinationPlaceIdstring nullable
travelStartingAddressstring nullable
travelStartingPlaceIdstring nullable
travelIsRoundTripboolean nullable
travelAccessNotesstring nullable

Response

OK

idstring
scheduleItemIdstring
clientIdstring
patientIdstring nullable

Set on patient-scoped appointments. Null on group visits — see string? AppointmentResponseDto.PatientGroupId.

patientGroupIdstring nullable

Set on group-visit appointment types (litter / herd). Mutually exclusive with string? AppointmentResponseDto.PatientId.

reasonForVisitstring
notesstring nullable
statusstring
customAttributesstring nullable
recordingIdstring nullable
createdAtstring date-time
updatedAtstring date-time
isTravelAppointmentboolean
travelDestinationAddressstring nullable
travelDestinationPlaceIdstring nullable
travelStartingAddressstring nullable
travelStartingPlaceIdstring nullable
travelIsRoundTripboolean nullable
travelAccessNotesstring nullable
appointmentTypeIdstring nullable
requiresSurgeryRoomboolean

Whether this appointment type requires a surgery room.

isEmergencySurgeryConversionboolean

Whether this appointment was converted from a regular exam to emergency surgery.

appointmentTypeDefaultFlowIdstring nullable

Chronicle workflow id sourced from this appointment's <see cref="!:AppointmentType" />. Null falls back to appointment-default at the chronicle. Denormalized at read time so the chronicle doesn't need a second appointment-type lookup.

appointmentTypeExamTemplateIdstring nullable

Exam template id sourced from this appointment's <see cref="!:AppointmentType" /> (PAW-741). Resolution at the chronicle exam step: this value, else the provider's personal default, else the standard 7-system view. Denormalized at read time so the chronicle doesn't need a second appointment-type lookup.

appointmentTypeAutoGenerateSoapboolean

Auto-start SOAP generation when the treatment plan is converted to an invoice (PAW-675). Denormalized from the appointment type; true when the appointment has no type (the platform default is on).

appointmentTypeAutoGenerateDischargeboolean

Auto-start discharge generation when the SOAP note is approved (PAW-675). Denormalized from the appointment type; true when the appointment has no type (the platform default is on).

Example response

{
  "patient": {
    "species": "Cat",
    "breed": "Siamese",
    "sex": "Male"
  }
}