Skip to main content
GET
Get Patient Plan

Authorizations

Authorization
string
header
required

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

Path Parameters

patient_plan_id
string
required

Response

Response schema for patient plan

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

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

plan_eligibility_status
enum<string>
required
Available options:
ACTIVE,
INACTIVE,
NO_CHECK
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

archived_at
string<date-time> | null
latest_eligibility_check
V1EligibilityInformation · object | null

Response schema for eligibility check information

latest_benefits_check
V1BenefitsInformation · object | null

Response schema for benefits check information