Provider Network

Create ProviderNetwork

Creates a new ProviderNetwork by assigning an existing Network to a Provider for a given Effective Date.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

networkId
required
string

Network ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

network_ID
required
string [ 1 .. 10 ] characters

Indicates which Network the options will be associated with.

eff_Date
required
string <date-time>

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

claim_Days_Allowed
integer or null <int32>

No longer in use.

disc_Pct
number or null <double>

Indicates the discount percentage that will be applied to the selected fee schedule.

disc_Pct_2
number or null <double>

The Discount Percentage for the Secondary Fee Schedule

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.

fee_Sched
string or null <= 8 characters

Allows the User to select an existing fee schedule to base their pricing upon.

fee_Sched_2
string or null <= 8 characters

If the primary Fee Schedule for the Provider Network does not match, attempt to match on this Secondary Fee Schedule

no_Proc_In_Fee_Disc_Pct
number or null <double>

This is the adjustment percentage that will be used if the 'Use Not in Fee Adj.' option is selected.

priority
integer or null <int32>

Indicates the network-level priority of the Provider's network affiliation. This priority is used in the adjudication calculation to assign networks. The network with the lowest sum (network level priority + group level priority) will be assigned.

reason_Comment
string or null <= 1024 characters

Allows the User to add any relevant notes regarding the reason for termination.

reason_ID
integer or null <int32>

Indicates the reason for termination of the associated network.

term_Date
string or null <date-time>

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

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.

use_No_Proc_In_Fee
required
boolean

If a procedure code match can not be found in the selected fee schedule, adjudication will use a flat adjustment percentage instead. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/providers/{providerId}/networks/{networkId}
Request samples
{
  • "provider_ID": "string",
  • "network_ID": "string",
  • "eff_Date": "2019-08-24T14:15:22Z",
  • "claim_Days_Allowed": 0,
  • "disc_Pct": 0.1,
  • "disc_Pct_2": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Sched": "string",
  • "fee_Sched_2": "string",
  • "no_Proc_In_Fee_Disc_Pct": 0.1,
  • "priority": 0,
  • "reason_Comment": "string",
  • "reason_ID": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_No_Proc_In_Fee": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get ProviderNetwork

Gets ProviderNetwork

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerId
required
string

Provider ID

networkId
required
string

Network ID

effectiveDate
required
string <date>

Effective Date

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/providers/{providerId}/networks/{networkId}/effective-date/{effectiveDate}
Request samples 
Response samples 
No sample
Update ProviderNetwork
Updates a specific ProviderNetwork. Note: The Provider ID, Network ID and Effective Date cannot be changed.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
networkId
required
string
Network ID


 
effectiveDate
required
string <date> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
network_ID
required
string  [ 1 .. 10 ] characters 
Indicates which Network the options will be associated with.


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


 
claim_Days_Allowed
integer or null <int32> 
No longer in use.


 
disc_Pct
number or null <double> 
Indicates the discount percentage that will be applied to the selected fee schedule.


 
disc_Pct_2
number or null <double> 
The Discount Percentage for the Secondary Fee Schedule


 
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.


 
fee_Sched
string or null  <= 8 characters 
Allows the User to select an existing fee schedule to base their pricing upon.


 
fee_Sched_2
string or null  <= 8 characters 
If the primary Fee Schedule for the Provider Network does not match, attempt to match on this Secondary Fee Schedule


 
no_Proc_In_Fee_Disc_Pct
number or null <double> 
This is the adjustment percentage that will be used if the 'Use Not in Fee Adj.' option is selected.


 
priority
integer or null <int32> 
Indicates the network-level priority of the Provider's network affiliation. This priority is used in the adjudication calculation to assign networks. The network with the lowest sum (network level priority + group level priority) will be assigned.


 
reason_Comment
string or null  <= 1024 characters 
Allows the User to add any relevant notes regarding the reason for termination.


 
reason_ID
integer or null <int32> 
Indicates the reason for termination of the associated network.


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


 
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.


 
use_No_Proc_In_Fee
required
boolean
If a procedure code match can not be found in the selected fee schedule, adjudication will use a flat adjustment percentage instead. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerId}/networks/{networkId}/effective-date/{effectiveDate}
Request samples 
{
  • "provider_ID": "string",
  • "network_ID": "string",
  • "eff_Date": "2019-08-24T14:15:22Z",
  • "claim_Days_Allowed": 0,
  • "disc_Pct": 0.1,
  • "disc_Pct_2": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Sched": "string",
  • "fee_Sched_2": "string",
  • "no_Proc_In_Fee_Disc_Pct": 0.1,
  • "priority": 0,
  • "reason_Comment": "string",
  • "reason_ID": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_No_Proc_In_Fee": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderNetwork
Deletes an ProviderNetwork


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
networkId
required
string
Network ID


 
effectiveDate
required
string <date> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerId}/networks/{networkId}/effective-date/{effectiveDate}
Request samples 
List ProviderNetworks by Provider
Gets a List of ProviderNetworks for a given Provider ID


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}/networks
Request samples 
Response samples 
No sample
Update Batch ProviderNetwork
Updates a multiple ProviderNetwork.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerId
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
network_ID
required
string  [ 1 .. 10 ] characters 
Indicates which Network the options will be associated with.


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


 
claim_Days_Allowed
integer or null <int32> 
No longer in use.


 
disc_Pct
number or null <double> 
Indicates the discount percentage that will be applied to the selected fee schedule.


 
disc_Pct_2
number or null <double> 
The Discount Percentage for the Secondary Fee Schedule


 
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.


 
fee_Sched
string or null  <= 8 characters 
Allows the User to select an existing fee schedule to base their pricing upon.


 
fee_Sched_2
string or null  <= 8 characters 
If the primary Fee Schedule for the Provider Network does not match, attempt to match on this Secondary Fee Schedule


 
no_Proc_In_Fee_Disc_Pct
number or null <double> 
This is the adjustment percentage that will be used if the 'Use Not in Fee Adj.' option is selected.


 
priority
integer or null <int32> 
Indicates the network-level priority of the Provider's network affiliation. This priority is used in the adjudication calculation to assign networks. The network with the lowest sum (network level priority + group level priority) will be assigned.


 
reason_Comment
string or null  <= 1024 characters 
Allows the User to add any relevant notes regarding the reason for termination.


 
reason_ID
integer or null <int32> 
Indicates the reason for termination of the associated network.


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


 
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.


 
use_No_Proc_In_Fee
required
boolean
If a procedure code match can not be found in the selected fee schedule, adjudication will use a flat adjustment percentage instead. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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