Skip to main content
POST
Create Patient Plan

How to get the payor_entity_id

Use the Get Payors API.

Handling Conflicts

Using the conflict_behavior field allows you to configure how existing plans are handled when a patient plan already exists at the specified plan_order_number.
  • The default is RAISE_ERROR and will return a Conflict Error (http status of 409)
  • BUMP_ONE will move the existing plan at the specified order to the next order number. For example, if you create a new primary plan (order 1) and a primary plan already exists, the existing plan will be moved to secondary (order 2). Note that this will fail with a Conflict Error (409) if the next order number is also occupied.

Create Patient Plan With Insurance Card

If you want to create a patient plan with an insurance card, you will need to do the following steps:
  1. Upload the front of the insurance card to the File Upload API and get the file_id from the response.
  2. Upload the back of the insurance card to the File Upload API and get the file_id from the response.
  3. Make a post request to this api with the file_ids returned from 1 and 2 as the insurance_card_file_id and insurance_card_back_file_id, respectively.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request schema for creating a patient plan

member_number
string
required
Required string length: 2 - 80
payor_entity_id
string<uuid>
required
patient_id
string<uuid>
required
plan_order_number
integer
required

The order number of the plan (1 for primary, 2 for secondary, etc)

group_number
string | null
Required string length: 2 - 80
start_date
string<date-time> | null
end_date
string<date-time> | null
insurance_type
enum<string> | null

The type of insurance

Available options:
COMMERCIAL,
MEDICARE,
MEDICAID,
REGIONAL_CENTER,
WORKERS_COMPENSATION,
AUTO_INSURANCE
source_id
string | null

Unique identifier for the patient plan. This is (optionally) generated and supplied by API clients

insurance_card_file_id
string<uuid> | null

The file ID corresponding to the front of the insurance card

insurance_card_back_file_id
string<uuid> | null

The file ID corresponding to the back of the insurance card

conflict_behavior
enum<string> | null
default:RAISE_ERROR

How to handle a conflict when a patient plan already exists at the specified plan_order_number. RAISE_ERROR (default) will return a 409 Conflict error. BUMP_ONE will move the existing plan at the specified order to the next order number (e.g., primary becomes secondary).

Available options:
RAISE_ERROR,
BUMP_ONE

Response

Response schema for creating a patient plan

patient_plan_id
string<uuid>
required