NEnexhealth
Appointment Types

View appointment type (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 param source; 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 a single appointment type by its NexHealth ID; when descriptors are included via the include param, location_id is required. Appointment types synced from the EHR are only found with source=synced or source=all.

get/appointment_types/{id}

Request

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

Path parameters

idinteger required

NexHealth ID of the appointment type

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)

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.