Plan Benefits

Create PlanBenefits

Creates a new PlanBenefits

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the Plan.

benefit_Code
required
string [ 1 .. 10 ] characters

Unique identifier assigned to the Benefit.

accident_Only
string or null <= 1 characters

Checking this option indicates that the benefit is covered only when services are rendered as the result of an accident. On the Claim Entry screen, there are options to that specify that a claim is the result of an accident. If a claim is processed against this Benefit Code without one of the accident options picked on the claim, the claim will automatically 'Deny' or 'Pend' based on the Ex Code defined on the VBA Control Panel.

always_Pay_In_Network
required
boolean

When checked, if the PlanBenefit_Override_Network_ID is filled out on companydata and the claim is currently out of network, change the Network ID to the PlanBenefit Override Network ID value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

annual_Max
number or null <double>

Total annual amount that the Plan will pay both In Network and Out of Network.

annual_Max_Member
number or null <double>

Total annual amount that the Member pays both In Network and Out of Network.

annual_Max_Net
number or null <double>

Annual amount that the Plan will pay In Network.

annual_Max_Net_Member
number or null <double>

Annual amount that the Member pays In Network.

annual_Max_OON
number or null <double>

Annual amount that the Plan will pay Out of Network.

annual_Max_OON_Member
number or null <double>

Annual amount that the Member pays Out of Network.

coIns_In_To_Out
required
boolean

Applies the In-Network Co-Insurance amount toward the satisfaction of the Out-of-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Max_Mem
number or null <double>

In Network Co-Insurance amount for the Family.

coIns_Max_Net_Mem
number or null <double>

Total Co-Insurance amount for the Member.

coIns_Max_Net_Sub
number or null <double>

Out of Network Co-Insurance amount for the Family.

coIns_Max_OON_Mem
number or null <double>

Out of Network Co-Insurance amount for the Member.

coIns_Max_OON_Sub
number or null <double>

In Network Co-Insurance amount for the Member.

coIns_Max_Sub
number or null <double>

Maximum CoInsurance amount for the Family per plan year.

coIns_Out_To_In
required
boolean

Applies the Out-of-Network Co-Insurance amount toward the satisfaction of the In-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit_Max
number or null <double>

The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected.

coverage_24Hour
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered
required
string = 1 characters

Identifies whether the Benefit Code is covered for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered_In_Net_Only
string or null <= 1 characters

Checking this option indicates that the Benefit is covered only when services are rendered by an In-Network provider. If a claim is processed against this Benefit Code as Out of Network, the claim will apply the “Covered In-Network Only“ Ex Code defined on the VBA Control Panel.

ded_In_To_Out
required
boolean

Applies the In-Network deductible amount toward the satisfaction of the Out-of-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In
required
boolean

Applies the Out-of-Network deductible amount toward the satisfaction of the In-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit_Max
number or null <double>

The max with which the deducible is limited by when Ded_Out To In Limit is selected.

deductible_Before_CoPay
required
boolean

This flag determines if adjudication calculates the Deductible before the CoPay is calculated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the Benefit becomes effective on this plan.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

excluded
required
string = 1 characters

Identifies whether the Benefit Code is excluded for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

hospital_1stDay
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

include_Amt_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Maximum calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_CoIns_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Co-Insurance calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_Ded_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Deductible calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_OOP_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Out of Pocket calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

ltC_Applies_To_Elimination_Period
required
boolean

Indicates if this benefits applies to the Elimination Period for claims processed under this plan. This value would only apply if the Plan itself is configured with an Elimination Period. This indicator will be ON by default so that the user has to specifically exclude. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Applies_To_WP
required
boolean

Indicates if this benefit applies to the waiting period. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Apply_Inflation
required
boolean

Indicates it Inflation calculation should be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Base_Benefit
required
boolean

Not sure about this, but I think what I want is to have one benefit defined on any plan that has a LTC Plan_Type. You can only have one and must have one. This is like the STD or LTD benefit on disability. Its the benefit we use to do all the base benefit payment stuff. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Daily_Benefit
number or null <double>

This is the daily benefit amount

ltC_Daily_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Daily_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Type
string or null <= 32 characters

This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.

ltC_Inflation_Benefit
required
boolean

identify that this is an inflation benefit. Would still use Covered/Rider to determine if the inflation offering is optional or not. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Compound
required
boolean

Indicates if the inflation interest is simple (0) or compunded (1). Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Frequency
integer or null <int32>

this is the value for the Inflation_Frequency_Type (i.e. 1 Year, 30 Days, 6 Months, etc.)

ltC_Inflation_Frequency_Start
string or null <= 32 characters

indicates when the Inflation_Frequency is calculated from: GROUP - Group Anniversary Enroll DIV - Division Anniversary Enroll MEMBER - Member Anniversary Enroll PLAN - Initial Plan Enroll

ltC_Inflation_Frequency_Type
string or null <= 32 characters

Indicates the frequency of inflation increases. The values are: D - Days M - Months Y - Years

ltC_Inflation_Limit
number or null <double>

This value is based on Inflation_Limit_Type. For A, this is the flat cap on inflation. For B, this is the multiple of Limit defined as a cap (i.e. 2 for 2x limit or 2.5 for 2.5x limit)

ltC_Inflation_Limit_Type
string or null <= 32 characters

the type of limit cap. This filed only shows if Inflation_Type = B. The 2 options are: A - Flat Cap B - Multipl of Limit

ltC_Inflation_Pct
number or null <double>

This is the inflation value (i.e. 5% or 6%)

ltC_Inflation_Type
string or null <= 32 characters

drop down list of inflation types that change options that can be filled in. The choices would be: A - Simple Inflation B - Inflation With Cap C - Inflation No Cap

