v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Patient Form Requests

Retrieve Patient Form Request

get/api/2.0/patient_form_requests/{id}/

Path parameters

idinteger required

Response

appointmentinteger nullable

The ID of an appointment to associate with this form request. When the appointment is in the past, the notification_date validation is skipped.

created_datestring date-time nullable
forms_urlstring uri
idinteger
notification_datestring date

This is the date that the request will appear in the Practice's action queue. Must be in the future unless an appointment in the past is provided. Defaults to one week from today.

patientinteger required

The ID of the patient that should be associated with the request.

patient_formsinteger[] required

The IDs of the forms that should be associated to the request. Please note that you must create these forms before trying to create a request.

practiceinteger