v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Providers

View providers

This endpoint returns the providers for the institution, narrowed down by the optional filters configured.

get/providers

Query parameters

subdomainstring required

Used to scope the request to the specified institution

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

location_idinteger

Only return providers associated with the specified Location Id

foreign_idstring

Unique provider id from the EHR

requestableboolean

Only return providers who are bookable via NexHealth online booking at the specified location_id

inactiveboolean

Filter result set based on inactive status, defaults to false if not specified

updated_sincestring date-time

Query providers whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000

include[]string[]

Resources to be included in the response

ids[]integer[]

NexHealth IDs

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.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "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": 105,
      "foreign_id": "100437",
      "foreign_id_type": "--DataSource-",
      "bio": {
        "city": "New York",
        "state": "NY",
        "gender": "Female",
        "zip_code": "20814",
        "new_patient": false,
        "non_patient": true,
        "phone_number": "5163042196",
        "date_of_birth": "1964-05-03",
        "address_line_1": "",
        "address_line_2": "",
        "street_address": "",
        "cell_phone_number": "",
        "home_phone_number": "",
        "work_phone_number": ""
      },
      "last_sync_time": "2024-04-12T10:30:00Z",
      "display_name": "John Smith",
      "npi": "1912507500",
      "tin": "078051120",
      "state_license": "R219935",
      "specialty_code": "363L00000X",
      "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",
          "country_code": "US",
          "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
        }
      ],
      "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",
          "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,
          "source": "synced",
          "label": {
            "id": 113,
            "location_id": 115,
            "name": "New patient appointments"
          },
          "appointment_types": [
            {
              "id": 1,
              "name": "Medical",
              "parent_type": "Institution",
              "parent_id": 1,
              "minutes": 15
            }
          ]
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}