Plan Maximums

Create PlanMaximum

Creates a new PlanMaximum

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

References the PlanBenefits.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

max_ID
required
string [ 1 .. 10 ] characters

User-defined Identifier for the Maximum being entered.

dental_Designation
string or null <= 1 characters

Specifies the Dental Designation options including Tooth, Quadrant, and Arch.

effective_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

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.

expire_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

frequency
integer or null <int32>

The frequency defined here states how many of the Max Per apply for the Maximum line. This field has the logic of: Current minus Freq. A zero in this field will force the Maximum to calculate within the year, day, etc. defined in the Max Per. A 4 in this field will force the Maximum to calculate within 5 years, days, etc. defined in the Max Per.

max_Description
string or null <= 512 characters

Description identifying the Plan Maximum.

max_Ex_Code
string or null <= 6 characters

Each maximum needs and Ex Code defined for explanation during adjudication and for Remittance and EOB's. A denial Ex Code can only be used Visit Maximums as payable type Maximums can have partially paid lines. A denial code on at claim detail line that should be partially paid will result in the entire line being denied and the Maximum not being fulfilled.

max_Payable_Ex_Code
string or null <= 6 characters

Used for dollar maximums. The Ex Code in field 11 would be an informational code which allows the amount over the max to roll to the next line and apply the Denial Ex Code.

max_Per
string or null <= 1 characters

Defines the timeframe that applies to the Maximum: Day - per service date. Month - per every 30 or 31 days. Calendar Month - per calendar month in which the services were rendered. Calendar Year - per calendar year in which the services were rendered. Plan Year - per plan year as defined for the Member. Lifetime - per lifetime. Occurrence - per occurrence date on the claim header. Birth Date Year - per year defined by the Member's date of birth. Visit - per service date per Provider.

max_Sequence
integer or null <int32>

Each Maximum needs to be sequenced in order for adjudication to determine which Maximum line should apply first.

max_Type
string or null <= 1 characters

Indicates the type of Maximum: Visits - per service date. Svc Count - per units on service line. Payable Amount - payable amounts from claims. Co-pay Amount - co-pay amounts from claims. Co-Ins Amount - co-ins amounts from claims. Deductible Amount - deductible amounts from claims. Occurrence Payable - payable amount per occurrence date. Occurrence - per occurrence date on the claim header. Svc Count_Payable - payable amount on the service line divided by the number of units on the claim. This will pay the amount per unit for the number of units that are allowed by the rule.

max_Type_Net
string or null <= 1 characters

Indicates whether both In and/or Out of Network benefits apply.

member_Family
required
string = 1 characters

Indicates whether the Maximum applies to the Family or each Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

quantity
number or null <double>

Defines the dollar or count quantity that should apply to the Maximum.

subscriber_Reimbursement
boolean or null

Checking this box indicates that this benefit maximum represents a maximum that must be paid out in full regardless of the billed amount on the claim or allowable. A new claim will be created to pay any difference to the Subscriber. Note: The database will apply a default value of False for this field if a value is not provided.

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.

visit_Criteria
integer or null <int32>

No longer in use.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/maximums
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "max_ID": "string",
  • "dental_Designation": "s",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "expire_Date": "2019-08-24T14:15:22Z",
  • "frequency": 0,
  • "max_Description": "string",
  • "max_Ex_Code": "string",
  • "max_Payable_Ex_Code": "string",
  • "max_Per": "s",
  • "max_Sequence": 0,
  • "max_Type": "s",
  • "max_Type_Net": "s",
  • "member_Family": "s",
  • "quantity": 0.1,
  • "subscriber_Reimbursement": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visit_Criteria": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanMaximum

Lists all PlanMaximum for the 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}/benefits/{benefitCode}/maximums
Request samples
Response samples
No sample

Get PlanMaximum

Gets PlanMaximum

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

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

Update PlanMaximum

Updates a specific PlanMaximum.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

header Parameters
vbasoftware-database
required
string

Target database

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

References the PlanBenefits.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

max_ID
required
string [ 1 .. 10 ] characters

User-defined Identifier for the Maximum being entered.

dental_Designation
string or null <= 1 characters

Specifies the Dental Designation options including Tooth, Quadrant, and Arch.

effective_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

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.

expire_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

frequency
integer or null <int32>

The frequency defined here states how many of the Max Per apply for the Maximum line. This field has the logic of: Current minus Freq. A zero in this field will force the Maximum to calculate within the year, day, etc. defined in the Max Per. A 4 in this field will force the Maximum to calculate within 5 years, days, etc. defined in the Max Per.

max_Description
string or null <= 512 characters

Description identifying the Plan Maximum.

max_Ex_Code
string or null <= 6 characters

Each maximum needs and Ex Code defined for explanation during adjudication and for Remittance and EOB's. A denial Ex Code can only be used Visit Maximums as payable type Maximums can have partially paid lines. A denial code on at claim detail line that should be partially paid will result in the entire line being denied and the Maximum not being fulfilled.

max_Payable_Ex_Code
string or null <= 6 characters

Used for dollar maximums. The Ex Code in field 11 would be an informational code which allows the amount over the max to roll to the next line and apply the Denial Ex Code.

max_Per
string or null <= 1 characters

