Plan Pre-existing Coverages

Create PlanPreEx

Creates a new PlanPreEx

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.

coverage_Type
required
string [ 1 .. 32 ] characters

Coverage type, based on enrollment, that will be applied by the pre-existing condition.

disclosed_Ex_Code
string or null <= 6 characters

ExCode applied to this PlanPreEx disclosure.

disclosed_From_Range
integer or null <int32>

Holds the value of the lower bound of a range defined for disclosed pre-existing entry.

disclosed_Pre_Ex_Amount
number or null <double>

Amount allowed before a pend/deny on a pre-ex claim detail line, use in conjunction with Disclosed_Ex_Code.

disclosed_Range_Type
string or null <= 16 characters

Defines the type of range used with the bounds of the disclosed range. D = Days, M = Months.

disclosed_Thru_Range
integer or null <int32>

Holds the value of the upper bound of a range defined for disclosed pre-existing entry.

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.

ex_Code
string or null <= 6 characters

Ex Code associated with the pre-existing condition.

from_Range
integer or null <int32>

Beginning of the duration range that the pre-existing Conditon will apply to.

pre_Ex_Amount
number or null <double>

Dollar amount that will be applied by the pre-existing condition before pending or denying claims.

range_Type
string or null <= 16 characters

Unit of time used to measure the pre-existing Condition duration. Limited to units of either months or days.

thru_Range
integer or null <int32>

End of the duration range that the pre-existing Conditon will apply to.

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}/pre-existing-coverages
Request samples
{
  • "plan_ID": "string",
  • "coverage_Type": "string",
  • "disclosed_Ex_Code": "string",
  • "disclosed_From_Range": 0,
  • "disclosed_Pre_Ex_Amount": 0.1,
  • "disclosed_Range_Type": "string",
  • "disclosed_Thru_Range": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Range": 0,
  • "pre_Ex_Amount": 0.1,
  • "range_Type": "string",
  • "thru_Range": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanPreEx

Lists all PlanPreEx 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}/pre-existing-coverages
Request samples
Response samples
No sample

Get PlanPreEx

Gets PlanPreEx

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

coverageType
required
string

Coverage Type

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/pre-existing-coverages/{coverageType}
Request samples
Response samples
No sample

Update PlanPreEx

Updates a specific PlanPreEx.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

coverageType
required
string

Coverage Type

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.

coverage_Type
required
string [ 1 .. 32 ] characters

Coverage type, based on enrollment, that will be applied by the pre-existing condition.

disclosed_Ex_Code
string or null <= 6 characters

ExCode applied to this PlanPreEx disclosure.

disclosed_From_Range
integer or null <int32>

Holds the value of the lower bound of a range defined for disclosed pre-existing entry.

disclosed_Pre_Ex_Amount
number or null <double>

Amount allowed before a pend/deny on a pre-ex claim detail line, use in conjunction with Disclosed_Ex_Code.

disclosed_Range_Type
string or null <= 16 characters

Defines the type of range used with the bounds of the disclosed range. D = Days, M = Months.

disclosed_Thru_Range
integer or null <int32>

Holds the value of the upper bound of a range defined for disclosed pre-existing entry.

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.

ex_Code
string or null <= 6 characters

Ex Code associated with the pre-existing condition.

from_Range
integer or null <int32>

Beginning of the duration range that the pre-existing Conditon will apply to.

pre_Ex_Amount
number or null <double>

Dollar amount that will be applied by the pre-existing condition before pending or denying claims.

range_Type
string or null <= 16 characters

Unit of time used to measure the pre-existing Condition duration. Limited to units of either months or days.

thru_Range
integer or null <int32>

End of the duration range that the pre-existing Conditon will apply to.

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}/pre-existing-coverages/{coverageType}
Request samples
{
  • "plan_ID": "string",
  • "coverage_Type": "string",
  • "disclosed_Ex_Code": "string",
  • "disclosed_From_Range": 0,
  • "disclosed_Pre_Ex_Amount": 0.1,
  • "disclosed_Range_Type": "string",
  • "disclosed_Thru_Range": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Range": 0,
  • "pre_Ex_Amount": 0.1,
  • "range_Type": "string",
  • "thru_Range": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete PlanPreEx

Deletes an PlanPreEx

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

coverageType
required
string

Coverage Type

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/plans/{planID}/pre-existing-coverages/{coverageType}
Request samples

Create or Update Batch PlanPreEx

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

coverage_Type
required
string [ 1 .. 32 ] characters

Coverage type, based on enrollment, that will be applied by the pre-existing condition.

disclosed_Ex_Code
string or null <= 6 characters

ExCode applied to this PlanPreEx disclosure.

disclosed_From_Range
integer or null <int32>

Holds the value of the lower bound of a range defined for disclosed pre-existing entry.

disclosed_Pre_Ex_Amount
number or null <double>

Amount allowed before a pend/deny on a pre-ex claim detail line, use in conjunction with Disclosed_Ex_Code.

disclosed_Range_Type
string or null <= 16 characters

Defines the type of range used with the bounds of the disclosed range. D = Days, M = Months.

disclosed_Thru_Range
integer or null <int32>

Holds the value of the upper bound of a range defined for disclosed pre-existing entry.

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.

ex_Code
string or null <= 6 characters

Ex Code associated with the pre-existing condition.

from_Range
integer or null <int32>

Beginning of the duration range that the pre-existing Conditon will apply to.

pre_Ex_Amount
number or null <double>

Dollar amount that will be applied by the pre-existing condition before pending or denying claims.

range_Type
string or null <= 16 characters

Unit of time used to measure the pre-existing Condition duration. Limited to units of either months or days.

thru_Range
integer or null <int32>

End of the duration range that the pre-existing Conditon will apply to.

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