ltC_Lifetime_Max_Days_From
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_Days_Thru
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_From
number or null <double>

The low end range for member lifetime max selection.

ltC_Lifetime_Max_Increment
number or null <double>

the increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range.

ltC_Lifetime_Max_Thru
number or null <double>

the high end range for member lifetime max selection.

ltC_Lifetime_Max_Type
string or null <= 32 characters

Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected

ltC_Lifetime_Max_Years_From
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Lifetime_Max_Years_Thru
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Monthly_Benefit
number or null <double>

This is the monthly benefit amount

ltC_Monthly_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Monthly_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Type
string or null <= 32 characters

This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.

ltC_Pct_Of_Benefit
number or null <double>

the pct the be calculated against the pct_of_benefit_code.

ltC_Pct_Of_Benefit_Code
string or null <= 10 characters

This is the benefit code that this benefit will be a Pct of.

ltC_Shared_Benefit
required
boolean

Indicates if this Benefit Code is shared across multiple members of the family AND can be used in Lifetime Max calculations to determine if the same benefit across multiple plans (same plan type) could apply together. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_DBA
required
boolean

Indicates if we should use this benefit DBA configuration rather than the Plan DBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Lifetime_Max
required
boolean

This indicates if the PlanBenefit level LBM logic should be used rather thant he parent Plan LBM settings. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_MBA
required
boolean

Indicates if we should use this benefit MBA configuration rather than the Plan MBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Type
string or null <= 16 characters

This is an indicator for whether this PlanBenefit will utilize the Daily Benefit Amount or the Monthly Benefit Amount.

ltC_Use_Pct_Of_Benefit
required
boolean

identifies that this benefit amount is calculated as a percent of another benefit Note: This field is marked as NOT NULL in the database and therefore required by the API.

lifetime_Max
number or null <double>

Total lifetime amount that the Plan will pay both In Network and Out of Network.

lifetime_Max_Member
number or null <double>

Total lifetime amount that the Member pays both In Network and Out of Network.

lifetime_Max_Net
number or null <double>

Lifetime amount that the Plan will pay In Network.

lifetime_Max_Net_Member
number or null <double>

Lifetime amount that the Member pays In Network.

lifetime_Max_OON
number or null <double>

Lifetime amount that the Plan will pay Out of Network.

lifetime_Max_OON_Member
number or null <double>

Lifetime amount that the Member pays Out of Network.

maternity
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

member_Ded_OON
number or null <double>

Deductible amount for the Member Out of Network.

member_Ded_PPO
number or null <double>

Deductible amount for the Member In Network.

member_Deductible
number or null <double>

Total deductible amount for the Member both In Network and Out of Network.

ooP_Calc_Option
string or null <= 8 characters

Formula used to calculate the Out-of-Pocket amounts.

ooP_In_To_Out
required
boolean

Applies the In-Network Out-of-Pocket amount toward the satisfaction of the Out-of-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Max_Mem
number or null <double>

Total Out-of-Pocket amount for the Member.

ooP_Max_Net_Mem
number or null <double>

Total Out-of-Pocket amount for the Member In Network.

ooP_Max_Net_Sub
number or null <double>

Total Out-of-Pocket amount for the Family In Network.

ooP_Max_OON_Mem
number or null <double>

Out-of-Pocket amount for the Member Out of Network.

ooP_Max_OON_Sub
number or null <double>

Out-of-Pocket amount for the Family Out of Network.

ooP_Max_Sub
number or null <double>

Total Out-of-Pocket amount for the Family.

ooP_Out_To_In
required
boolean

Applies the Out-of-Network Out-of-Pocket amount toward the satisfaction of the In-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit_Max
number or null <double>

The max with which the out of pocket is limited by when OOP_Out To In Limit is selected.

occupational
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pcP_Only
required
boolean

Indicates that the selected Benefit applies to Primary Care Physician only. If a claim is processed against this Benefit Code without a PCP, the claim will apply the “PCP Only“ Ex Code defined on the VBA Control Panel. Note: This field is marked as NOT NULL in the database and therefore required by the API.

parent_Benefit
required
boolean

Identifies if this Benefit is a parent benefit for purposes of cascading benefits. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pend_Ex_Code
string or null <= 6 characters

Assigns an Ex Code that can be applied to adjudicated Subscriber claims.

pend_Flag
string or null <= 1 characters

While active, the assigned Ex Code will be applied to any adjudicated Subscriber claims.

rider
required
string = 1 characters

Identifies whether the Benefit Code is a rider for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_Ded_OON
number or null <double>

Deductible amount for the Family Out of Network.

subscriber_Ded_PPO
number or null <double>

Deductible amount for the Family In Network.

subscriber_Deductible
number or null <double>

Total deductible amount for the Family both In Network and Out of Network.

term_Date
string or null <date-time>

Date when the Benefit expires for this plan.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Plan_CoIns
required
string = 1 characters

Indicates that the Plan Benefit Co-Insurance amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Ded
required
string = 1 characters

Indicates that the Plan Benefit Deductible amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Max
required
string = 1 characters

Indicates that the Plan Benefit Maximums will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_OOP
required
string = 1 characters

