API Reference

View patients

get
https://nexhealth.info/patients

This endpoint returns a list of patients based on 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

int32
required

Used to scope the request to the specified location

string
Defaults to id

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

Available fields:

  • id
  • -id
  • updated_at
  • -updated_at
string

Patient name

string

Patient email

string

Patient phone number

date

Patient date of birth. Must be a parseable date string, recommended formats is YYYY-MM-DD

boolean
string

Unique patient id from the EMR

date-time

Only return messages created since specified date. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000

boolean

Filter patients by new_patient status. When true, returns only new patients with an upcoming appointment. When false, returns only non-new patients. When not specified, returns both regular patients and new patients with upcoming appointments. Patients with the attribute new_patient=true are patients that do not fully exist in the EMR so cannot be used to book appointments. When the patient record is officially created (and read by us) in the EMR, record associations will be created and any new_patient records are deleted.

boolean

Specify if you want to filter non_patients. In case of true: return only non_patients. In case of false: Result does not include non_patients. In case of null: do not set filter/return any

boolean

Specify if you want to filter to patients that can have forms inserted into their patient file. In case of true: Return only patients that can have forms inserted into their patient file. In case of false or nil: do not filter

boolean
Defaults to false

Only returns patients belonging to the specified location, rather than searching across the EHR system

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.

Headers
string
required
Defaults to v20240412

The NexHealth API version

Responses

Updated 16 days ago

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

Updated 16 days ago