Sync Status

The sync status resource indicates if the integrated system sync is running correctly. Each sync consists of a reads and writes service. The reads service is responsible for making sure data read from the EHR is up to date. The writes service enables the ability to write new patients and appointments into the external database.

The sync status resource returns the real time status of both the reads and writes services. A read_status of "red" indicates data staleness. Likewise, a writes_status of "green" indicates that the writes service is active. Attempting to POST new data when a writes_status is "red" will result in errors.

Reach out to us at https://www.nexhealth.com/support/api for help understanding and resolving sync issues.

Sync Status Response

{
  "code": false,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data": [
    {
      "institution_id": 1,
      "sync_source_type": "DataSource",
      "sync_source_name": "My Source",
      "emr": {
        "id": 11,
        "name": "dentrix"
      },
      "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"
        }
      ]
    }
  ],
  "count": 2
}