View patient recalls

get

https://nexhealth.info/patient_recalls

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 recall_id

patient_id

int32

Filter by patient_id

foreign_id

string

Filter by EMR id

updated_since

date-time

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

due_after

date-time

Return recalls due after specified date/time in ISO8601 format

sort

string

Defaults to null

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 v20240412

The NexHealth API version

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error