View patient recalls
GET {{baseUrl}}/patient_recalls?subdomain={{subdomain}}&page=1&per_page=5&location_id={{location_id}}&recall_id=<integer>&patient_id=<integer>&foreign_id=<string>&updated_since=<dateTime>&due_after=<dateTime>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 300 per page | |
location_id | string | (Required) Used to scope the request to the specified location | |
recall_id | string | Filter by recall_id | |
patient_id | string | Filter by patient_id | |
foreign_id | string | Filter by EMR id | |
updated_since | string | Return records updated since the specified date/time in ISO8601 format | |
due_after | string | Return recalls due after specified date/time in ISO8601 format |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","date_due":"\u003cdate\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","recall_id":"\u003cinteger\u003e","recall_type":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},{"id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","date_due":"\u003cdate\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","recall_id":"\u003cinteger\u003e","recall_type":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"}],"count":"\u003cinteger\u003e"}