Capitations

Create Capitation

Creates a new Capitation

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

CapitationTransaction Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitation_Key
required
integer <int32>

ID for the capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

account_Key
integer or null <int32>

Account number of the Payor.

age
integer or null <int32>

Age of the Member who is associated with the capitation.

capitationPlanRate_Key
integer or null <int32>

ID of the capitation plan rate.

capitationTransaction_Key
integer or null <int32>

ID for the capitation transaction.

capitation_Amount
number or null <double>

Amount of the capitation adjustment.

capitation_Date
string or null <date-time>

Date when the capitation adjustment takes place.

division_ID
string or null <= 20 characters

ID of the Division that is associated with the capitation.

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

group_ID
string or null <= 20 characters

ID of the Group that is associated with the capitation.

member_Seq
string or null <= 2 characters

Sequential ID of the Member who is associated with the capitation.

payor_ID
string or null <= 20 characters

ID of the Payor who is associated with the capitation.

plan_ID
string or null <= 20 characters

ID of the plan that the capitation is associated with.

provider_ID
string or null <= 20 characters

ID of the Provider who is associated with the capitation.

subscriber_ID
string or null <= 9 characters

ID of the Subscriber who is associated with the capitation.

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/capitation-transactions/{capitationTransactionKey}/capitations
Request samples
{
  • "capitation_Key": 0,
  • "account_Key": 0,
  • "age": 0,
  • "capitationPlanRate_Key": 0,
  • "capitationTransaction_Key": 0,
  • "capitation_Amount": 0.1,
  • "capitation_Date": "2019-08-24T14:15:22Z",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Capitation

Lists all Capitation for the given capitationTransactionKey

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

CapitationTransaction Key

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/capitation-transactions/{capitationTransactionKey}/capitations
Request samples 
Response samples 
No sample
List Unassigned Capitation
Lists all Capitation that is currently not assigned to a Capitation Transaction


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/unassigned-capitations
Request samples 
Response samples 
No sample
Get Capitation
Gets Capitation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
capitationKey
required
integer <int32> 
Capitation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/capitation-transactions/{capitationTransactionKey}/capitations/{capitationKey}
Request samples 
Response samples 
No sample
Update Capitation
Updates a specific Capitation.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
capitationKey
required
integer <int32> 
Capitation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
capitation_Key
required
integer <int32> 
ID for the capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account number of the Payor.


 
age
integer or null <int32> 
Age of the Member who is associated with the capitation.


 
capitationPlanRate_Key
integer or null <int32> 
ID of the capitation plan rate.


 
capitationTransaction_Key
integer or null <int32> 
ID for the capitation transaction.


 
capitation_Amount
number or null <double> 
Amount of the capitation adjustment.


 
capitation_Date
string or null <date-time> 
Date when the capitation adjustment takes place.


 
division_ID
string or null  <= 20 characters 
ID of the Division that is associated with the capitation.


 
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


 
group_ID
string or null  <= 20 characters 
ID of the Group that is associated with the capitation.


 
member_Seq
string or null  <= 2 characters 
Sequential ID of the Member who is associated with the capitation.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor who is associated with the capitation.


 
plan_ID
string or null  <= 20 characters 
ID of the plan that the capitation is associated with.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider who is associated with the capitation.


 
subscriber_ID
string or null  <= 9 characters 
ID of the Subscriber who is associated with the capitation.


 
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/capitation-transactions/{capitationTransactionKey}/capitations/{capitationKey}
Request samples 
{
  • "capitation_Key": 0,
  • "account_Key": 0,
  • "age": 0,
  • "capitationPlanRate_Key": 0,
  • "capitationTransaction_Key": 0,
  • "capitation_Amount": 0.1,
  • "capitation_Date": "2019-08-24T14:15:22Z",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Capitation
Deletes an Capitation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
capitationKey
required
integer <int32> 
Capitation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-transactions/{capitationTransactionKey}/capitations/{capitationKey}
Request samples 
Capitation Generate Advanced API 
Generates Capitation records and attaches those to a new Capitation Transaction based on entered criteria.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
member_Seq
string or null
 
plan_ID
string or null
 
provider_ID
string or null
 
capitation_Date
string or null <date-time> 
 
capitation_Category
string or null
 
payee_ID
string or null
 
capitationKeys
Array of integers or null <int32> 
 
Responses 
204
Success


401
Unauthorized


post/capitation-generate
Request samples 
{
  • "payor_ID": "string",
  • "account_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "plan_ID": "string",
  • "provider_ID": "string",
  • "capitation_Date": "2019-08-24T14:15:22Z",
  • "capitation_Category": "string",
  • "payee_ID": "string",
  • "capitationKeys": [
    ]
}
Capitation Generate Set Unassigned Advanced API 
Takes existing unassigned capitation records and attaches them to the chosen Provider on a newly created Capitation Transaction.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
member_Seq
string or null
 
plan_ID
string or null
 
provider_ID
string or null
 
capitation_Date
string or null <date-time> 
 
capitation_Category
string or null
 
payee_ID
string or null
 
capitationKeys
Array of integers or null <int32> 
 
Responses 
204
Success


401
Unauthorized


post/capitation-generate-set-unassigned
Request samples 
{
  • "payor_ID": "string",
  • "account_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "plan_ID": "string",
  • "provider_ID": "string",
  • "capitation_Date": "2019-08-24T14:15:22Z",
  • "capitation_Category": "string",
  • "payee_ID": "string",
  • "capitationKeys": [
    ]
}
Capitation Generate Assign Advanced API 
Takes selected unassigned list of CapitationKeys and a valid Payee, and attaches them to a newly created Capitation Transaction.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
member_Seq
string or null
 
plan_ID
string or null
 
provider_ID
string or null
 
capitation_Date
string or null <date-time> 
 
capitation_Category
string or null
 
payee_ID
string or null
 
capitationKeys
Array of integers or null <int32> 
 
Responses 
200
Success


401
Unauthorized


post/capitation-generate-assign
Request samples 
{
  • "payor_ID": "string",
  • "account_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "plan_ID": "string",
  • "provider_ID": "string",
  • "capitation_Date": "2019-08-24T14:15:22Z",
  • "capitation_Category": "string",
  • "payee_ID": "string",
  • "capitationKeys": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Create or Update Batch Capitation
Create or Update multiple Capitation 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
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
capitation_Key
required
integer <int32> 
ID for the capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
integer or null <int32> 
Account number of the Payor.


 
age
integer or null <int32> 
Age of the Member who is associated with the capitation.


 
capitationPlanRate_Key
integer or null <int32> 
ID of the capitation plan rate.


 
capitationTransaction_Key
integer or null <int32> 
ID for the capitation transaction.


 
capitation_Amount
number or null <double> 
Amount of the capitation adjustment.


 
capitation_Date
string or null <date-time> 
Date when the capitation adjustment takes place.


 
division_ID
string or null  <= 20 characters 
ID of the Division that is associated with the capitation.


 
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


 
group_ID
string or null  <= 20 characters 
ID of the Group that is associated with the capitation.


 
member_Seq
string or null  <= 2 characters 
Sequential ID of the Member who is associated with the capitation.


 
payor_ID
string or null  <= 20 characters 
ID of the Payor who is associated with the capitation.


 
plan_ID
string or null  <= 20 characters 
ID of the plan that the capitation is associated with.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider who is associated with the capitation.


 
subscriber_ID
string or null  <= 9 characters 
ID of the Subscriber who is associated with the capitation.


 
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/capitation-transactions/{capitationTransactionKey}/capitations-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}