Indicates that the Plan Benefit Out of Pocket amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "accident_Only": "s",
  • "always_Pay_In_Network": true,
  • "annual_Max": 0.1,
  • "annual_Max_Member": 0.1,
  • "annual_Max_Net": 0.1,
  • "annual_Max_Net_Member": 0.1,
  • "annual_Max_OON": 0.1,
  • "annual_Max_OON_Member": 0.1,
  • "coIns_In_To_Out": true,
  • "coIns_Max_Mem": 0.1,
  • "coIns_Max_Net_Mem": 0.1,
  • "coIns_Max_Net_Sub": 0.1,
  • "coIns_Max_OON_Mem": 0.1,
  • "coIns_Max_OON_Sub": 0.1,
  • "coIns_Max_Sub": 0.1,
  • "coIns_Out_To_In": true,
  • "coIns_Out_To_In_Limit": true,
  • "coIns_Out_To_In_Limit_Max": 0.1,
  • "coverage_24Hour": true,
  • "covered": "s",
  • "covered_In_Net_Only": "s",
  • "ded_In_To_Out": true,
  • "ded_Out_To_In": true,
  • "ded_Out_To_In_Limit": true,
  • "ded_Out_To_In_Limit_Max": 0.1,
  • "deductible_Before_CoPay": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "excluded": "s",
  • "hospital_1stDay": true,
  • "include_Amt_In_Plan": "s",
  • "include_CoIns_In_Plan": "s",
  • "include_Ded_In_Plan": "s",
  • "include_OOP_In_Plan": "s",
  • "ltC_Applies_To_Elimination_Period": true,
  • "ltC_Applies_To_WP": true,
  • "ltC_Apply_Inflation": true,
  • "ltC_Base_Benefit": true,
  • "ltC_Daily_Benefit": 0.1,
  • "ltC_Daily_Benefit_Range_From": 0.1,
  • "ltC_Daily_Benefit_Range_Increment": 0.1,
  • "ltC_Daily_Benefit_Range_Thru": 0.1,
  • "ltC_Daily_Benefit_Type": "string",
  • "ltC_Inflation_Benefit": true,
  • "ltC_Inflation_Compound": true,
  • "ltC_Inflation_Frequency": 0,
  • "ltC_Inflation_Frequency_Start": "string",
  • "ltC_Inflation_Frequency_Type": "string",
  • "ltC_Inflation_Limit": 0.1,
  • "ltC_Inflation_Limit_Type": "string",
  • "ltC_Inflation_Pct": 0.1,
  • "ltC_Inflation_Type": "string",
  • "ltC_Lifetime_Max_Days_From": 0,
  • "ltC_Lifetime_Max_Days_Thru": 0,
  • "ltC_Lifetime_Max_From": 0.1,
  • "ltC_Lifetime_Max_Increment": 0.1,
  • "ltC_Lifetime_Max_Thru": 0.1,
  • "ltC_Lifetime_Max_Type": "string",
  • "ltC_Lifetime_Max_Years_From": 0,
  • "ltC_Lifetime_Max_Years_Thru": 0,
  • "ltC_Monthly_Benefit": 0.1,
  • "ltC_Monthly_Benefit_Range_From": 0.1,
  • "ltC_Monthly_Benefit_Range_Increment": 0.1,
  • "ltC_Monthly_Benefit_Range_Thru": 0.1,
  • "ltC_Monthly_Benefit_Type": "string",
  • "ltC_Pct_Of_Benefit": 0.1,
  • "ltC_Pct_Of_Benefit_Code": "string",
  • "ltC_Shared_Benefit": true,
  • "ltC_Use_Benefit_DBA": true,
  • "ltC_Use_Benefit_Lifetime_Max": true,
  • "ltC_Use_Benefit_MBA": true,
  • "ltC_Use_Benefit_Type": "string",
  • "ltC_Use_Pct_Of_Benefit": true,
  • "lifetime_Max": 0.1,
  • "lifetime_Max_Member": 0.1,
  • "lifetime_Max_Net": 0.1,
  • "lifetime_Max_Net_Member": 0.1,
  • "lifetime_Max_OON": 0.1,
  • "lifetime_Max_OON_Member": 0.1,
  • "maternity": true,
  • "member_Ded_OON": 0.1,
  • "member_Ded_PPO": 0.1,
  • "member_Deductible": 0.1,
  • "ooP_Calc_Option": "string",
  • "ooP_In_To_Out": true,
  • "ooP_Max_Mem": 0.1,
  • "ooP_Max_Net_Mem": 0.1,
  • "ooP_Max_Net_Sub": 0.1,
  • "ooP_Max_OON_Mem": 0.1,
  • "ooP_Max_OON_Sub": 0.1,
  • "ooP_Max_Sub": 0.1,
  • "ooP_Out_To_In": true,
  • "ooP_Out_To_In_Limit": true,
  • "ooP_Out_To_In_Limit_Max": 0.1,
  • "occupational": true,
  • "pcP_Only": true,
  • "parent_Benefit": true,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "rider": "s",
  • "subscriber_Ded_OON": 0.1,
  • "subscriber_Ded_PPO": 0.1,
  • "subscriber_Deductible": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Plan_CoIns": "s",
  • "use_Plan_Ded": "s",
  • "use_Plan_Max": "s",
  • "use_Plan_OOP": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefits

Lists all PlanBenefits planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits
Request samples
Response samples
No sample

Get PlanBenefits

Gets PlanBenefits

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits/{benefitCode}
Request samples
Response samples
No sample

Update PlanBenefits

Updates a specific PlanBenefits.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the Plan.

benefit_Code
required
string [ 1 .. 10 ] characters

Unique identifier assigned to the Benefit.

accident_Only
string or null <= 1 characters

Checking this option indicates that the benefit is covered only when services are rendered as the result of an accident. On the Claim Entry screen, there are options to that specify that a claim is the result of an accident. If a claim is processed against this Benefit Code without one of the accident options picked on the claim, the claim will automatically 'Deny' or 'Pend' based on the Ex Code defined on the VBA Control Panel.

always_Pay_In_Network
required
boolean

When checked, if the PlanBenefit_Override_Network_ID is filled out on companydata and the claim is currently out of network, change the Network ID to the PlanBenefit Override Network ID value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

annual_Max
number or null <double>

Total annual amount that the Plan will pay both In Network and Out of Network.

annual_Max_Member
number or null <double>

