Providers represent practice employees who can be booked for an appointment at a given practice.

There are a couple things to take note in order to understand the response data for the providers resources.

First, it is not uncommon for a practice to re-use or rename providers within their health record system. It is recommended that you confirm with the practice, which provider records they want you to work with.

Second, in order to receive Appointment Slots for a provider, they have an Availabilities defining when they can accept appointments.

📘
Creating new providers
It is worth noting that the NexHealth Synchronizer API does not support creating new providers. Practices typically set up their providers when they onboard to a new electronic medical record system, and do not want their providers to be created or modified.

Querying requestable providers

To only receive a result set of providers, simply specify the location_id parameter in your GET request as shown in the examples below.

curl --request GET 'https://nexhealth.info/providers?subdomain=test&&location_id=75&requestable=true&page=1&per_page=2' \
--header 'Authorization: ***********' \
--header 'Accept: application/vnd.Nexhealth+json;version=2'

curl --request GET 'https://nexhealth.info/locations/75/providers?subdomain=test&requestable=true&page=1&per_page=2' \
--header 'Authorization: ***********' \
--header 'Accept: application/vnd.Nexhealth+json;version=2'

Providers response

{
  "code": false,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data": {
      "id": 415,
      "email": "Amy.Ramos@nexhealth.com",
      "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": "5163042196",
        "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": "8888750851",
          "foreign_id": "1",
          "foreign_id_type": "--DataSource-",
          "email": "defaultLocation@nexhealth.com",
          "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": 2
}