Sign in
Appointments

Move an appointment to a new time, recording the move (ITE-898).

post/Appointments/{id}/reschedule

Path parameters

idstring required

Request body

startTimestring date-time required
endTimestring date-time nullable

New end. Omit to preserve the appointment's current duration, which is what the Quick Reschedule flow wants — the user picks a start, not a span.

locationIdstring nullable

New room. Omit to keep the current one.

assignedToIdstring nullable

New assignee. Omit to keep the current one.

clearAssignedToboolean

Unassign the item. A null AssignedToId means "keep the current assignee", so clearing needs its own flag (ITE-1064). Ignored when AssignedToId is set.

reasonstring nullable

Optional reason, recorded on the history row. Vocabulary lands in ITE-899.

sourcestring nullable

Which surface is moving it — one of RescheduleSource's names. Defaults to "User"; the calendar sends "Drag" and the agent tools send "Agent" / "Voice" so reporting can separate staff moves from automated ones.

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

Changes

Changed in 2 of the 10 revisions of this API.4

  • 652ff19906753See the full diff
    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

  • d58b40cfca931See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog