Edit Visit

curl --request PATCH \
  --url https://api.axlehealth.com/api/v2-stable/visits/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "start_datetime": "2024-02-20T10:00:00",
  "duration_override_minutes": 30,
  "address": {
    "line1": "123 Main St",
    "line2": "",
    "city": "Anytown",
    "state": "CA",
    "zip_code": "12345"
  },
  "clinician_appointments_to_edit": [
    {
      "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
      "clinician_id": "ea49694e-953a-4c5a-b944-6dfaf9d08fa2"
    }
  ]
}'

This response does not have an example.

API Reference

Edit Visit

Edits a visit and returns any failed validation rules.

To see example workflows, read Editing a visit, and assigning the best clinicians.

We do not support adding or removing patient appointments after a visit has been created.

We do not support editing the is_virtual field of clinician appointments once created.

This endpoint largely uses PATCH semantics, not PUT semantics, including for deeply nested fields.

So for example, if a visit has multiple clinician appointments, and you want to change the duration of only one, you only have to provide element in the clinician_appointments_to_edit array.

PATCH

visits

{id}

Edit Visit

curl --request PATCH \
  --url https://api.axlehealth.com/api/v2-stable/visits/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "start_datetime": "2024-02-20T10:00:00",
  "duration_override_minutes": 30,
  "address": {
    "line1": "123 Main St",
    "line2": "",
    "city": "Anytown",
    "state": "CA",
    "zip_code": "12345"
  },
  "clinician_appointments_to_edit": [
    {
      "clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
      "clinician_id": "ea49694e-953a-4c5a-b944-6dfaf9d08fa2"
    }
  ]
}'

This response does not have an example.

Path Parameters

string<uuid>

required

The unique identifier for the visit

Body

application/json

summary_status

string

Optional summary status of the visit

address

object

Show child attributes

clinic_id

string<uuid>

Optional clinic ID

start_datetime

string<date-time> | null

Optional start date and time

duration_override_minutes

integer | null

Optional duration override in minutes

timeslot_preferences

object | null

Optional timeslot preferences

preferred_windows

object[]

Show child attributes

patient_appointments_to_edit

object[]

Show child attributes

contact

object

Show child attributes

clinician_appointments_to_edit

object[]

Show child attributes

clinician_appointments_to_delete

object[]

Show child attributes

encounters_to_add

object[]

Show child attributes

encounters_to_edit

object[]

Show child attributes

encounters_to_delete

object[]

Show child attributes

services

object[]

Show child attributes

priority

string

Optional priority of the visit

external_id

string | null

Optional external identifier

metadata

object

Optional metadata

notes_for_clinicians

string | null

Optional notes for clinicians

notes_for_dashboard

string | null

Optional notes for the dashboard

Response

Visit edited successfully

Get Visit Create Visit Request

API Documentation

API Reference

Path Parameters

Body

Response