Total annual amount that the Member pays both In Network and Out of Network.

annual_Max_Net
number or null <double>

Annual amount that the Plan will pay In Network.

annual_Max_Net_Member
number or null <double>

Annual amount that the Member pays In Network.

annual_Max_OON
number or null <double>

Annual amount that the Plan will pay Out of Network.

annual_Max_OON_Member
number or null <double>

Annual amount that the Member pays Out of Network.

coIns_In_To_Out
required
boolean

Applies the In-Network Co-Insurance amount toward the satisfaction of the Out-of-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Max_Mem
number or null <double>

In Network Co-Insurance amount for the Family.

coIns_Max_Net_Mem
number or null <double>

Total Co-Insurance amount for the Member.

coIns_Max_Net_Sub
number or null <double>

Out of Network Co-Insurance amount for the Family.

coIns_Max_OON_Mem
number or null <double>

Out of Network Co-Insurance amount for the Member.

coIns_Max_OON_Sub
number or null <double>

In Network Co-Insurance amount for the Member.

coIns_Max_Sub
number or null <double>

Maximum CoInsurance amount for the Family per plan year.

coIns_Out_To_In
required
boolean

Applies the Out-of-Network Co-Insurance amount toward the satisfaction of the In-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit_Max
number or null <double>

The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected.

coverage_24Hour
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered
required
string = 1 characters

Identifies whether the Benefit Code is covered for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered_In_Net_Only
string or null <= 1 characters

Checking this option indicates that the Benefit is covered only when services are rendered by an In-Network provider. If a claim is processed against this Benefit Code as Out of Network, the claim will apply the “Covered In-Network Only“ Ex Code defined on the VBA Control Panel.

ded_In_To_Out
required
boolean

Applies the In-Network deductible amount toward the satisfaction of the Out-of-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In
required
boolean

Applies the Out-of-Network deductible amount toward the satisfaction of the In-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit_Max
number or null <double>

The max with which the deducible is limited by when Ded_Out To In Limit is selected.

deductible_Before_CoPay
required
boolean

This flag determines if adjudication calculates the Deductible before the CoPay is calculated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the Benefit becomes effective on this plan.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

excluded
required
string = 1 characters

Identifies whether the Benefit Code is excluded for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

hospital_1stDay
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

include_Amt_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Maximum calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_CoIns_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Co-Insurance calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_Ded_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Deductible calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_OOP_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Out of Pocket calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

ltC_Applies_To_Elimination_Period
required
boolean

Indicates if this benefits applies to the Elimination Period for claims processed under this plan. This value would only apply if the Plan itself is configured with an Elimination Period. This indicator will be ON by default so that the user has to specifically exclude. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Applies_To_WP
required
boolean

Indicates if this benefit applies to the waiting period. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Apply_Inflation
required
boolean

Indicates it Inflation calculation should be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Base_Benefit
required
boolean

Not sure about this, but I think what I want is to have one benefit defined on any plan that has a LTC Plan_Type. You can only have one and must have one. This is like the STD or LTD benefit on disability. Its the benefit we use to do all the base benefit payment stuff. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Daily_Benefit
number or null <double>

This is the daily benefit amount

ltC_Daily_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Daily_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Type
string or null <= 32 characters

This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.

ltC_Inflation_Benefit
required
boolean

identify that this is an inflation benefit. Would still use Covered/Rider to determine if the inflation offering is optional or not. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Compound
required
boolean

Indicates if the inflation interest is simple (0) or compunded (1). Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Frequency
integer or null <int32>

this is the value for the Inflation_Frequency_Type (i.e. 1 Year, 30 Days, 6 Months, etc.)

ltC_Inflation_Frequency_Start
string or null <= 32 characters

indicates when the Inflation_Frequency is calculated from: GROUP - Group Anniversary Enroll DIV - Division Anniversary Enroll MEMBER - Member Anniversary Enroll PLAN - Initial Plan Enroll

ltC_Inflation_Frequency_Type
string or null <= 32 characters

Indicates the frequency of inflation increases. The values are: D - Days M - Months Y - Years

ltC_Inflation_Limit
number or null <double>

This value is based on Inflation_Limit_Type. For A, this is the flat cap on inflation. For B, this is the multiple of Limit defined as a cap (i.e. 2 for 2x limit or 2.5 for 2.5x limit)

ltC_Inflation_Limit_Type
string or null <= 32 characters

the type of limit cap. This filed only shows if Inflation_Type = B. The 2 options are: A - Flat Cap B - Multipl of Limit

ltC_Inflation_Pct
number or null <double>

This is the inflation value (i.e. 5% or 6%)

ltC_Inflation_Type
string or null <= 32 characters

drop down list of inflation types that change options that can be filled in. The choices would be: A - Simple Inflation B - Inflation With Cap C - Inflation No Cap

ltC_Lifetime_Max_Days_From
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_Days_Thru
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_From
number or null <double>

The low end range for member lifetime max selection.

ltC_Lifetime_Max_Increment
number or null <double>

the increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range.

ltC_Lifetime_Max_Thru
number or null <double>

the high end range for member lifetime max selection.

ltC_Lifetime_Max_Type
string or null <= 32 characters

Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected

ltC_Lifetime_Max_Years_From
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Lifetime_Max_Years_Thru
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Monthly_Benefit
number or null <double>

This is the monthly benefit amount

ltC_Monthly_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Monthly_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Type
string or null <= 32 characters

This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.

ltC_Pct_Of_Benefit
number or null <double>

the pct the be calculated against the pct_of_benefit_code.

ltC_Pct_Of_Benefit_Code
string or null <= 10 characters

This is the benefit code that this benefit will be a Pct of.

ltC_Shared_Benefit
required
boolean

