v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

Appointments

Undo a check-in done by mistake (status: CheckedIn → Scheduled)

post/Appointments/{id}/uncheck-in

Path parameters

idstring required

Response

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"
  }
}