View patients (beta)
🚧 Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.
Changed from v3.0.0: Adds response fields data[].address, data[].address.city, data[].address.line_1, data[].address.line_2 (+15 more); removes response fields data[].bio, data[].last_sync_time.
This endpoint returns a list of patients based on the optional filters configured.
Request
- Base URLhttps://nexhealth.info
- URLhttps://nexhealth.info/patients
- AuthAPI key in header Authorization
Query parameters
Used to scope the request to the specified institution
Used to scope the request to the specified location
Optional comma-separated string of fields to sort on. Include a leading dash for descending order.
Available fields:
- id
- -id
- updated_at
- -updated_at
Filter by patient name
Filter by patient email
Filter by patient phone number
Filter by patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD
Filter by inactive status. When true, returns only inactive patients. When false, returns only active patients. When not specified, does not filter
Filter by the unique patient ID from the EHR
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
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 foreign_id 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.
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.
true returns only patients a completed form can be written to in the EHR. false or unset does not filter.
Only returns patients belonging to the specified location, rather than searching across the EHR system
First item of the current page. Starts empty
Last item of the current page. Starts empty
Number of results to return per page. Maximum allowed amount is 1000.
Headers
The NexHealth API version
Response
Successful
Example response
{
"description": "Description",
"error": [
"Error message"
],
"data": [
{
"id": 415,
"email": "anthony.smith@nexhealth.com",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": 1,
"foreign_id": "532e7f8c",
"foreign_id_type": "--DataSource-",
"cell_phone_number": "5163042196",
"preferred_phone_number": "5163042196",
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"gender": "Female",
"non_patient": true,
"date_of_birth": "1964-05-03",
"address": {
"line_1": "333 Bush Street",
"line_2": "Apt 4B",
"postal_code": "20814",
"city": "New York",
"region": "NY"
},
"hipaa": {
"authorization": true,
"authorization_date": "2023-03-22",
"privacy": true,
"privacy_date": "2023-03-22",
"consent": true,
"consent_date": "2023-03-22"
}
}
],
"page_info": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "AAAAA",
"end_cursor": "BBBBBB"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.