Indicates if this Benefit Code is shared across multiple members of the family AND can be used in Lifetime Max calculations to determine if the same benefit across multiple plans (same plan type) could apply together. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_DBA
required
boolean

Indicates if we should use this benefit DBA configuration rather than the Plan DBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Lifetime_Max
required
boolean

This indicates if the PlanBenefit level LBM logic should be used rather thant he parent Plan LBM settings. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_MBA
required
boolean

Indicates if we should use this benefit MBA configuration rather than the Plan MBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Type
string or null <= 16 characters

This is an indicator for whether this PlanBenefit will utilize the Daily Benefit Amount or the Monthly Benefit Amount.

ltC_Use_Pct_Of_Benefit
required
boolean

identifies that this benefit amount is calculated as a percent of another benefit Note: This field is marked as NOT NULL in the database and therefore required by the API.

lifetime_Max
number or null <double>

Total lifetime amount that the Plan will pay both In Network and Out of Network.

lifetime_Max_Member
number or null <double>

Total lifetime amount that the Member pays both In Network and Out of Network.

lifetime_Max_Net
number or null <double>

Lifetime amount that the Plan will pay In Network.

lifetime_Max_Net_Member
number or null <double>

Lifetime amount that the Member pays In Network.

lifetime_Max_OON
number or null <double>

Lifetime amount that the Plan will pay Out of Network.

lifetime_Max_OON_Member
number or null <double>

Lifetime amount that the Member pays Out of Network.

maternity
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

member_Ded_OON
number or null <double>

Deductible amount for the Member Out of Network.

member_Ded_PPO
number or null <double>

Deductible amount for the Member In Network.

member_Deductible
number or null <double>

Total deductible amount for the Member both In Network and Out of Network.

ooP_Calc_Option
string or null <= 8 characters

Formula used to calculate the Out-of-Pocket amounts.

ooP_In_To_Out
required
boolean

Applies the In-Network Out-of-Pocket amount toward the satisfaction of the Out-of-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Max_Mem
number or null <double>

Total Out-of-Pocket amount for the Member.

ooP_Max_Net_Mem
number or null <double>

Total Out-of-Pocket amount for the Member In Network.

ooP_Max_Net_Sub
number or null <double>

Total Out-of-Pocket amount for the Family In Network.

ooP_Max_OON_Mem
number or null <double>

Out-of-Pocket amount for the Member Out of Network.

ooP_Max_OON_Sub
number or null <double>

Out-of-Pocket amount for the Family Out of Network.

ooP_Max_Sub
number or null <double>

Total Out-of-Pocket amount for the Family.

ooP_Out_To_In
required
boolean

Applies the Out-of-Network Out-of-Pocket amount toward the satisfaction of the In-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit_Max
number or null <double>

The max with which the out of pocket is limited by when OOP_Out To In Limit is selected.

occupational
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pcP_Only
required
boolean

Indicates that the selected Benefit applies to Primary Care Physician only. If a claim is processed against this Benefit Code without a PCP, the claim will apply the “PCP Only“ Ex Code defined on the VBA Control Panel. Note: This field is marked as NOT NULL in the database and therefore required by the API.

parent_Benefit
required
boolean

Identifies if this Benefit is a parent benefit for purposes of cascading benefits. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pend_Ex_Code
string or null <= 6 characters

Assigns an Ex Code that can be applied to adjudicated Subscriber claims.

pend_Flag
string or null <= 1 characters

While active, the assigned Ex Code will be applied to any adjudicated Subscriber claims.

rider
required
string = 1 characters

Identifies whether the Benefit Code is a rider for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_Ded_OON
number or null <double>

Deductible amount for the Family Out of Network.

subscriber_Ded_PPO
number or null <double>

Deductible amount for the Family In Network.

subscriber_Deductible
number or null <double>

Total deductible amount for the Family both In Network and Out of Network.

term_Date
string or null <date-time>

Date when the Benefit expires for this plan.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Plan_CoIns
required
string = 1 characters

Indicates that the Plan Benefit Co-Insurance amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Ded
required
string = 1 characters

Indicates that the Plan Benefit Deductible amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Max
required
string = 1 characters

Indicates that the Plan Benefit Maximums will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_OOP
required
string = 1 characters

Indicates that the Plan Benefit Out of Pocket amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

