Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Patient Recalls

View patient recalls

This endpoint returns the patient recalls for the specified location, narrowed down by the optional filters configured.

get/patient_recalls

Query parameters

subdomainstring required

Used to scope the request to the specified institution

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

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

location_idinteger required

Used to scope the request to the specified location

recall_idinteger

Filter by the id of the associated recall type

patient_idinteger

Filter by the id of the associated patient

foreign_idstring

Filter by the EHR id of the recall

updated_sincestring date-time

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

due_afterstring date-time

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

sortstring

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-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 1,
      "appointment_id": 1,
      "date_due": "2024-08-15",
      "foreign_id": "1",
      "foreign_id_type": "msg-mdland-Institution-3",
      "recall_id": 1,
      "recall_type": {
        "id": 1,
        "name": "PROPHY",
        "description": "A recall description",
        "interval_num": 8,
        "interval_unit": "M"
      },
      "patient_id": 1,
      "created_at": "2019-09-13T15:11:28Z",
      "updated_at": "2019-09-13T15:11:28Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}