View locations

This endpoint returns the institutions accessible to the caller, each with its nested list of locations. Pass subdomain to scope the response to a single institution.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

On v3.0.0 the health record system is in foreign_id_type, the second segment of interface-system-DataSource-id, such as eaglesoft in msg-eaglesoft-DataSource-1. Those are internal names (curve2 is Curve Hero, ecw is eClinicalWorks, nextgen is NextGen Office, athena is athenahealth); GET /sync_status returns the display name. A foreign_id_type of nex, or one that starts with -- or none, means the location has no sync. On v3.1.0 (beta), GET /locations/{id} returns an ehr object with id, name, display_name and type (cloud or onprem); the list endpoint does not.

Query Params
string

Used to scope the request to the specified institution

boolean

Filter by inactive status

string

Find location by the integrated system ID

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.Nexhealth+json;version=2
ChangelogMCP serverErrorsdevelopers@nexhealth.com