Plan Benefit Diagnosis Ex Codes

Create PlanBenefitsDiagnosis

Creates a new PlanBenefitsDiagnosis

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.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.

diagnostic_Code
required
string [ 1 .. 8 ] characters

First Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.

diagnostic_Code_Thru
string or null <= 8 characters

Last Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.

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
required
string [ 1 .. 6 ] characters

This is the Ex Code that will be applied to any claims containing a diagnosis code within the defined range.

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}/diagnosis-ex-codes
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Thru": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitsDiagnosis

Lists all PlanBenefitsDiagnosis 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}/diagnosis-ex-codes
Request samples 
Response samples 
No sample
Get PlanBenefitsDiagnosis
Gets PlanBenefitsDiagnosis


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
diagnosticCode
required
string
Diagnostic Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/diagnosis-ex-codes/{diagnosticCodeType}/{diagnosticCode}
Request samples 
Response samples 
No sample
Update PlanBenefitsDiagnosis
Updates a specific PlanBenefitsDiagnosis.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
diagnosticCode
required
string
Diagnostic 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.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
First Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.


 
diagnostic_Code_Thru
string or null  <= 8 characters 
Last Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.


 
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
required
string  [ 1 .. 6 ] characters 
This is the Ex Code that will be applied to any claims containing a diagnosis code within the defined range.


 
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}/diagnosis-ex-codes/{diagnosticCodeType}/{diagnosticCode}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Thru": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitsDiagnosis
Deletes an PlanBenefitsDiagnosis


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
diagnosticCode
required
string
Diagnostic Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/diagnosis-ex-codes/{diagnosticCodeType}/{diagnosticCode}
Request samples 
Create or Update Batch PlanBenefitsDiagnosis
Create or Update multiple PlanBenefitsDiagnosis 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.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
First Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.


 
diagnostic_Code_Thru
string or null  <= 8 characters 
Last Diagnosis Code for the specified range. This allows the User to apply the specified Ex Code to any claims containing a diagnosis code within the defined range.


 
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
required
string  [ 1 .. 6 ] characters 
This is the Ex Code that will be applied to any claims containing a diagnosis code within the defined range.


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