POST
/
visits
curl --request POST \
  --url https://api.axlehealth.com/api/v2-stable/visits \
  --header 'Content-Type: application/json' \
  --data '{
  "service_area_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "clinic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_datetime": "2023-11-07T05:31:56Z",
  "duration_override_minutes": 123,
  "timeslot_preferences": {
    "preferred_windows": [
      {}
    ]
  },
  "priority": "<string>",
  "patient_appointments": [
    {
      "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "patient_confirmation_status": "NONE",
      "contact": {
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "email": "<string>"
      }
    }
  ],
  "clinician_appointments": [
    {
      "clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_virtual": true,
      "clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_offset_minutes": 123,
      "duration_override_minutes": 123
    }
  ],
  "created_from_service_bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "encounters": [
    {
      "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "services": [
        {
          "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ]
    }
  ],
  "external_id": "<string>",
  "visit_reservation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "notes_for_clinicians": "<string>",
  "notes_for_dashboard": "<string>",
  "skip_validation": {
    "skip_everything": true
  }
}'
{
  "visit_id": "bbde9f02-f44d-4ef0-924f-204674be2d62"
}

Body

application/json

Response

201 - application/json

Visit created successfully

The response is of type object.