Capitation Adjustments

Create CapitationAdjustment

Creates a new CapitationAdjustment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitationAdjustment_Key
required
integer <int32>

ID of the capitation adjustment. 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.

adjustment_Amount
number or null <double>

Amount of the capitation adjustment.

adjustment_Date
string or null <date-time>

Date when the capitation adjustment takes place.

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_Adjustment_Reason
string or null <= 8 characters

Reason of the capitation adjustment. 'Capitation Adjustment Reasons' are configured within 'Capitation Configuration'.

capitation_Adjustment_Type
string or null <= 8 characters

Type of the capitation adjustment. 'Capitation Adjustment Types' are configured within 'Capitation Configuration'.

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-adjustments
Request samples
{
  • "capitationAdjustment_Key": 0,
  • "account_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "age": 0,
  • "capitationPlanRate_Key": 0,
  • "capitationTransaction_Key": 0,
  • "capitation_Adjustment_Reason": "string",
  • "capitation_Adjustment_Type": "string",
  • "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 CapitationAdjustment

Lists all CapitationAdjustment for the given capitationTransactionKey. If capitationTransactionKey is not provided, a list of Unassigned Capitation Adjustments will be returned.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
capitationTransactionKey
integer <int32>

CapitationTransaction Key

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-adjustments
Request samples 
Response samples 
No sample
Get CapitationAdjustment
Gets CapitationAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationAdjustmentKey
required
integer <int32> 
CapitationAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/capitation-adjustments/{capitationAdjustmentKey}
Request samples 
Response samples 
No sample
Update CapitationAdjustment
Updates a specific CapitationAdjustment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationAdjustmentKey
required
integer <int32> 
CapitationAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
capitationAdjustment_Key
required
integer <int32> 
ID of the capitation adjustment. 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.


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


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


 
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_Adjustment_Reason
string or null  <= 8 characters 
Reason of the capitation adjustment. 'Capitation Adjustment Reasons' are configured within 'Capitation Configuration'.


 
capitation_Adjustment_Type
string or null  <= 8 characters 
Type of the capitation adjustment. 'Capitation Adjustment Types' are configured within 'Capitation Configuration'.


 
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-adjustments/{capitationAdjustmentKey}
Request samples 
{
  • "capitationAdjustment_Key": 0,
  • "account_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "age": 0,
  • "capitationPlanRate_Key": 0,
  • "capitationTransaction_Key": 0,
  • "capitation_Adjustment_Reason": "string",
  • "capitation_Adjustment_Type": "string",
  • "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 CapitationAdjustment
Deletes an CapitationAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationAdjustmentKey
required
integer <int32> 
CapitationAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-adjustments/{capitationAdjustmentKey}
Request samples 
Create or Update Batch CapitationAdjustment
Create or Update multiple CapitationAdjustment at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
Request Body schema: 
required
 Array 
capitationAdjustment_Key
required
integer <int32> 
ID of the capitation adjustment. 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.


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


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


 
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_Adjustment_Reason
string or null  <= 8 characters 
Reason of the capitation adjustment. 'Capitation Adjustment Reasons' are configured within 'Capitation Configuration'.


 
capitation_Adjustment_Type
string or null  <= 8 characters 
Type of the capitation adjustment. 'Capitation Adjustment Types' are configured within 'Capitation Configuration'.


 
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-adjustments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}