Plan Benefit Levels

Create PlanBenefitLevel

Creates a new PlanBenefitLevel

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
planBenefitLevel_Key
required
integer <int32>

Unique idenfitier assigned to the Plan Benefit Level. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
required
string [ 1 .. 50 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

benefit_Level
required
string [ 1 .. 32 ] characters

Unique identifier assigned to the Plan Benefit Level: Age by Service Date - age of the Member by the service date of the claim. Age by Received Date - age of the Member by the received date of the claim. Relationship Code - relationship of the Member to the Subscriber. Months Enrolled in Plan - range of months the Member has been enrolled in the plan. Days Enrolled in Plan - range of days the Member has been enrolled in the plan. Network - network of the claim. Out of Network - claim is out of network. Billed Amount - range of billed amount of the service line. Modifier - modifier exists on the service line. Exact Modifier - modifier exists in the exact location on the service line. No Modifier - no modifier exists on the service line. Exclude Modifier - modifier does not exist on the service line. Exclude Exact Modifier - modifier does not exist in the exact location on the service line. Gender - biological sex of the Member. Billing Taxonomy - taxonomy of the billing Provider must be included in the taxonomy group. Rendering Taxonomy - taxonomy of the rendering Provider must be included in the taxonomy group. Service Facility Taxonomy - taxonomy of the facility Provider must be included in the taxonomy group. Procedure Category - procedure code on the service line must fall into the indicated procedure category. Procedure Cluster - procedure code on the service line must fall into the indicated procedure cluster. Provider Federal ID - federal ID of the claim's Provider.

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.

exclude
required
boolean

Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

extra_Value1
string or null <= 128 characters

Additional value that may be associated with the Benefit Level.

extra_Value2
string or null <= 128 characters

Additional value that may be associated with the Benefit Level.

from_Value
string or null <= 128 characters

Initial value in the range of values.

plan_ID
string or null <= 20 characters

References the PlanBenefits.Plan_ID value in parent table.

thru_Value
string or null <= 128 characters

Final value in the range of values.

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.

value_Type
string or null <= 32 characters

Specifies the type or measure of the associated Benefit Level values.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/levels
Request samples
{
  • "planBenefitLevel_Key": 0,
  • "benefit_Code": "string",
  • "benefit_Level": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "extra_Value1": "string",
  • "extra_Value2": "string",
  • "from_Value": "string",
  • "plan_ID": "string",
  • "thru_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "value_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitLevel

Lists all PlanBenefitLevel 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}/levels
Request samples 
Response samples 
No sample
Get PlanBenefitLevel
Gets PlanBenefitLevel


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
planBenefitLevelKey
required
integer <int32> 
PlanBenefitLevel Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/levels/{planBenefitLevelKey}
Request samples 
Response samples 
No sample
Update PlanBenefitLevel
Updates a specific PlanBenefitLevel.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
planBenefitLevelKey
required
integer <int32> 
PlanBenefitLevel Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planBenefitLevel_Key
required
integer <int32> 
Unique idenfitier assigned to the Plan Benefit Level. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
required
string  [ 1 .. 50 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
benefit_Level
required
string  [ 1 .. 32 ] characters 
Unique identifier assigned to the Plan Benefit Level: Age by Service Date - age of the Member by the service date of the claim. Age by Received Date - age of the Member by the received date of the claim. Relationship Code - relationship of the Member to the Subscriber. Months Enrolled in Plan - range of months the Member has been enrolled in the plan. Days Enrolled in Plan - range of days the Member has been enrolled in the plan. Network - network of the claim. Out of Network - claim is out of network. Billed Amount - range of billed amount of the service line. Modifier - modifier exists on the service line. Exact Modifier - modifier exists in the exact location on the service line. No Modifier - no modifier exists on the service line. Exclude Modifier - modifier does not exist on the service line. Exclude Exact Modifier - modifier does not exist in the exact location on the service line. Gender - biological sex of the Member. Billing Taxonomy - taxonomy of the billing Provider must be included in the taxonomy group. Rendering Taxonomy - taxonomy of the rendering Provider must be included in the taxonomy group. Service Facility Taxonomy - taxonomy of the facility Provider must be included in the taxonomy group. Procedure Category - procedure code on the service line must fall into the indicated procedure category. Procedure Cluster - procedure code on the service line must fall into the indicated procedure cluster. Provider Federal ID - federal ID of the claim's Provider.


 
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.


 
exclude
required
boolean
Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
extra_Value1
string or null  <= 128 characters 
Additional value that may be associated with the Benefit Level.


 
extra_Value2
string or null  <= 128 characters 
Additional value that may be associated with the Benefit Level.


 
from_Value
string or null  <= 128 characters 
Initial value in the range of values.


 
plan_ID
string or null  <= 20 characters 
References the PlanBenefits.Plan_ID value in parent table.


 
thru_Value
string or null  <= 128 characters 
Final value in the range of values.


 
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.


 
value_Type
string or null  <= 32 characters 
Specifies the type or measure of the associated Benefit Level values.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/benefits/{benefitCode}/levels/{planBenefitLevelKey}
Request samples 
{
  • "planBenefitLevel_Key": 0,
  • "benefit_Code": "string",
  • "benefit_Level": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "extra_Value1": "string",
  • "extra_Value2": "string",
  • "from_Value": "string",
  • "plan_ID": "string",
  • "thru_Value": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "value_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitLevel
Deletes an PlanBenefitLevel


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
planBenefitLevelKey
required
integer <int32> 
PlanBenefitLevel Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/levels/{planBenefitLevelKey}
Request samples 
Create or Update Batch PlanBenefitLevel
Create or Update multiple PlanBenefitLevel 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 
planBenefitLevel_Key
required
integer <int32> 
Unique idenfitier assigned to the Plan Benefit Level. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
required
string  [ 1 .. 50 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
benefit_Level
required
string  [ 1 .. 32 ] characters 
Unique identifier assigned to the Plan Benefit Level: Age by Service Date - age of the Member by the service date of the claim. Age by Received Date - age of the Member by the received date of the claim. Relationship Code - relationship of the Member to the Subscriber. Months Enrolled in Plan - range of months the Member has been enrolled in the plan. Days Enrolled in Plan - range of days the Member has been enrolled in the plan. Network - network of the claim. Out of Network - claim is out of network. Billed Amount - range of billed amount of the service line. Modifier - modifier exists on the service line. Exact Modifier - modifier exists in the exact location on the service line. No Modifier - no modifier exists on the service line. Exclude Modifier - modifier does not exist on the service line. Exclude Exact Modifier - modifier does not exist in the exact location on the service line. Gender - biological sex of the Member. Billing Taxonomy - taxonomy of the billing Provider must be included in the taxonomy group. Rendering Taxonomy - taxonomy of the rendering Provider must be included in the taxonomy group. Service Facility Taxonomy - taxonomy of the facility Provider must be included in the taxonomy group. Procedure Category - procedure code on the service line must fall into the indicated procedure category. Procedure Cluster - procedure code on the service line must fall into the indicated procedure cluster. Provider Federal ID - federal ID of the claim's Provider.


 
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.


 
exclude
required
boolean
Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
extra_Value1
string or null  <= 128 characters 
Additional value that may be associated with the Benefit Level.


 
extra_Value2
string or null  <= 128 characters 
Additional value that may be associated with the Benefit Level.


 
from_Value
string or null  <= 128 characters 
Initial value in the range of values.


 
plan_ID
string or null  <= 20 characters 
References the PlanBenefits.Plan_ID value in parent table.


 
thru_Value
string or null  <= 128 characters 
Final value in the range of values.


 
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.


 
value_Type
string or null  <= 32 characters 
Specifies the type or measure of the associated Benefit Level values.


 
Responses 
207
Success


401
Unauthorized


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