View sync statuses (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[].ehr, data[].ehr.display_name, data[].ehr.id, data[].ehr.name (+1 more); removes response fields data[].emr, data[].emr.display_name, data[].emr.id, data[].emr.name (+1 more).

This endpoint returns EHR sync statuses for the institution's locations, optionally filtered by location_ids, read_status, or write_status.

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

Used to scope the request to the specified institution

string
enum

Filter by read status

Allowed:
string
enum

Filter by write status

Allowed:
location_ids[]
array of int32s

Return the status of sync services running on the specified locations

location_ids[]
Headers
string
required
Defaults to v3.1.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/json
ChangelogMCP serverErrorsdevelopers@nexhealth.com