Endpoints

View patients

get
https://nexhealth.info/patients

This endpoint returns the patients for the specified location. Every filter is optional.

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.

Two fields that surprise people

  • created_at is when NexHealth first read the patient, not when the practice created the chart in its system.
  • By default a search runs across the whole system the location belongs to, so a patient from a sister office can come back. Send location_strict=true to get only patients attached to the location_id.

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 by new-patient status. A new patient is a placeholder record read from the EHR for a person the practice booked without a full patient chart (its foreignid ends in np); it cannot be used to book. Once the EHR has the real patient record and NexHealth reads it, the placeholder is merged into it. true returns only new patients with an upcoming appointment, false only regular patients, unset returns regular patients plus new patients with an upcoming appointment.

boolean

Filter by non-patient status. A non-patient is a person the EHR stores without treating, such as a guarantor who is not a patient. true returns only non-patients, false leaves them out, unset returns both.

boolean

true returns only patients a completed form can be written to in the EHR. false or unset does 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 10 days 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 10 days ago

Did this page help you?
ChangelogMCP serverErrorsdevelopers@nexhealth.com