Provider APC

Create ProviderAPC

Creates a new ProviderAPC

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerAPC_Key
required
integer <int32>

Unique identifier assigned to each APC configuration record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

apC_Rate
number or null <double>

Rate used for APC calculations.

apC_Schedule
string or null <= 16 characters

Allows the User to select an existing 'Ambulatory Payment Classification' schedule to base their pricing upon. These ‘APC Schedules’ need to be provided by the User and uploaded by VBA.

apply_OON
required
boolean

Indicates whether the rate will be applied to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

cost_To_Charge
number or null <double>

Cost to charge ratio used for APC calculations.

effective_Date
required
string <date-time>

Start of the range of acceptable service dates for the modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first 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 price line.

min_Amount
number or null <double>

The minimum amount that can be applied to this calculation.

network_ID
string or null <= 50 characters

The Network ID setting for this APC configuration.

provider_ID
required
string [ 1 .. 20 ] characters

The Provider ID associated to this APC configuration.

term_Date
string or null <date-time>

End of the range of acceptable service dates for the modifier.

trim_Point
number or null <double>

Trim point used for APC calculations.

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.

variable_Cost_Factor
number or null <double>

Variable cost factor used for APC calculations.

Responses
200

Success

401

Unauthorized

post/providers/{providerID}/apcs
Request samples
{
  • "providerAPC_Key": 0,
  • "apC_Rate": 0.1,
  • "apC_Schedule": "string",
  • "apply_OON": true,
  • "cost_To_Charge": 0.1,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "min_Amount": 0.1,
  • "network_ID": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "trim_Point": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "variable_Cost_Factor": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderAPCs

List APCs for a given Provider

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAPCKey
required
integer <int32> 
ProviderAPC Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/apcs/{providerAPCKey}
Request samples 
Response samples 
No sample
Update ProviderAPC
Updates a specific ProviderAPC.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAPCKey
required
integer <int32> 
ProviderAPC Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerAPC_Key
required
integer <int32> 
Unique identifier assigned to each APC configuration record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apC_Rate
number or null <double> 
Rate used for APC calculations.


 
apC_Schedule
string or null  <= 16 characters 
Allows the User to select an existing 'Ambulatory Payment Classification' schedule to base their pricing upon. These ‘APC Schedules’ need to be provided by the User and uploaded by VBA.


 
apply_OON
required
boolean
Indicates whether the rate will be applied to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cost_To_Charge
number or null <double> 
Cost to charge ratio used for APC calculations.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first 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 price line.


 
min_Amount
number or null <double> 
The minimum amount that can be applied to this calculation.


 
network_ID
string or null  <= 50 characters 
The Network ID setting for this APC configuration.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
The Provider ID associated to this APC configuration.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the modifier.


 
trim_Point
number or null <double> 
Trim point used for APC calculations.


 
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.


 
variable_Cost_Factor
number or null <double> 
Variable cost factor used for APC calculations.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}/apcs/{providerAPCKey}
Request samples 
{
  • "providerAPC_Key": 0,
  • "apC_Rate": 0.1,
  • "apC_Schedule": "string",
  • "apply_OON": true,
  • "cost_To_Charge": 0.1,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "min_Amount": 0.1,
  • "network_ID": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "trim_Point": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "variable_Cost_Factor": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderAPC
Deletes an ProviderAPC


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerAPCKey
required
integer <int32> 
ProviderAPC Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/apcs/{providerAPCKey}
Request samples 
Create or Update Batch ProviderAPC
Create or Update multiple ProviderAPC 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
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerAPC_Key
required
integer <int32> 
Unique identifier assigned to each APC configuration record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
apC_Rate
number or null <double> 
Rate used for APC calculations.


 
apC_Schedule
string or null  <= 16 characters 
Allows the User to select an existing 'Ambulatory Payment Classification' schedule to base their pricing upon. These ‘APC Schedules’ need to be provided by the User and uploaded by VBA.


 
apply_OON
required
boolean
Indicates whether the rate will be applied to Out of Network claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cost_To_Charge
number or null <double> 
Cost to charge ratio used for APC calculations.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was first 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 price line.


 
min_Amount
number or null <double> 
The minimum amount that can be applied to this calculation.


 
network_ID
string or null  <= 50 characters 
The Network ID setting for this APC configuration.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
The Provider ID associated to this APC configuration.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the modifier.


 
trim_Point
number or null <double> 
Trim point used for APC calculations.


 
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.


 
variable_Cost_Factor
number or null <double> 
Variable cost factor used for APC calculations.


 
Responses 
207
Success


401
Unauthorized


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