Providers

A provider is a practice employee that patients can book an appointment with.

Two things help you read provider data.

First, practices often reuse or rename providers in their health record system. Confirm with the practice which provider records they want you to work with.

Second, a provider needs working hours that define when they can accept appointments before you can get available slots for them.

📘
Creating new providers
The Synchronizer API does not support creating providers. Practices usually set up their providers when they move to a new health record system, and do not want providers created or changed.

Querying requestable providers

To get only the providers that patients can book online at a location, send location_id and requestable=true in your GET request, as in the example below.

curl --request GET 'https://nexhealth.info/providers?subdomain=test&location_id=75&requestable=true&per_page=2' \
--header 'Authorization: ***********' \
--header 'Nex-Api-Version: v3.0.0'

Providers response

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
      "id": 415,
      "email": "[email protected]",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 0,
      "foreign_id": "string",
      "foreign_id_type": "--DataSource-",
      "bio": {
        "phone_number": "5555550100",
        "date_of_birth": "1964-05-03"
      },
      "inactive": false,
      "last_sync_time": "string",
      "display_name": "John Smith",
      "npi": "string",
      "locations": [
        {
          "id": 7,
          "name": "Default",
          "institution_id": 1,
          "street_address": "123 Law St",
          "street_address_2": "85335, North East",
          "city": "New York",
          "state": "NY",
          "zip_code": "54700",
          "created_at": "2020-06-05T20:16:57.007Z",
          "updated_at": "2020-06-05T20:16:57.007Z",
          "latitude": 37.7775028,
          "longitude": -122.3970603,
          "phone_number": "5555550100",
          "foreign_id": "1",
          "foreign_id_type": "--DataSource-",
          "email": "[email protected]",
          "tz": "America/Los_Angeles",
          "last_sync_time": "2020-06-17T19:23:49.176Z",
          "insert_appt_client": true,
          "map_by_operatory": true,
          "set_availability_by_operatory": false,
          "inactive": false
        }
      ],
      "provider_requestables": [
        {
          "location_id": 4
        }
      ],
      "availabilities": [
        {
          "id": 12,
          "provider_id": 7,
          "location_id": 3,
          "operatory_id": 149,
          "begin_time": "10:30",
          "end_time": "17:00",
          "appointment_types": [
            {
              "id": 1,
              "name": "Medical",
              "parent_type": "Institution",
              "parent_id": 1,
              "minutes": 15,
              "bookable_online": false
            }
          ],
          "days": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday"
          ],
          "specific_date": "2022-11-03",
          "custom_recurrence": {
            "num": 3,
            "unit": "day",
            "ref": "2022-11-03"
          },
          "tz_offset": "-0700",
          "active": true,
          "synced": true
        }
      ]
    },
  "count": null
}