View patient recalls

get

https://nexhealth.info/patient_recalls

This endpoint returns the patient recalls for the specified location, narrowed down by the optional filters configured, including the recall type and interval for each patient. A patient recall is a reminder healthcare and dental practices send to patients when it's time to come back in for a follow-up visit, check-up, or preventive care appointment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

location_id

int32

required

Used to scope the request to the specified location

recall_id

int32

Filter by the id of the associated recall type

patient_id

int32

Filter by the id of the associated patient

foreign_id

string

Filter by the EHR id of the recall

updated_since

date-time

Return records updated since the specified date/time in ISO8601 format

due_after

date-time

Return recalls due on or after the specified date/time in ISO8601 format

sort

string

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

date_due
-date_due

Headers

Nex-Api-Version

string

required

Defaults to v3.0.0

The NexHealth API version

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error