Plans
Create Patient Plan
POST
How to get the payor_entity_id
Use the Get Payors API.
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:
- Upload the front of the insurance card to the File Upload API and get the
file_id
from the response. - Upload the back of the insurance card to the File Upload API and get the
file_id
from the response. - Make a post request to this api with the
file_ids
returned from 1 and 2 as theinsurance_card_file_id
andinsurance_card_back_file_id
, respectively.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Request schema for creating a patient plan
Request schema for creating a patient plan
Required string length:
2 - 80
The order number of the plan (1 for primary, 2 for secondary, etc)
Required string length:
2 - 80
The type of insurance
Available options:
COMMERCIAL
, MEDICARE
, MEDICAID
, REGIONAL_CENTER
, WORKERS_COMPENSATION
, AUTO_INSURANCE
Unique identifier for the patient plan. This is (optionally) generated and supplied by API clients
The file ID corresponding to the front of the insurance card
The file ID corresponding to the back of the insurance card
Response
201
application/json
Response schema for creating a patient plan
Response schema for creating a patient plan