NEnexhealth
Appointments

View appointment descriptors (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: Removes response field data[].last_sync_time.

This endpoint returns EHR appointment descriptors associated with the given appointment, optionally filtered by descriptor_type.

get/appointments/{id}/appointment_descriptors

Request

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

Path parameters

idinteger required

ID of the appointment

Query parameters

subdomainstring required

Used to scope the request to the specified institution

descriptor_typestring

Return only descriptors of this type

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": 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.