Visit Requests

Requests from caregivers to pick up visits with a patient, which office staff approve or deny.

Endpoints

The VisitRequest object

object
stringread-only

String representing the object's type. Always visit_request.

id
stringread-only

Unique identifier of the visit request.

caregiverId
string | nullmax length 64

The caregiver asking for the visit. With a caregiver's API key this is always that caregiver (leave it out); office staff must send it.

caregiverName
string | nullread-onlymax length 2000

Caregiver's display name, taken from the caregiver's record.

patientId
string | nullmax length 64

The patient the caregiver would visit.

patientName
string | nullmax length 200

Patient's display name.

preferredStartDate
string · date | null

First date the caregiver could start.

preferredEndDate
string · date | null

Last date of the request.

preferredTimeOfDay
string | nullmax length 100

Time of day the caregiver prefers.

reason
string | nullmax length 20000

Why the caregiver is asking.

status
string | null

Where the request stands. A caregiver's key creates Pending requests and can only change its own pending request to Cancelled; approving and denying is for office staff.

One ofPendingApprovedDeniedCancellednull
adminResponse
string | nullmax length 20000

The office's reply. Set by office staff.

respondedByName
string | nullread-onlymax length 2000

Who answered the request.

respondedAt
string · date-time | nullread-only

When the request was answered.

createdAt
string · date-time | nullread-only

When the visit request was created.

updatedAt
string · date-time | nullread-only

When the visit request was last changed.