Plan Modifiers

Create PlanModifier

Creates a new PlanModifier

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

References the Plans.Plan_ID value in parent table.

modifier
required
string [ 1 .. 8 ] characters

Identifies the modifier that this rule applies to.

effective_Date
required
string <date-time>

Date when the modifier rule becomes effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

apply_OON
required
boolean

Indicates whether the modifier fee applies to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

apply_UC
required
boolean

Indicates whether the modifier fee is applied to Usual and Customary claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

fee_Percent
number or null <double>

Fee amount to be associated with the selected modifier.

term_Date
string or null <date-time>

Date when the modifier rule is no longer effective.

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.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/modifiers
Request samples
{
  • "plan_ID": "string",
  • "modifier": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "apply_OON": true,
  • "apply_UC": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanModifier

Lists all PlanModifier for the given 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}/modifiers
Request samples 
Response samples 
No sample
Get PlanModifier
Gets PlanModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
modifier
required
string
Modifier


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/modifiers/{modifier}/effective-dates/{effectiveDate}
Request samples 
Response samples 
No sample
Update PlanModifier
Updates a specific PlanModifier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
modifier
required
string
Modifier


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
modifier
required
string  [ 1 .. 8 ] characters 
Identifies the modifier that this rule applies to.


 
effective_Date
required
string <date-time> 
Date when the modifier rule becomes effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_OON
required
boolean
Indicates whether the modifier fee applies to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_UC
required
boolean
Indicates whether the modifier fee is applied to Usual and Customary claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
fee_Percent
number or null <double> 
Fee amount to be associated with the selected modifier.


 
term_Date
string or null <date-time> 
Date when the modifier rule is no longer effective.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/modifiers/{modifier}/effective-dates/{effectiveDate}
Request samples 
{
  • "plan_ID": "string",
  • "modifier": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "apply_OON": true,
  • "apply_UC": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanModifier
Deletes an PlanModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
modifier
required
string
Modifier


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/modifiers/{modifier}/effective-dates/{effectiveDate}
Request samples 
Create or Update Batch PlanModifier
Create or Update multiple PlanModifier 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 
References the Plans.Plan_ID value in parent table.


 
modifier
required
string  [ 1 .. 8 ] characters 
Identifies the modifier that this rule applies to.


 
effective_Date
required
string <date-time> 
Date when the modifier rule becomes effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_OON
required
boolean
Indicates whether the modifier fee applies to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apply_UC
required
boolean
Indicates whether the modifier fee is applied to Usual and Customary claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
fee_Percent
number or null <double> 
Fee amount to be associated with the selected modifier.


 
term_Date
string or null <date-time> 
Date when the modifier rule is no longer effective.


 
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.


 
Responses 
207
Success


401
Unauthorized


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