Put Patient Plan
The default behavior of this API has destructive properties! If you have an existing primary plan for a patient and you create a new primary plan for the same patient, the existing primary plan will be deleted/archived and all in progress benefits check and prior authorizations will be withdrawn! If you want to protect against this behavior, we recommend setting conflict_behavior=RAISE_ERROR.
Behavior Overview
This API has two flows: update and create. We trigger
the update flow if we find a plan for the input patient with a matching source_id
or we determine the requested plan to be a duplicate. Else we trigger the create flow.
Since all fields are immutable on the patient plan record except for the source_id
, we will only update the source_id
field
in the case when we determine the patient plan to be a duplicate. This means that in the case of source_id
match, this API will make no updates and will just return the found
patient plan.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Request schema for updating a patient plan
Request schema for updating a patient plan
2 - 80
Unique identifier for the patient plan. This is generated and supplied by API clients
The order number of the plan (1 for primary, 2 for secondary, etc)
2 - 80
The type of insurance
COMMERCIAL
, MEDICARE
, MEDICAID
, REGIONAL_CENTER
, WORKERS_COMPENSATION
, AUTO_INSURANCE
The file ID corresponding to the front of the insurance card
The file ID corresponding to the back of the insurance card
The behavior to take when there is a conflict with an existing patient plan.REPLACE will replace the existing plan (this will halt all in progress benefits checks and prior authorizations for the plan). RAISE_ERROR will raise an error if there is a conflict. The default behavior is REPLACE
RAISE_ERROR
, REPLACE
Response
Response schema for creating a patient plan
Response schema for creating a patient plan