View location

This endpoint returns a single location by its NexHealth ID.

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) this endpoint returns an ehr object with id, name, display_name and type (cloud or onprem).

Path Params
int32
required

The NexHealth location 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