The Patient Form Request Object
This object represents a patient form request, which is an association between a Patient and a set of PatientForm.
You must first create the PatientForm before you can associate them to a PatientFormRequest. A PatientFormRequest
can be Read, Created, and Updated.
Warning
When modifying via a PUT request,
notification_dateis the only field that can be changed.
Example Object
Here's an example PatientFormRequest:
{
"created_date": "2024-01-18T00:00:00Z", // datetime(ISO-8601), read-only
"forms_url": "http://sandbox.elationemr.com/practice/{practice_id}/patient/{patient_id}/patient-forms/?key=AZCaFB2ZF28fyD1PijUHaRFYtLuIe6MFxOanGXMV", // string, read-only
"id": 61253, // long(64), read-only
"notification_date": "2024-01-19", // date(YYYY-MM-DD)
"patient": 585983, // long(64), required
"patient_forms": [ // array[long(64)], required
58165,
78952
],
"practice": 581663 // long(64), read-only
}
Field Definitions
| Field | Required | Read Only | Type | Description |
|---|---|---|---|---|
| id | No | Yes | long(64) | The unique identifier for the PatientFormRequest. |
| patient | Yes | No | long(64) | The unique identifier for the Patient associated with the PatientFormRequest. |
| practice | No | Yes | long(64) | The unique identifier for the Practice associated with the PatientFormRequest. |
| forms_url | No | Yes | string | This is the anonymous URL that can be used to access the forms. |
| notification_date | No | No | date | The date the PatientFormRequest was sent to the patient. This follows the format: YYYY-MM-DD. Any other format will result in an error. |
| patient_forms | Yes | No | array[long(64)] | An array of PatientForm IDs associated with the PatientFormRequest. |
| created_date | No | Yes | datetime | The date the PatientFormRequest was created. |