Visits

Visits are scheduled or completed caregiver shifts at a patient's home. A visit's patient, caregiver, times and status are set when it is created; reschedule or reassign a visit in AveeCare.

Endpoints

The Visit object

object
stringread-only

String representing the object's type. Always visit.

id
stringread-only

Unique identifier of the visit.

patientId
string | nullmax length 64

The patient being visited.

caregiverId
string | nullmax length 64

The caregiver assigned to the visit; null for an open shift.

startTime
string · date-time | null

Scheduled start.

endTime
string · date-time | null

Scheduled end.

status
string | null

Where the visit is in its day. New visits are Scheduled.

One ofScheduledInProgressCancelledCompletedLateOverTimeIncompletenull
title
string | nullmax length 200

Short title shown on the schedule.

isAllDay
boolean | null

Whether the visit spans the whole day, such as a live-in shift.

tasks
array of strings | null

Tasks the caregiver should complete during the visit.

reason
string | nullmax length 20000

Why the visit is scheduled, if it is not routine.

notes
string | nullmax length 20000

Notes for the caregiver about this visit.

serviceCode
string | nullmax length 50

Billing service code for the visit.

locationAddress
string | nullmax length 300

Where the visit takes place, when it is not the patient's home address.

actualStartTime
string · date-time | nullread-only

When the caregiver clocked in.

actualEndTime
string · date-time | nullread-only

When the caregiver clocked out.

completedTasks
array of strings | nullread-only

Tasks the caregiver marked done.

evvVerified
boolean | nullread-only

Whether the visit passed electronic visit verification.

evvStatus
string | nullread-only

Electronic visit verification status.

One ofPendingValidatedFlaggedOverriddenExportedSubmittednull
billingStatus
string | nullread-only

Whether the visit has been billed.

One ofNotBilledPendingInvoicedPaidnull
invoiceId
string | nullread-onlymax length 64

The invoice the visit was billed on.

billableHours
number | nullread-only

Hours billed for the visit.

isRecurring
boolean | nullread-only

Whether the visit belongs to a repeating series.

recurrenceSeriesId
string | nullread-onlymax length 64

The repeating series the visit belongs to.

caregiverRSVP
string | nullread-only

The caregiver's response to the assignment.

One ofconfirmeddeclinednull
createdAt
string · date-time | nullread-only

When the visit was created.

updatedAt
string · date-time | nullread-only

When the visit was last changed.