Network Procedure Clusters

Create NetworkProcedureCluster

Creates a new NetworkProcedureCluster

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
networkID
required
string

Network ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
network_ID
required
string [ 1 .. 50 ] characters

Unique identifier assigned to the network.

procedure_Cluster
required
string [ 1 .. 32 ] characters

Identifies the procedure cluster that is to be tied to the pricing rule.

effective_Date
required
string <date-time>

Date when the pricing rule becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

bill_Percent
number or null <double>

Used with the pricing claimrule, sets a value for the allowed amount to a percentage of the billed amount during adjudication. Subsequent claimrules may affect pricing.

claim_Type
string or null <= 20 characters

Defines what type of claims the Network Procedure Cluster applies to

context4Fg
required
boolean

This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

fee_Percent
number or null <double>

Specifies the fee percentage that is to be tied to the selected procedure cluster. Negative values will apply a discount.

flat_Rate
number or null <double>

Used with the pricing claimrule, sets a value for the allowed amount during adjudication. Subsequent claimrules may affect pricing.

term_Date
string or null <date-time>

Date when the pricing rule expires/expired.

update_Date
string <date-time>

Date 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/networks/{networkID}/procedure-clusters
Request samples
{
  • "network_ID": "string",
  • "procedure_Cluster": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "bill_Percent": 0.1,
  • "claim_Type": "string",
  • "context4Fg": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "flat_Rate": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NetworkProcedureCluster

Lists all NetworkProcedureCluster for the given networkID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
networkID
required
string

Network ID

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/networks/{networkID}/procedure-clusters
Request samples 
Response samples 
No sample
Get NetworkProcedureCluster
Gets NetworkProcedureCluster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
networkID
required
string
Network ID


 
procedureCluster
required
string
Procedure Cluster


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/networks/{networkID}/procedure-clusters/{procedureCluster}/{effectiveDate}
Request samples 
Response samples 
No sample
Update NetworkProcedureCluster
Updates a specific NetworkProcedureCluster.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
networkID
required
string
Network ID


 
procedureCluster
required
string
Procedure Cluster


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
network_ID
required
string  [ 1 .. 50 ] characters 
Unique identifier assigned to the network.


 
procedure_Cluster
required
string  [ 1 .. 32 ] characters 
Identifies the procedure cluster that is to be tied to the pricing rule.


 
effective_Date
required
string <date-time> 
Date when the pricing rule becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
bill_Percent
number or null <double> 
Used with the pricing claimrule, sets a value for the allowed amount to a percentage of the billed amount during adjudication. Subsequent claimrules may affect pricing.


 
claim_Type
string or null  <= 20 characters 
Defines what type of claims the Network Procedure Cluster applies to


 
context4Fg
required
boolean
This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
fee_Percent
number or null <double> 
Specifies the fee percentage that is to be tied to the selected procedure cluster. Negative values will apply a discount.


 
flat_Rate
number or null <double> 
Used with the pricing claimrule, sets a value for the allowed amount during adjudication. Subsequent claimrules may affect pricing.


 
term_Date
string or null <date-time> 
Date when the pricing rule expires/expired.


 
update_Date
string <date-time> 
Date 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/networks/{networkID}/procedure-clusters/{procedureCluster}/{effectiveDate}
Request samples 
{
  • "network_ID": "string",
  • "procedure_Cluster": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "bill_Percent": 0.1,
  • "claim_Type": "string",
  • "context4Fg": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "flat_Rate": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NetworkProcedureCluster
Deletes an NetworkProcedureCluster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
networkID
required
string
Network ID


 
procedureCluster
required
string
Procedure Cluster


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/networks/{networkID}/procedure-clusters/{procedureCluster}/{effectiveDate}
Request samples 
Create or Update Batch NetworkProcedureCluster
Create or Update multiple NetworkProcedureCluster 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
networkID
required
string
Network ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
network_ID
required
string  [ 1 .. 50 ] characters 
Unique identifier assigned to the network.


 
procedure_Cluster
required
string  [ 1 .. 32 ] characters 
Identifies the procedure cluster that is to be tied to the pricing rule.


 
effective_Date
required
string <date-time> 
Date when the pricing rule becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
bill_Percent
number or null <double> 
Used with the pricing claimrule, sets a value for the allowed amount to a percentage of the billed amount during adjudication. Subsequent claimrules may affect pricing.


 
claim_Type
string or null  <= 20 characters 
Defines what type of claims the Network Procedure Cluster applies to


 
context4Fg
required
boolean
This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
fee_Percent
number or null <double> 
Specifies the fee percentage that is to be tied to the selected procedure cluster. Negative values will apply a discount.


 
flat_Rate
number or null <double> 
Used with the pricing claimrule, sets a value for the allowed amount during adjudication. Subsequent claimrules may affect pricing.


 
term_Date
string or null <date-time> 
Date when the pricing rule expires/expired.


 
update_Date
string <date-time> 
Date 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/networks/{networkID}/procedure-clusters-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}