Create a visit
/v1/visitsCreates a visit and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.
Headers
A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.
Request body
application/jsonThe patient being visited.
The caregiver assigned to the visit; null for an open shift.
Scheduled start.
Scheduled end.
Where the visit is in its day. New visits are Scheduled.
ScheduledInProgressCancelledCompletedLateOverTimeIncompletenullShort title shown on the schedule.
Whether the visit spans the whole day, such as a live-in shift.
Tasks the caregiver should complete during the visit.
Why the visit is scheduled, if it is not routine.
Notes for the caregiver about this visit.
Billing service code for the visit.
Where the visit takes place, when it is not the patient's home address.
Response
201The new visit.
String representing the object's type. Always visit.
Unique identifier of the visit.
The patient being visited.
The caregiver assigned to the visit; null for an open shift.
Scheduled start.
Scheduled end.
Where the visit is in its day. New visits are Scheduled.
ScheduledInProgressCancelledCompletedLateOverTimeIncompletenullShort title shown on the schedule.
Whether the visit spans the whole day, such as a live-in shift.
Tasks the caregiver should complete during the visit.
Why the visit is scheduled, if it is not routine.
Notes for the caregiver about this visit.
Billing service code for the visit.
Where the visit takes place, when it is not the patient's home address.
When the caregiver clocked in.
When the caregiver clocked out.
Tasks the caregiver marked done.
Whether the visit passed electronic visit verification.
Electronic visit verification status.
PendingValidatedFlaggedOverriddenExportedSubmittednullWhether the visit has been billed.
NotBilledPendingInvoicedPaidnullThe invoice the visit was billed on.
Hours billed for the visit.
Whether the visit belongs to a repeating series.
The repeating series the visit belongs to.
The caregiver's response to the assignment.
confirmeddeclinednullWhen the visit was created.
When the visit was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 409 | n/a | The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.