Create Patient Plan
Documentation Index
Fetch the complete documentation index at: https://docs.silnahealth.com/llms.txt
Use this file to discover all available pages before exploring further.
How to get the payor_entity_id
Use the Get Payors API.Handling Conflicts
Using theconflict_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_ERRORand will return a Conflict Error (http status of 409) BUMP_ONEwill 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:- Upload the front of the insurance card to the File Upload API and get the
file_idfrom the response. - Upload the back of the insurance card to the File Upload API and get the
file_idfrom the response. - Make a post request to this api with the
file_idsreturned from 1 and 2 as theinsurance_card_file_idandinsurance_card_back_file_id, respectively.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request schema for creating a patient planRequest schema for creating a patient plan
2 - 80The order number of the plan (1 for primary, 2 for secondary, etc)
2 - 80The type of insurance
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
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).
RAISE_ERROR, BUMP_ONE Response
Response schema for creating a patient planResponse schema for creating a patient plan