Fee Schedule Details

Create FeeSchedDetail

Creates a new FeeSchedDetail

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
feeSchedDetail_Key
required
integer <int32>

Unique identifier for each Detail record on this Fee Schedule. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

allowed_Over_Billed
required
boolean

This option allows the ‘Fee Schedule’ to price above the billed amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

always_Use_Rate
required
boolean

This field is currently informational only. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

billed_Pct
number or null <double>

Price based upon a percentage of the billed amount that will be applied to the matching claim detail record through the ‘Fee Schedule’.

diag_Code
string or null <= 8 characters

Requires a matching diagnosis code on the claim for adjudication matching. Start of a range of diagnosis codes when combined with 'Diag Thru'.

diag_Code_Thru
string or null <= 8 characters

End of the diagnosis range when combined with ‘Diag.’.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates the ICD version associated with the selected Diagnosis Codes.

drug_Code
string or null <= 32 characters

This will require a matching ‘Drug Code’ within a claim line during adjudication.

effective_Date
required
string <date-time>

Date when the schedule should begin applying to claims. This date will be compared to the date of service on the claim.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Applies the provided Ex Code to any claim that has been repriced by this ‘Fee Schedule Fee’.

fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

from_Age
integer or null <int32>

Starting point for the range of acceptable ages for the Fee Schedule.

from_Units
integer or null <int32>

Starting point for the range of acceptable number of units within a claim for matching during adjudication.

modifier
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier2
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier3
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier4
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

no_UC_Percent
number or null <double>

Price based upon a percentage of the billed amount that is used for Out of Network claims that could not be matched with a usual and customary rate.

place_Of_Service
string or null <= 5 characters

Requires a matching place of service on the claim for adjudication matching. Start of a range of PoS when combined with 'PoS Thru'.

place_Of_Service_Thru
string or null <= 5 characters

End of the PoS range when combined with ‘PoS’.

price
number or null <double>

Price that will be applied to the matching claim detail record through the ‘Fee Schedule’. This will be multiplied by the number of units within the claim.

procedure_Cluster
string or null <= 32 characters

This allows the price to be applied to all procedures within a selected procedure cluster.

procedure_Code
required
string [ 1 .. 8 ] characters

This section can contain CPT, HCPC, or revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

procedure_Code2
string or null <= 8 characters

This section can contain CPT, HCPC, or revenue codes. This field is compared to the 'Procedure Code 2' field on the claim's detail line.

procedure_Code_Thru
string or null <= 8 characters

This section can contain CPT, HCPC, or Revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

provider_Type
string or null <= 10 characters

Requires a matching Provider type on the claim for adjudication matching.

rvS_Units
number or null <double>

This field is currently informational only.

specialty_Code
string or null <= 10 characters

Requires a matching specialty code on the claim for adjudication matching.

thru_Age
integer or null <int32>

Ending point for the range of acceptable ages for the Fee Schedule.

thru_Units
integer or null <int32>

Ending point for the range of acceptable number of units within a claim for matching during adjudication.

type_Of_Service
string or null <= 5 characters

No longer in use.

uC_Claim_Type
string or null <= 20 characters

Allows the User to select an existing rate group to base their pricing upon. For instance, if you are building a ‘Fee Schedule’ that uses a percentage of Medicare rates. These rate groups need to be provided by the User and uploaded by VBA.

uC_Percent
number or null <double>

