Sync Status

API Version: This document applies to v3.0.0, also referred to as v20240412, of the API.


The sync status endpoint shows whether the health record system integration is functioning properly. Each sync has two components: reads and writes.

This resource provides the real-time status of both services. 'Green' indicates that the service is functioning well, while 'red' indicates there might be an issue.

For help troubleshooting sync issues, contact [email protected].

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
}