put/plans/{planID}/benefits/{benefitCode}
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "accident_Only": "s",
  • "always_Pay_In_Network": true,
  • "annual_Max": 0.1,
  • "annual_Max_Member": 0.1,
  • "annual_Max_Net": 0.1,
  • "annual_Max_Net_Member": 0.1,
  • "annual_Max_OON": 0.1,
  • "annual_Max_OON_Member": 0.1,
  • "coIns_In_To_Out": true,
  • "coIns_Max_Mem": 0.1,
  • "coIns_Max_Net_Mem": 0.1,
  • "coIns_Max_Net_Sub": 0.1,
  • "coIns_Max_OON_Mem": 0.1,
  • "coIns_Max_OON_Sub": 0.1,
  • "coIns_Max_Sub": 0.1,
  • "coIns_Out_To_In": true,
  • "coIns_Out_To_In_Limit": true,
  • "coIns_Out_To_In_Limit_Max": 0.1,
  • "coverage_24Hour": true,
  • "covered": "s",
  • "covered_In_Net_Only": "s",
  • "ded_In_To_Out": true,
  • "ded_Out_To_In": true,
  • "ded_Out_To_In_Limit": true,
  • "ded_Out_To_In_Limit_Max": 0.1,
  • "deductible_Before_CoPay": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "excluded": "s",
  • "hospital_1stDay": true,
  • "include_Amt_In_Plan": "s",
  • "include_CoIns_In_Plan": "s",
  • "include_Ded_In_Plan": "s",
  • "include_OOP_In_Plan": "s",
  • "ltC_Applies_To_Elimination_Period": true,
  • "ltC_Applies_To_WP": true,
  • "ltC_Apply_Inflation": true,
  • "ltC_Base_Benefit": true,
  • "ltC_Daily_Benefit": 0.1,
  • "ltC_Daily_Benefit_Range_From": 0.1,
  • "ltC_Daily_Benefit_Range_Increment": 0.1,
  • "ltC_Daily_Benefit_Range_Thru": 0.1,
  • "ltC_Daily_Benefit_Type": "string",
  • "ltC_Inflation_Benefit": true,
  • "ltC_Inflation_Compound": true,
  • "ltC_Inflation_Frequency": 0,
  • "ltC_Inflation_Frequency_Start": "string",
  • "ltC_Inflation_Frequency_Type": "string",
  • "ltC_Inflation_Limit": 0.1,
  • "ltC_Inflation_Limit_Type": "string",
  • "ltC_Inflation_Pct": 0.1,
  • "ltC_Inflation_Type": "string",
  • "ltC_Lifetime_Max_Days_From": 0,
  • "ltC_Lifetime_Max_Days_Thru": 0,
  • "ltC_Lifetime_Max_From": 0.1,
  • "ltC_Lifetime_Max_Increment": 0.1,
  • "ltC_Lifetime_Max_Thru": 0.1,
  • "ltC_Lifetime_Max_Type": "string",
  • "ltC_Lifetime_Max_Years_From": 0,
  • "ltC_Lifetime_Max_Years_Thru": 0,
  • "ltC_Monthly_Benefit": 0.1,
  • "ltC_Monthly_Benefit_Range_From": 0.1,
  • "ltC_Monthly_Benefit_Range_Increment": 0.1,
  • "ltC_Monthly_Benefit_Range_Thru": 0.1,
  • "ltC_Monthly_Benefit_Type": "string",
  • "ltC_Pct_Of_Benefit": 0.1,
  • "ltC_Pct_Of_Benefit_Code": "string",
  • "ltC_Shared_Benefit": true,
  • "ltC_Use_Benefit_DBA": true,
  • "ltC_Use_Benefit_Lifetime_Max": true,
  • "ltC_Use_Benefit_MBA": true,
  • "ltC_Use_Benefit_Type": "string",
  • "ltC_Use_Pct_Of_Benefit": true,
  • "lifetime_Max": 0.1,
  • "lifetime_Max_Member": 0.1,
  • "lifetime_Max_Net": 0.1,
  • "lifetime_Max_Net_Member": 0.1,
  • "lifetime_Max_OON": 0.1,
  • "lifetime_Max_OON_Member": 0.1,
  • "maternity": true,
  • "member_Ded_OON": 0.1,
  • "member_Ded_PPO": 0.1,
  • "member_Deductible": 0.1,
  • "ooP_Calc_Option": "string",
  • "ooP_In_To_Out": true,
  • "ooP_Max_Mem": 0.1,
  • "ooP_Max_Net_Mem": 0.1,
  • "ooP_Max_Net_Sub": 0.1,
  • "ooP_Max_OON_Mem": 0.1,
  • "ooP_Max_OON_Sub": 0.1,
  • "ooP_Max_Sub": 0.1,
  • "ooP_Out_To_In": true,
  • "ooP_Out_To_In_Limit": true,
  • "ooP_Out_To_In_Limit_Max": 0.1,
  • "occupational": true,
  • "pcP_Only": true,
  • "parent_Benefit": true,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "rider": "s",
  • "subscriber_Ded_OON": 0.1,
  • "subscriber_Ded_PPO": 0.1,
  • "subscriber_Deductible": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Plan_CoIns": "s",
  • "use_Plan_Ded": "s",
  • "use_Plan_Max": "s",
  • "use_Plan_OOP": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete PlanBenefits

Deletes an PlanBenefits

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/plans/{planID}/benefits/{benefitCode}
Request samples

Create or Update Batch PlanBenefits

Create or Update multiple PlanBenefits at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
plan_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the Plan.

benefit_Code
required
string [ 1 .. 10 ] characters

Unique identifier assigned to the Benefit.

accident_Only
string or null <= 1 characters

Checking this option indicates that the benefit is covered only when services are rendered as the result of an accident. On the Claim Entry screen, there are options to that specify that a claim is the result of an accident. If a claim is processed against this Benefit Code without one of the accident options picked on the claim, the claim will automatically 'Deny' or 'Pend' based on the Ex Code defined on the VBA Control Panel.

always_Pay_In_Network
required
boolean

When checked, if the PlanBenefit_Override_Network_ID is filled out on companydata and the claim is currently out of network, change the Network ID to the PlanBenefit Override Network ID value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

annual_Max
number or null <double>

Total annual amount that the Plan will pay both In Network and Out of Network.

annual_Max_Member
number or null <double>

Total annual amount that the Member pays both In Network and Out of Network.

annual_Max_Net
number or null <double>

Annual amount that the Plan will pay In Network.

annual_Max_Net_Member
number or null <double>

Annual amount that the Member pays In Network.

annual_Max_OON
number or null <double>

Annual amount that the Plan will pay Out of Network.

annual_Max_OON_Member
number or null <double>

Annual amount that the Member pays Out of Network.

coIns_In_To_Out
required
boolean

Applies the In-Network Co-Insurance amount toward the satisfaction of the Out-of-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Max_Mem
number or null <double>

In Network Co-Insurance amount for the Family.

coIns_Max_Net_Mem
number or null <double>

Total Co-Insurance amount for the Member.

coIns_Max_Net_Sub
number or null <double>

Out of Network Co-Insurance amount for the Family.

coIns_Max_OON_Mem
number or null <double>

