Retrieve Patient Form Submission - Elation Help Center

GET

api

2.0

patient_form_submissions

{id}

Retrieve Patient Form Submission

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/patient_form_submissions/{id}/ \
  --header 'Authorization: Bearer <token>'

{
  "form_response_json": "<unknown>",
  "patient": 123,
  "patient_form": 123,
  "appointment": 123,
  "created_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "form_name": "<string>",
  "id": 123,
  "reported_date_time": "2023-11-07T05:31:56Z",
  "topics": "<unknown>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer<int64>

required

Response

200 - 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

integer

read-only

reported_date_time

string<date-time> | null

Date and time the form was reported.

topics

any

The Patient Form Object

⌘I

Retrieve Patient Form Submission

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/patient_form_submissions/{id}/ \
  --header 'Authorization: Bearer <token>'

{
  "form_response_json": "<unknown>",
  "patient": 123,
  "patient_form": 123,
  "appointment": 123,
  "created_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "form_name": "<string>",
  "id": 123,
  "reported_date_time": "2023-11-07T05:31:56Z",
  "topics": "<unknown>"
}