The desired percentage applied from the selected rate group to the matching claim.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/fee-schedule-details
Request samples
{
  • "feeSchedDetail_Key": 0,
  • "allowed_Over_Billed": true,
  • "always_Use_Rate": true,
  • "billed_Pct": 0.1,
  • "diag_Code": "string",
  • "diag_Code_Thru": "string",
  • "diagnostic_Code_Type": "string",
  • "drug_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fee_Sched": "string",
  • "from_Age": 0,
  • "from_Units": 0,
  • "modifier": "string",
  • "modifier2": "string",
  • "modifier3": "string",
  • "modifier4": "string",
  • "no_UC_Percent": 0.1,
  • "place_Of_Service": "strin",
  • "place_Of_Service_Thru": "strin",
  • "price": 0.1,
  • "procedure_Cluster": "string",
  • "procedure_Code": "string",
  • "procedure_Code2": "string",
  • "procedure_Code_Thru": "string",
  • "provider_Type": "string",
  • "rvS_Units": 0.1,
  • "specialty_Code": "string",
  • "thru_Age": 0,
  • "thru_Units": 0,
  • "type_Of_Service": "strin",
  • "uC_Claim_Type": "string",
  • "uC_Percent": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List FeeSchedDetail

Lists all FeeSchedDetail

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/fee-schedule-details
Request samples
Response samples
No sample

Get FeeSchedDetail

Gets FeeSchedDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSchedDetailKey
required
integer <int32>

FeeSchedDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/fee-schedule-details/{feeSchedDetailKey}
Request samples
Response samples
No sample

Update FeeSchedDetail

Updates a specific FeeSchedDetail.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSchedDetailKey
required
integer <int32>

FeeSchedDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
feeSchedDetail_Key
required
integer <int32>

Unique identifier for each Detail record on this Fee Schedule. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

allowed_Over_Billed
required
boolean

This option allows the ‘Fee Schedule’ to price above the billed amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

always_Use_Rate
required
boolean

This field is currently informational only. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

billed_Pct
number or null <double>

Price based upon a percentage of the billed amount that will be applied to the matching claim detail record through the ‘Fee Schedule’.

diag_Code
string or null <= 8 characters

Requires a matching diagnosis code on the claim for adjudication matching. Start of a range of diagnosis codes when combined with 'Diag Thru'.

diag_Code_Thru
string or null <= 8 characters

End of the diagnosis range when combined with ‘Diag.’.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates the ICD version associated with the selected Diagnosis Codes.

drug_Code
string or null <= 32 characters

This will require a matching ‘Drug Code’ within a claim line during adjudication.

effective_Date
required
string <date-time>

Date when the schedule should begin applying to claims. This date will be compared to the date of service on the claim.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Applies the provided Ex Code to any claim that has been repriced by this ‘Fee Schedule Fee’.

fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

from_Age
integer or null <int32>

Starting point for the range of acceptable ages for the Fee Schedule.

from_Units
integer or null <int32>

Starting point for the range of acceptable number of units within a claim for matching during adjudication.

modifier
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier2
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier3
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier4
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

no_UC_Percent
number or null <double>

Price based upon a percentage of the billed amount that is used for Out of Network claims that could not be matched with a usual and customary rate.

place_Of_Service
string or null <= 5 characters

Requires a matching place of service on the claim for adjudication matching. Start of a range of PoS when combined with 'PoS Thru'.

place_Of_Service_Thru
string or null <= 5 characters

End of the PoS range when combined with ‘PoS’.

price
number or null <double>

Price that will be applied to the matching claim detail record through the ‘Fee Schedule’. This will be multiplied by the number of units within the claim.

procedure_Cluster
string or null <= 32 characters

This allows the price to be applied to all procedures within a selected procedure cluster.

procedure_Code
required
string [ 1 .. 8 ] characters

This section can contain CPT, HCPC, or revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

procedure_Code2
string or null <= 8 characters

This section can contain CPT, HCPC, or revenue codes. This field is compared to the 'Procedure Code 2' field on the claim's detail line.

procedure_Code_Thru
string or null <= 8 characters

This section can contain CPT, HCPC, or Revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

provider_Type
string or null <= 10 characters

Requires a matching Provider type on the claim for adjudication matching.

rvS_Units
number or null <double>

This field is currently informational only.

specialty_Code
string or null <= 10 characters

Requires a matching specialty code on the claim for adjudication matching.

thru_Age
integer or null <int32>

Ending point for the range of acceptable ages for the Fee Schedule.

thru_Units
integer or null <int32>

Ending point for the range of acceptable number of units within a claim for matching during adjudication.

type_Of_Service
string or null <= 5 characters

No longer in use.

uC_Claim_Type
string or null <= 20 characters

Allows the User to select an existing rate group to base their pricing upon. For instance, if you are building a ‘Fee Schedule’ that uses a percentage of Medicare rates. These rate groups need to be provided by the User and uploaded by VBA.

uC_Percent
number or null <double>

The desired percentage applied from the selected rate group to the matching claim.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

put/fee-schedule-details/{feeSchedDetailKey}
Request samples
{
  • "feeSchedDetail_Key": 0,
  • "allowed_Over_Billed": true,
  • "always_Use_Rate": true,
  • "billed_Pct": 0.1,
  • "diag_Code": "string",
  • "diag_Code_Thru": "string",
  • "diagnostic_Code_Type": "string",
  • "drug_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fee_Sched": "string",
  • "from_Age": 0,
  • "from_Units": 0,
  • "modifier": "string",
  • "modifier2": "string",
  • "modifier3": "string",
  • "modifier4": "string",
  • "no_UC_Percent": 0.1,
  • "place_Of_Service": "strin",
  • "place_Of_Service_Thru": "strin",
  • "price": 0.1,
  • "procedure_Cluster": "string",
  • "procedure_Code": "string",
  • "procedure_Code2": "string",
  • "procedure_Code_Thru": "string",
  • "provider_Type": "string",
  • "rvS_Units": 0.1,
  • "specialty_Code": "string",
  • "thru_Age": 0,
  • "thru_Units": 0,
  • "type_Of_Service": "strin",
  • "uC_Claim_Type": "string",
  • "uC_Percent": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete FeeSchedDetail

Deletes an FeeSchedDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
feeSchedDetailKey
required
integer <int32>

FeeSchedDetail Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/fee-schedule-details/{feeSchedDetailKey}
Request samples

Create or Update Batch FeeSchedDetail

Create or Update multiple FeeSchedDetail at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
feeSchedDetail_Key
required
integer <int32>

Unique identifier for each Detail record on this Fee Schedule. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

allowed_Over_Billed
required
boolean

This option allows the ‘Fee Schedule’ to price above the billed amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

always_Use_Rate
required
boolean

This field is currently informational only. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

billed_Pct
number or null <double>

Price based upon a percentage of the billed amount that will be applied to the matching claim detail record through the ‘Fee Schedule’.

diag_Code
string or null <= 8 characters

Requires a matching diagnosis code on the claim for adjudication matching. Start of a range of diagnosis codes when combined with 'Diag Thru'.

diag_Code_Thru
string or null <= 8 characters

End of the diagnosis range when combined with ‘Diag.’.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Indicates the ICD version associated with the selected Diagnosis Codes.

drug_Code
string or null <= 32 characters

This will require a matching ‘Drug Code’ within a claim line during adjudication.

effective_Date
required
string <date-time>

Date when the schedule should begin applying to claims. This date will be compared to the date of service on the claim.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

ex_Code
string or null <= 6 characters

Applies the provided Ex Code to any claim that has been repriced by this ‘Fee Schedule Fee’.

fee_Sched
required
string [ 1 .. 8 ] characters

Unique name given to the Fee Scheudle.

from_Age
integer or null <int32>

Starting point for the range of acceptable ages for the Fee Schedule.

from_Units
integer or null <int32>

Starting point for the range of acceptable number of units within a claim for matching during adjudication.

modifier
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier2
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier3
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

modifier4
string or null <= 8 characters

Modifiers applicable to codes can be entered. Each of the modifiers can be applied to a single code or multiple codes in the line. Modifier payment reductions can be set up in ‘Fee Schedule Configuration’ and can be applied each time the modifier is included on a claim.

no_UC_Percent
number or null <double>

Price based upon a percentage of the billed amount that is used for Out of Network claims that could not be matched with a usual and customary rate.

place_Of_Service
string or null <= 5 characters

Requires a matching place of service on the claim for adjudication matching. Start of a range of PoS when combined with 'PoS Thru'.

place_Of_Service_Thru
string or null <= 5 characters

End of the PoS range when combined with ‘PoS’.

price
number or null <double>

Price that will be applied to the matching claim detail record through the ‘Fee Schedule’. This will be multiplied by the number of units within the claim.

procedure_Cluster
string or null <= 32 characters

This allows the price to be applied to all procedures within a selected procedure cluster.

procedure_Code
required
string [ 1 .. 8 ] characters

This section can contain CPT, HCPC, or revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

procedure_Code2
string or null <= 8 characters

This section can contain CPT, HCPC, or revenue codes. This field is compared to the 'Procedure Code 2' field on the claim's detail line.

procedure_Code_Thru
string or null <= 8 characters

This section can contain CPT, HCPC, or Revenue codes. Every line requires the first procedure code field to be completed, even when using a procedure cluster. Note: If entering a range of codes, the fee entered on that line will apply to all codes in the range.

provider_Type
string or null <= 10 characters

Requires a matching Provider type on the claim for adjudication matching.

rvS_Units
number or null <double>

This field is currently informational only.

specialty_Code
string or null <= 10 characters

Requires a matching specialty code on the claim for adjudication matching.

thru_Age
integer or null <int32>

Ending point for the range of acceptable ages for the Fee Schedule.

thru_Units
integer or null <int32>

Ending point for the range of acceptable number of units within a claim for matching during adjudication.

type_Of_Service
string or null <= 5 characters

No longer in use.

uC_Claim_Type
string or null <= 20 characters

Allows the User to select an existing rate group to base their pricing upon. For instance, if you are building a ‘Fee Schedule’ that uses a percentage of Medicare rates. These rate groups need to be provided by the User and uploaded by VBA.

uC_Percent
number or null <double>

The desired percentage applied from the selected rate group to the matching claim.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
207

Success

401

Unauthorized

put/fee-schedule-details-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}