NEnexhealth
Appointment Types

View appointment types (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query params provider_id, source; changes query param include[]; adds response fields data[].active, data[].data_source_id, data[].display_name, data[].foreign_id (+2 more); removes response field data[].descriptors[].last_sync_time.

This endpoint returns appointment types for the institution; when descriptors are included via the include param, location_id is required. Pass provider_id to only return appointment types offered by that provider. By default only appointment types managed in NexHealth are returned; pass source=synced for those synced from the EHR or source=all for both. working_hour_ids is only returned when included via include and is limited to the given location_id.

get/appointment_types

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/appointment_types
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger

ID of the associated location, required when appointment types are location specific and when including sub-resources

source'manual' | 'synced' | 'all'

Which appointment types to return: managed in NexHealth (manual), synced from the EHR (synced), or both (all)

provider_idinteger

Only return appointment types offered by the specified provider

include[]string[]

Resources to be included in the response

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.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 1,
      "name": "Medical",
      "parent_type": "Institution",
      "parent_id": 1,
      "minutes": 15,
      "display_name": "Hygiene visit",
      "source": "manual",
      "active": true,
      "foreign_id": "42",
      "data_source_id": 7,
      "working_hour_ids": [
        10,
        11
      ],
      "descriptors": [
        {
          "id": 1822,
          "descriptor_type": "Procedure Code",
          "name": "EHR Descriptor Name",
          "code": "EHR Descriptor Code",
          "location_id": 13,
          "foreign_id": "94",
          "foreign_id_type": "msg-dentrix-DataSource-100",
          "data": {},
          "active": true,
          "created_at": "2021-05-21T16:23:03.046Z",
          "updated_at": "2021-05-21T16:23:03.046Z"
        }
      ]
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.