v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB

Patient Form Submissions

Retrieve Patient Form Submission

Retrieve a single patient form object

get/api/2.0/patient_form_submissions/{id}/

Path parameters

idinteger required

Response

appointmentinteger nullable

ID of the appointment this submission is linked to.

created_datestring date-time nullable

document_datestring date-time nullable

Date of the clinical document. For past appointments, set this to the appointment date so the record appears at the correct position in the chart feed.

form_namestring

{"stackTrail":"components:schemas:PatientFormSubmission:properties:form_response_json","oasType":"schema","type":"unknown","description":"Form response data in the patient form submission JSON format."}

idinteger

patientinteger required

ID of the patient.

patient_forminteger required

ID of the PatientForm to create a response for.

reported_date_timestring date-time nullable

Date and time the form was reported.

{"stackTrail":"components:schemas:PatientFormSubmission:properties:topics","oasType":"schema","type":"unknown"}