Provider Rates

Create Provider Rate

Creates a new Provider Rate

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerRate_Key
required
integer <int32>

Unique identifier for each Rate setting.

addOnRateDRG
required
boolean

Indicates that this line is added onto an existing ‘DRG’ rate.

addOnRatePerDiem
required
boolean

Indicates that this line is added onto an existing ‘Per Diem’ rate.

effective_Date
string or null <date-time>

Start of the range of acceptable service dates for the rate line.

end_Date
string or null <date-time>

End of the range of acceptable service dates for the rate line.

ex_Code
string or null <= 6 characters

Ex code associated with the price line.

inpatient
required
boolean

Indicates whether the associated rate is applied to inpatient services.

outpatient
required
boolean

Indicates whether the associated rate is applied to outpatient services.

percent_Type
string or null <= 1 characters

No longer in use.

provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

rate
number or null <double>

Rate used in price calculations.

rate_Percent
required
boolean

Tells the system to read the rate as a percentage instead of flat rate.

rate_Type
string or null <= 1 characters

Determines how the selected rate is applied: Per Service Line – applies the associated rate to each service line that matches the defined criteria. All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim. Per Unit – multiplies the rate by the number of units on the matching service line. Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error. ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines.

Responses
200

Success

401

Unauthorized

post/providers/{providerId}/rates
Request samples
{
  • "providerRate_Key": 0,
  • "addOnRateDRG": true,
  • "addOnRatePerDiem": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "ex_Code": "string",
  • "inpatient": true,
  • "outpatient": true,
  • "percent_Type": "s",
  • "provider_ID": "string",
  • "rate": 0.1,
  • "rate_Percent": true,
  • "rate_Type": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Provider Rates

List Provider Rates

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/providers/{providerId}/rates
Request samples 
Response samples 
No sample
Get Provider Rate
Gets Provider Rate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
ProviderRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerId}/rates/{providerRateKey}
Request samples 
Response samples 
No sample
Update ProviderRate
Updates a specific ProviderRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
ProviderRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerRate_Key
required
integer <int32> 
Unique identifier for each Rate setting.


 
addOnRateDRG
required
boolean
Indicates that this line is added onto an existing ‘DRG’ rate.


 
addOnRatePerDiem
required
boolean
Indicates that this line is added onto an existing ‘Per Diem’ rate.


 
effective_Date
string or null <date-time> 
Start of the range of acceptable service dates for the rate line.


 
end_Date
string or null <date-time> 
End of the range of acceptable service dates for the rate line.


 
ex_Code
string or null  <= 6 characters 
Ex code associated with the price line.


 
inpatient
required
boolean
Indicates whether the associated rate is applied to inpatient services.


 
outpatient
required
boolean
Indicates whether the associated rate is applied to outpatient services.


 
percent_Type
string or null  <= 1 characters 
No longer in use.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
rate
number or null <double> 
Rate used in price calculations.


 
rate_Percent
required
boolean
Tells the system to read the rate as a percentage instead of flat rate.


 
rate_Type
string or null  <= 1 characters 
Determines how the selected rate is applied: Per Service Line – applies the associated rate to each service line that matches the defined criteria. All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim. Per Unit – multiplies the rate by the number of units on the matching service line. Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error. ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerId}/rates/{providerRateKey}
Request samples 
{
  • "providerRate_Key": 0,
  • "addOnRateDRG": true,
  • "addOnRatePerDiem": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "ex_Code": "string",
  • "inpatient": true,
  • "outpatient": true,
  • "percent_Type": "s",
  • "provider_ID": "string",
  • "rate": 0.1,
  • "rate_Percent": true,
  • "rate_Type": "s"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderRate
Deletes an ProviderRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
providerRateKey
required
integer <int32> 
ProviderRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerId}/rates/{providerRateKey}
Request samples 
Update Batch ProviderRate
Updates a multiple ProviderRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerRate_Key
required
integer <int32> 
Unique identifier for each Rate setting.


 
addOnRateDRG
required
boolean
Indicates that this line is added onto an existing ‘DRG’ rate.


 
addOnRatePerDiem
required
boolean
Indicates that this line is added onto an existing ‘Per Diem’ rate.


 
effective_Date
string or null <date-time> 
Start of the range of acceptable service dates for the rate line.


 
end_Date
string or null <date-time> 
End of the range of acceptable service dates for the rate line.


 
ex_Code
string or null  <= 6 characters 
Ex code associated with the price line.


 
inpatient
required
boolean
Indicates whether the associated rate is applied to inpatient services.


 
outpatient
required
boolean
Indicates whether the associated rate is applied to outpatient services.


 
percent_Type
string or null  <= 1 characters 
No longer in use.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
rate
number or null <double> 
Rate used in price calculations.


 
rate_Percent
required
boolean
Tells the system to read the rate as a percentage instead of flat rate.


 
rate_Type
string or null  <= 1 characters 
Determines how the selected rate is applied: Per Service Line – applies the associated rate to each service line that matches the defined criteria. All Service Lines – if any line within a claim matches the criteria, the associated rate is applied to ALL service lines on the claim. Per Unit – multiplies the rate by the number of units on the matching service line. Case Rate – treats the entire claim like a case. The ‘Case Rate’ is applied to an available matching line, and all other service lines are repriced to zero dollars. Only ONE ‘Case Rate’ is allowed per claim. If multiple service lines match a ‘Case Rate’, the claim will error. ASC Grouper – treats the entire claim like case. The ‘ASC Grouper Rate’ is applied to ALL available matching lines, and all other service lines are repriced to zero dollars. This rate is like ‘Case Rate’, but it allows the matching of multiple service lines.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerId}/rates-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}