Out of Network Co-Insurance amount for the Member.

coIns_Max_OON_Sub
number or null <double>

In Network Co-Insurance amount for the Member.

coIns_Max_Sub
number or null <double>

Maximum CoInsurance amount for the Family per plan year.

coIns_Out_To_In
required
boolean

Applies the Out-of-Network Co-Insurance amount toward the satisfaction of the In-Network Co-Insurance maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of co-insurance that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coIns_Out_To_In_Limit_Max
number or null <double>

The max with which the co-insurance is limited by when CoIns_Out To In Limit is selected.

coverage_24Hour
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered
required
string = 1 characters

Identifies whether the Benefit Code is covered for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

covered_In_Net_Only
string or null <= 1 characters

Checking this option indicates that the Benefit is covered only when services are rendered by an In-Network provider. If a claim is processed against this Benefit Code as Out of Network, the claim will apply the “Covered In-Network Only“ Ex Code defined on the VBA Control Panel.

ded_In_To_Out
required
boolean

Applies the In-Network deductible amount toward the satisfaction of the Out-of-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In
required
boolean

Applies the Out-of-Network deductible amount toward the satisfaction of the In-Network deductible. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of deductible that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ded_Out_To_In_Limit_Max
number or null <double>

The max with which the deducible is limited by when Ded_Out To In Limit is selected.

deductible_Before_CoPay
required
boolean

This flag determines if adjudication calculates the Deductible before the CoPay is calculated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the Benefit becomes effective on this plan.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

excluded
required
string = 1 characters

Identifies whether the Benefit Code is excluded for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

hospital_1stDay
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

include_Amt_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Maximum calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_CoIns_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Co-Insurance calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_Ded_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Deductible calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

include_OOP_In_Plan
string or null <= 1 characters

Indicates that the Plan Benefit amount is included in the Plan level Out of Pocket calculations. If this option is not specified, the Benefit is treated as a carve-out and will calculate to its own total.

ltC_Applies_To_Elimination_Period
required
boolean

Indicates if this benefits applies to the Elimination Period for claims processed under this plan. This value would only apply if the Plan itself is configured with an Elimination Period. This indicator will be ON by default so that the user has to specifically exclude. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Applies_To_WP
required
boolean

Indicates if this benefit applies to the waiting period. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Apply_Inflation
required
boolean

Indicates it Inflation calculation should be applied Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Base_Benefit
required
boolean

Not sure about this, but I think what I want is to have one benefit defined on any plan that has a LTC Plan_Type. You can only have one and must have one. This is like the STD or LTD benefit on disability. Its the benefit we use to do all the base benefit payment stuff. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Daily_Benefit
number or null <double>

This is the daily benefit amount

ltC_Daily_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Daily_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their daily benefit.

ltC_Daily_Benefit_Type
string or null <= 32 characters

This is the type of daily benefit defined for this plan. The values are: A - a flat daily benefit enforced by the plan. B - member selected value utilizing the daily benefit range/increment settings.

ltC_Inflation_Benefit
required
boolean

identify that this is an inflation benefit. Would still use Covered/Rider to determine if the inflation offering is optional or not. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Compound
required
boolean

Indicates if the inflation interest is simple (0) or compunded (1). Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Inflation_Frequency
integer or null <int32>

this is the value for the Inflation_Frequency_Type (i.e. 1 Year, 30 Days, 6 Months, etc.)

ltC_Inflation_Frequency_Start
string or null <= 32 characters

indicates when the Inflation_Frequency is calculated from: GROUP - Group Anniversary Enroll DIV - Division Anniversary Enroll MEMBER - Member Anniversary Enroll PLAN - Initial Plan Enroll

ltC_Inflation_Frequency_Type
string or null <= 32 characters

Indicates the frequency of inflation increases. The values are: D - Days M - Months Y - Years

ltC_Inflation_Limit
number or null <double>

This value is based on Inflation_Limit_Type. For A, this is the flat cap on inflation. For B, this is the multiple of Limit defined as a cap (i.e. 2 for 2x limit or 2.5 for 2.5x limit)

ltC_Inflation_Limit_Type
string or null <= 32 characters

the type of limit cap. This filed only shows if Inflation_Type = B. The 2 options are: A - Flat Cap B - Multipl of Limit

ltC_Inflation_Pct
number or null <double>

This is the inflation value (i.e. 5% or 6%)

ltC_Inflation_Type
string or null <= 32 characters

drop down list of inflation types that change options that can be filled in. The choices would be: A - Simple Inflation B - Inflation With Cap C - Inflation No Cap

ltC_Lifetime_Max_Days_From
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_Days_Thru
integer or null <int32>

The selectable range of days the member can pick for calculations based on days.

ltC_Lifetime_Max_From
number or null <double>

The low end range for member lifetime max selection.

ltC_Lifetime_Max_Increment
number or null <double>

the increment of options the user can select within the max range. Empty value here means it is a free from entry of max between the range.

ltC_Lifetime_Max_Thru
number or null <double>

the high end range for member lifetime max selection.

ltC_Lifetime_Max_Type
string or null <= 32 characters

Lifetime Max calculation type and will dicatate the max rules applied. Valid values are: STANDARD - DBM x 365 days x Lifetime Max Years selected LMDAYS - DBM x Lifetime Max Days selected FLAT - Lifetime Max Amount selected and not based on calculation LMMONTHS - MBA x 12 Months x Lifetime Max Years selected

ltC_Lifetime_Max_Years_From
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Lifetime_Max_Years_Thru
integer or null <int32>

the selectable range of years the member can pick for calculations based on years.

ltC_Monthly_Benefit
number or null <double>

This is the monthly benefit amount

ltC_Monthly_Benefit_Range_From
number or null <double>

