View sync status

This endpoint returns the live status of every sync the caller can access, one entry per sync, with separate read and write statuses (green or red), the last time data was read from the EHR and the last time the sync picked up write commands. Pass subdomain to scope to one institution and location_ids to narrow further. A location with no sync behind it returns no entry.

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

read_status_at is the last time NexHealth read from the health record system. write_status_at is the last time the sync checked in for writes, whether or not any were waiting. read_status turns red when the last read is older than 150 minutes and write_status when the last check-in is older than 25 minutes; both limits can be set per sync. The sync_status_read_change and sync_status_write_change webhooks fire both ways: .red when a status goes down and .green when it comes back. Each sync's emr.display_name names the system. See Interpreting sync status.

Query Params
string

Used to scope the request to the specified institution

string
enum

Return only syncs whose read status is green or red

Allowed:
string
enum

Return only syncs whose write status is green or red

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.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