Defines the timeframe that applies to the Maximum: Day - per service date. Month - per every 30 or 31 days. Calendar Month - per calendar month in which the services were rendered. Calendar Year - per calendar year in which the services were rendered. Plan Year - per plan year as defined for the Member. Lifetime - per lifetime. Occurrence - per occurrence date on the claim header. Birth Date Year - per year defined by the Member's date of birth. Visit - per service date per Provider.

max_Sequence
integer or null <int32>

Each Maximum needs to be sequenced in order for adjudication to determine which Maximum line should apply first.

max_Type
string or null <= 1 characters

Indicates the type of Maximum: Visits - per service date. Svc Count - per units on service line. Payable Amount - payable amounts from claims. Co-pay Amount - co-pay amounts from claims. Co-Ins Amount - co-ins amounts from claims. Deductible Amount - deductible amounts from claims. Occurrence Payable - payable amount per occurrence date. Occurrence - per occurrence date on the claim header. Svc Count_Payable - payable amount on the service line divided by the number of units on the claim. This will pay the amount per unit for the number of units that are allowed by the rule.

max_Type_Net
string or null <= 1 characters

Indicates whether both In and/or Out of Network benefits apply.

member_Family
required
string = 1 characters

Indicates whether the Maximum applies to the Family or each Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

quantity
number or null <double>

Defines the dollar or count quantity that should apply to the Maximum.

subscriber_Reimbursement
boolean or null

Checking this box indicates that this benefit maximum represents a maximum that must be paid out in full regardless of the billed amount on the claim or allowable. A new claim will be created to pay any difference to the Subscriber. Note: The database will apply a default value of False for this field if a value is not provided.

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.

visit_Criteria
integer or null <int32>

No longer in use.

Responses
200

Success

401

Unauthorized

put/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "max_ID": "string",
  • "dental_Designation": "s",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "expire_Date": "2019-08-24T14:15:22Z",
  • "frequency": 0,
  • "max_Description": "string",
  • "max_Ex_Code": "string",
  • "max_Payable_Ex_Code": "string",
  • "max_Per": "s",
  • "max_Sequence": 0,
  • "max_Type": "s",
  • "max_Type_Net": "s",
  • "member_Family": "s",
  • "quantity": 0.1,
  • "subscriber_Reimbursement": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visit_Criteria": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete PlanMaximum

Deletes an PlanMaximum

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

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

Create or Update Batch PlanMaximum

Create or Update multiple PlanMaximum 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

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

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

References the PlanBenefits.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

max_ID
required
string [ 1 .. 10 ] characters

User-defined Identifier for the Maximum being entered.

dental_Designation
string or null <= 1 characters

Specifies the Dental Designation options including Tooth, Quadrant, and Arch.

effective_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

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.

expire_Date
string or null <date-time>

Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

frequency
integer or null <int32>

The frequency defined here states how many of the Max Per apply for the Maximum line. This field has the logic of: Current minus Freq. A zero in this field will force the Maximum to calculate within the year, day, etc. defined in the Max Per. A 4 in this field will force the Maximum to calculate within 5 years, days, etc. defined in the Max Per.

max_Description
string or null <= 512 characters

Description identifying the Plan Maximum.

max_Ex_Code
string or null <= 6 characters

Each maximum needs and Ex Code defined for explanation during adjudication and for Remittance and EOB's. A denial Ex Code can only be used Visit Maximums as payable type Maximums can have partially paid lines. A denial code on at claim detail line that should be partially paid will result in the entire line being denied and the Maximum not being fulfilled.

max_Payable_Ex_Code
string or null <= 6 characters

Used for dollar maximums. The Ex Code in field 11 would be an informational code which allows the amount over the max to roll to the next line and apply the Denial Ex Code.

max_Per
string or null <= 1 characters

Defines the timeframe that applies to the Maximum: Day - per service date. Month - per every 30 or 31 days. Calendar Month - per calendar month in which the services were rendered. Calendar Year - per calendar year in which the services were rendered. Plan Year - per plan year as defined for the Member. Lifetime - per lifetime. Occurrence - per occurrence date on the claim header. Birth Date Year - per year defined by the Member's date of birth. Visit - per service date per Provider.

max_Sequence
integer or null <int32>

Each Maximum needs to be sequenced in order for adjudication to determine which Maximum line should apply first.

max_Type
string or null <= 1 characters

Indicates the type of Maximum: Visits - per service date. Svc Count - per units on service line. Payable Amount - payable amounts from claims. Co-pay Amount - co-pay amounts from claims. Co-Ins Amount - co-ins amounts from claims. Deductible Amount - deductible amounts from claims. Occurrence Payable - payable amount per occurrence date. Occurrence - per occurrence date on the claim header. Svc Count_Payable - payable amount on the service line divided by the number of units on the claim. This will pay the amount per unit for the number of units that are allowed by the rule.

max_Type_Net
string or null <= 1 characters

Indicates whether both In and/or Out of Network benefits apply.

member_Family
required
string = 1 characters

Indicates whether the Maximum applies to the Family or each Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

quantity
number or null <double>

Defines the dollar or count quantity that should apply to the Maximum.

subscriber_Reimbursement
boolean or null

Checking this box indicates that this benefit maximum represents a maximum that must be paid out in full regardless of the billed amount on the claim or allowable. A new claim will be created to pay any difference to the Subscriber. Note: The database will apply a default value of False for this field if a value is not provided.

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.

visit_Criteria
integer or null <int32>

No longer in use.

Responses
207

Success

401

Unauthorized

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