Plan Benefit Procedures

Create PlanBenCodeProcCode

Creates a new PlanBenCodeProcCode

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 .. 50 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

from_Procedure
required
string [ 1 .. 8 ] characters

First Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.

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 range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

override_From_Procedure
string or null <= 8 characters

No longer in use.

override_Thru_Procedure
string or null <= 8 characters

No longer in use.

thru_Procedure
string or null <= 8 characters

Last Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.

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}/benefits/{benefitCode}/procedure-codes
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "override_From_Procedure": "string",
  • "override_Thru_Procedure": "string",
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenCodeProcCode

Lists all PlanBenCodeProcCode 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}/procedure-codes
Request samples 
Response samples 
No sample
Create or Update Batch PlanBenCodeProcCode
Create or Update multiple PlanBenCodeProcCode 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 .. 50 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
First Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.


 
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 range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
override_From_Procedure
string or null  <= 8 characters 
No longer in use.


 
override_Thru_Procedure
string or null  <= 8 characters 
No longer in use.


 
thru_Procedure
string or null  <= 8 characters 
Last Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.


 
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}/benefits/{benefitCode}/procedure-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get PlanBenCodeProcCode
Gets PlanBenCodeProcCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/procedure-codes/{fromProcedure}
Request samples 
Response samples 
No sample
Update PlanBenCodeProcCode
Updates a specific PlanBenCodeProcCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
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 .. 50 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
First Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.


 
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 range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
override_From_Procedure
string or null  <= 8 characters 
No longer in use.


 
override_Thru_Procedure
string or null  <= 8 characters 
No longer in use.


 
thru_Procedure
string or null  <= 8 characters 
Last Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.


 
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}/benefits/{benefitCode}/procedure-codes/{fromProcedure}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "override_From_Procedure": "string",
  • "override_Thru_Procedure": "string",
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenCodeProcCode
Deletes an PlanBenCodeProcCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/procedure-codes/{fromProcedure}
Request samples