Skip to main content
PATCH
Update a verification of benefits

Authorizations

X-API-Key
string
header
required

Path Parameters

vob_id
string
required

Body

application/json

PATCH body for /v1/verification-of-benefits/{id}.

version
integer
required

The VOB's current version; a stale one is refused.

status
enum<string> | null

A VOB's status is Solum's to move: a request that changes it is refused with 403. Cancel a VOB with the cancel action.

Available options:
pending,
in_progress,
completed,
missing_information,
cancelled
priority
boolean | null

Omit to keep the current priority.

specialties
SpecialtyIn · object[] | null

Replaces the whole set of specialties, resolved like on create. Clinics can edit them while the VOB is pending or missing information.

Minimum array length: 1

Response

Successful Response

One VOB as its own endpoints return it (get, create, update, cancel): VobOut plus what the VOB's page shows beside the request.

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
patient_id
string<uuid>
required
created_by_id
string
required
version
integer
required
status
string
required
patient_policy_id
string<uuid>
required
priority
boolean
default:false
company_id
string<uuid> | null
active
boolean | null
reviewer_user_id
string | null
reviewed_at
string<date-time> | null
completed_at
string<date-time> | null
completed_by_user_id
string | null
missing_information_since
string<date-time> | null
sla_paused_seconds
integer
default:0
backfilled
boolean
default:false
specialties
SpecialtyOut · object[]
result_id
string<uuid> | null

The id of the VOB's result (result.id), on the list with or without include=result; null while it has none.

result
Result · object | null
created_by
UserSummary · object | null
patient
Patient · object | null
missing_information_ask
MissingInformationAskOut · object | null

While the VOB is missing information: the latest comment in which Solum asked for it. Null in any other status, or while nobody has asked yet.

missing_information_answered_at
string<date-time> | null

Your latest comment after that ask (your update notes included); null until you answer.

auto_cancel_on
string<date> | null

The date Solum will cancel the VOB if the ask stays unanswered, once Solum has warned. Null once you have answered (missing_information_answered_at is set): an answered VOB is not cancelled.

cancellation
CancellationOut · object | null

Set once the VOB is cancelled.