API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Used to scope the request to the specified institution

string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

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

int32
required

Used to scope the request to the specified location

int32

Filter by the id of the associated recall type

int32

Filter by the id of the associated patient

string

Filter by the EHR id of the recall

date-time

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

date-time

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

string

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

Available fields:

  • date_due
  • -date_due
Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?