NEnexhealth
Appointments

Edit appointment (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 fields data.appt.is_guardian, data.appt.is_new_clients_patient, data.appt.last_sync_time, data.appt.referrer (+1 more); changes response field data.appt.patient_confirmed.

This endpoint updates an existing appointment.

patch/appointments/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/appointments/{id}
  • 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

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

Example request

{
  "appt": {
    "confirmed": true,
    "checkin_at": "2024-04-15T14:55:00Z",
    "start_time": "2024-04-15T15:00:00Z",
    "end_time": "2024-04-15T15:30:00Z",
    "operatory_id": 181,
    "note": "Patient has been having a cough for 3 days"
  }
}

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": {
    "appt": {
      "id": 1822,
      "patient_id": 2897,
      "provider_id": 104,
      "provider_name": "Dr. John Smith",
      "start_time": "2020-06-05T20:16:57.007Z",
      "confirmed": true,
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "note": "Patient has been having a cough for 3 days",
      "end_time": "2020-06-05T20:16:57.007Z",
      "timezone": "America/New_York",
      "institution_id": 1,
      "checkin_at": "2020-06-05T20:16:57.007Z",
      "location_id": 1,
      "foreign_id": "94",
      "foreign_id_type": "msg-dentrix-DataSource-100",
      "misc": {
        "is_booked_on_nexhealth": true
      },
      "created_by_user_id": 197,
      "patient_confirmed_at": "2020-06-05T20:16:57.007Z",
      "cancelled_at": "2020-06-05T20:16:57.007Z",
      "confirmed_at": "2020-06-05T20:16:57.007Z",
      "operatory_id": 181,
      "checked_out_at": "2020-06-05T20:16:57.007Z",
      "is_past_patient": true,
      "timezone_offset": "-4:00"
    }
  },
  "count": 2
}

Changes

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