The start of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Range_Increment
number or null <double>

The increment of each option in the range between the from and thru. If empty, the member can manually select a value between the from / thru range.

ltC_Monthly_Benefit_Range_Thru
number or null <double>

The end of the selection range for members taking this plan and choosing their monthly benefit.

ltC_Monthly_Benefit_Type
string or null <= 32 characters

This is the type of monthly benefit defined for this plan. The values are: A - a flat monthly benefit enforced by the plan. B - member selected value utilizing the monthly benefit range/increment settings.

ltC_Pct_Of_Benefit
number or null <double>

the pct the be calculated against the pct_of_benefit_code.

ltC_Pct_Of_Benefit_Code
string or null <= 10 characters

This is the benefit code that this benefit will be a Pct of.

ltC_Shared_Benefit
required
boolean

Indicates if this Benefit Code is shared across multiple members of the family AND can be used in Lifetime Max calculations to determine if the same benefit across multiple plans (same plan type) could apply together. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_DBA
required
boolean

Indicates if we should use this benefit DBA configuration rather than the Plan DBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Lifetime_Max
required
boolean

This indicates if the PlanBenefit level LBM logic should be used rather thant he parent Plan LBM settings. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_MBA
required
boolean

Indicates if we should use this benefit MBA configuration rather than the Plan MBA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ltC_Use_Benefit_Type
string or null <= 16 characters

This is an indicator for whether this PlanBenefit will utilize the Daily Benefit Amount or the Monthly Benefit Amount.

ltC_Use_Pct_Of_Benefit
required
boolean

identifies that this benefit amount is calculated as a percent of another benefit Note: This field is marked as NOT NULL in the database and therefore required by the API.

lifetime_Max
number or null <double>

Total lifetime amount that the Plan will pay both In Network and Out of Network.

lifetime_Max_Member
number or null <double>

Total lifetime amount that the Member pays both In Network and Out of Network.

lifetime_Max_Net
number or null <double>

Lifetime amount that the Plan will pay In Network.

lifetime_Max_Net_Member
number or null <double>

Lifetime amount that the Member pays In Network.

lifetime_Max_OON
number or null <double>

Lifetime amount that the Plan will pay Out of Network.

lifetime_Max_OON_Member
number or null <double>

Lifetime amount that the Member pays Out of Network.

maternity
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

member_Ded_OON
number or null <double>

Deductible amount for the Member Out of Network.

member_Ded_PPO
number or null <double>

Deductible amount for the Member In Network.

member_Deductible
number or null <double>

Total deductible amount for the Member both In Network and Out of Network.

ooP_Calc_Option
string or null <= 8 characters

Formula used to calculate the Out-of-Pocket amounts.

ooP_In_To_Out
required
boolean

Applies the In-Network Out-of-Pocket amount toward the satisfaction of the Out-of-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Max_Mem
number or null <double>

Total Out-of-Pocket amount for the Member.

ooP_Max_Net_Mem
number or null <double>

Total Out-of-Pocket amount for the Member In Network.

ooP_Max_Net_Sub
number or null <double>

Total Out-of-Pocket amount for the Family In Network.

ooP_Max_OON_Mem
number or null <double>

Out-of-Pocket amount for the Member Out of Network.

ooP_Max_OON_Sub
number or null <double>

Out-of-Pocket amount for the Family Out of Network.

ooP_Max_Sub
number or null <double>

Total Out-of-Pocket amount for the Family.

ooP_Out_To_In
required
boolean

Applies the Out-of-Network Out-of-Pocket amount toward the satisfaction of the In-Network Out-of-Pocket maximum. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit
required
boolean

When active, this will let the system know to limit the amount of out of pocket that applies to IN from OON by the Max. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ooP_Out_To_In_Limit_Max
number or null <double>

The max with which the out of pocket is limited by when OOP_Out To In Limit is selected.

occupational
required
boolean

This option is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pcP_Only
required
boolean

Indicates that the selected Benefit applies to Primary Care Physician only. If a claim is processed against this Benefit Code without a PCP, the claim will apply the “PCP Only“ Ex Code defined on the VBA Control Panel. Note: This field is marked as NOT NULL in the database and therefore required by the API.

parent_Benefit
required
boolean

Identifies if this Benefit is a parent benefit for purposes of cascading benefits. Note: This field is marked as NOT NULL in the database and therefore required by the API.

pend_Ex_Code
string or null <= 6 characters

Assigns an Ex Code that can be applied to adjudicated Subscriber claims.

pend_Flag
string or null <= 1 characters

While active, the assigned Ex Code will be applied to any adjudicated Subscriber claims.

rider
required
string = 1 characters

Identifies whether the Benefit Code is a rider for this Plan. This can be populated from the 'Plan' screen. Note: This field is marked as NOT NULL in the database and therefore required by the API.

subscriber_Ded_OON
number or null <double>

Deductible amount for the Family Out of Network.

subscriber_Ded_PPO
number or null <double>

Deductible amount for the Family In Network.

subscriber_Deductible
number or null <double>

Total deductible amount for the Family both In Network and Out of Network.

term_Date
string or null <date-time>

Date when the Benefit expires for this plan.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Plan_CoIns
required
string = 1 characters

Indicates that the Plan Benefit Co-Insurance amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Ded
required
string = 1 characters

Indicates that the Plan Benefit Deductible amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_Max
required
string = 1 characters

Indicates that the Plan Benefit Maximums will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_Plan_OOP
required
string = 1 characters

Indicates that the Plan Benefit Out of Pocket amounts will abide by the Plan level amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
207

Success

401

Unauthorized

put/plans/{planID}/benefits-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}

List Included PlanBenefits

Lists all Included PlanBenefits for a given planID and benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/included-benefits/{benefitCode}
Request samples
Response samples
No sample