Skip to main content
POST
Create Patient Form Submission

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
form_response_json
any
required

Form response data in the patient form submission JSON format.

patient
integer<int64>
required

ID of the patient.

patient_form
integer<int64>
required

ID of the PatientForm to create a response for.

appointment
integer<int64> | null

ID of the appointment this submission is linked to.

document_date
string<date-time> | null

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.

reported_date_time
string<date-time> | null

Date and time the form was reported.

Response

201 - application/json
form_response_json
any
required

Form response data in the patient form submission JSON format.

patient
integer<int64>
required

ID of the patient.

patient_form
integer<int64>
required

ID of the PatientForm to create a response for.

appointment
integer<int64> | null

ID of the appointment this submission is linked to.

created_date
string<date-time> | null
read-only
document_date
string<date-time> | null

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_name
string
read-only
id
integer
read-only
reported_date_time
string<date-time> | null

Date and time the form was reported.

topics
any