CLclinicos
FormHandoffs

Creates the forms for the visit, without sending anything, and targets a tablet or QR.

Changed on
post/appointments/{appointmentId}/form-handoffs

Request

Path parameters

appointmentIdstring required

Request body

Response

Created

idstring required
appointmentIdstring required
clientIdstring required
status'Pending' | 'Opened' | 'Completed' | 'Cancelled' | 'Expired' required
targetKind'Device' | 'Qr' required
targetDeviceIdstring nullable required
targetDeviceNamestring nullable required
launchedByUserIdstring nullable required
expiresAtstring date-time required
createdAtstring date-time required
openedAtstring date-time nullable required
completedAtstring date-time nullable required
cancelledAtstring date-time nullable required
cancelledByUserIdstring nullable

Changes

  • 099cf36186e0Revision changes
    • warning

      added the new Handout enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new Handout enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new Handout enum value to the // response property for the response status (media type: text/json)

  • 85ee96c0bb96Revision changes
    • info

      endpoint added