NEnexhealth
Sync Status

View sync status (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.

get/sync_status

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/sync_status
  • Auth
    API key in header Authorization

Query parameters

subdomainstring

Used to scope the request to the specified institution

read_status'green' | 'red'

Return only syncs whose read status is green or red

write_status'green' | 'red'

Return only syncs whose write status is green or red

location_ids[]integer[]

Return the status of sync services running on the specified locations

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "institution_id": 1,
      "sync_source_type": "DataSource",
      "sync_source_name": "My Source",
      "read_status": "green",
      "read_status_at": "2020-06-05T20:16:57.007Z",
      "write_status": "red",
      "write_status_at": "2020-06-05T20:16:57.007Z",
      "locations": [
        {
          "id": 7,
          "name": "Default",
          "street_address": "123 Law St",
          "street_address_2": "85335, North East",
          "city": "New York",
          "state": "NY",
          "zip_code": "54700",
          "phone_number": "8888750851",
          "email": "defaultLocation@nexhealth.com"
        }
      ],
      "ehr": {
        "id": 11,
        "name": "dentrix",
        "display_name": "Dentrix",
        "type": "onprem"
      }
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.