View patients

get

https://nexhealth.info/patients

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response updates

Patient_balance has been deprecated and will always return an amount of "0". Please use NexHealth's financial endpoints to get balance information.

Partially supported fields

billing_type is only available for OpenDental, Dentrix, Dentrix Enterprise, and OpenDental.
chart_id and preferred_language are only available for OpenDental, Dentrix, Dentrix Enterprise, OpenDental and Orthotrac. In OpenDental, patients will only have a chart_id if they are an orthodontic patient.

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

name

string

Filter by patient name

string

Filter by patient email

phone_number

string

Filter by patient phone number

date_of_birth

date

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

inactive

boolean

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

foreign_id

string

Filter by the unique patient id from the EHR

updated_since

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

new_patient

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.

non_patient

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

forms_syncable

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

location_strict

boolean

Defaults to false

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

sort

string

Defaults to name

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

Available fields:

name
-name
created_at
-created_at

appointment_date_start

date

Include appointments starting from this date

appointment_date_end

date

Include appointments up to this date

page

int32

Defaults to 1

Page number. Starts with page 1

per_page

int32

Defaults to 5

Number of results to return per page. Defaults is 5 per page and Max 300 per page

include[]

array of strings

Resources to be included in the response

include[]

Allowed:

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error