Reference

View patients

get
https://nexhealth.info/patients

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

Required parameters

  • subdomain and location_id. A search always runs in one location. See Patients for how search works.

Response updates

  • The data key now contains an array of patient objects, replacing the previous nested map structure.
  • patient_balance is deprecated and always returns an amount of "0". Use NexHealth's financial endpoints for balances.
  • The response no longer includes location_ids, which makes the endpoint faster.

Partially supported fields

  • billing_type comes back only for Open Dental, Dentrix and Dentrix Enterprise.
  • chart_id and preferred_language come back only for Open Dental, Dentrix, Dentrix Enterprise and OrthoTrac. In Open Dental, only orthodontic patients have a chart_id.
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

Filter by patient name

string

Filter by patient email

string

Filter by patient phone number

date

Filter by patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD

boolean

Filter by inactive status. When true, returns only inactive patients. When false, returns only active patients. When not specified, does not filter

string

Filter by the unique patient id from the EHR

date-time

Only return patients updated at or after the specified date/time. 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 EHR so cannot be used to book appointments. When the patient record is officially created (and read by us) in the EHR, 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 v3.0.0

The NexHealth API version

Responses

Updated 1 day 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 1 day ago

Did this page help you?