NEnexhealth
Appointment Types

Edit 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 request fields appointment_type.display_name, appointment_type.ehr_appt_descriptor_ids; removes request field appointment_type.emr_appt_descriptor_ids; adds response 422; adds response fields data.active, data.data_source_id, data.display_name, data.foreign_id (+2 more).

This endpoint updates an existing appointment type's attributes such as name, minutes, and bookable_online. On an appointment type synced from the EHR only display_name and bookable_online can change; any other field returns 422.

patch/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

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

location_idinteger

ID of the associated location, required when appointment types are location specific

Example request

{
  "appointment_type": {
    "display_name": "Hygiene visit"
  }
}

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
    ]
  },
  "count": 2
}

Changes

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