Plan Benefit Procedure Maximums

Create PlanMaximumProcedure

Creates a new PlanMaximumProcedure

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 PlanMaximum.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanMaximum.Benefit_Code value in parent table.

max_ID
required
string [ 1 .. 10 ] characters

References the PlanMaximum.Max_ID value in the parent table.

from_Procedure
required
string [ 1 .. 8 ] characters

Beginning of the range of procedure codes that are applied to the Plan Maximum.

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.

procedure_Code1
required
boolean

Indicates whether the Procedure Code range applies to the primary procedure on any claim that this maximum is applied to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

procedure_Code2
required
boolean

Indicates whether the Procedure Code range applies to the secondary procedure on any claim that this maximum is appled to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

thru_Procedure
required
string [ 1 .. 8 ] characters

End of the range of procedure codes that are applied to the Plan Maximum.

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}/maximums/{maxID}/procedures
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "max_ID": "string",
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_Code1": true,
  • "procedure_Code2": true,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanMaximumProcedure

Lists all PlanMaximumProcedure for the given planID and benefitCode and fromProcedure

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}/procedures
Request samples 
Response samples 
No sample
Get PlanMaximumProcedure
Gets PlanMaximumProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/procedures/{fromProcedure}
Request samples 
Response samples 
No sample
Update PlanMaximumProcedure
Updates a specific PlanMaximumProcedure.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
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 PlanMaximum.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Benefit_Code value in parent table.


 
max_ID
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Max_ID value in the parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
Beginning of the range of procedure codes that are applied to the Plan Maximum.


 
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.


 
procedure_Code1
required
boolean
Indicates whether the Procedure Code range applies to the primary procedure on any claim that this maximum is applied to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
procedure_Code2
required
boolean
Indicates whether the Procedure Code range applies to the secondary procedure on any claim that this maximum is appled to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
End of the range of procedure codes that are applied to the Plan Maximum.


 
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}/maximums/{maxID}/procedures/{fromProcedure}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "max_ID": "string",
  • "from_Procedure": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "procedure_Code1": true,
  • "procedure_Code2": true,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanMaximumProcedure
Deletes an PlanMaximumProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/procedures/{fromProcedure}
Request samples 
Create or Update Batch PlanMaximumProcedure
Create or Update multiple PlanMaximumProcedure 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


 
maxID
required
string
Max ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Benefit_Code value in parent table.


 
max_ID
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Max_ID value in the parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
Beginning of the range of procedure codes that are applied to the Plan Maximum.


 
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.


 
procedure_Code1
required
boolean
Indicates whether the Procedure Code range applies to the primary procedure on any claim that this maximum is applied to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
procedure_Code2
required
boolean
Indicates whether the Procedure Code range applies to the secondary procedure on any claim that this maximum is appled to. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
End of the range of procedure codes that are applied to the Plan Maximum.


 
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}/maximums/{maxID}/procedures-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}