Capitation Plan Rates

Create CapitationPlanRate

Creates a new CapitationPlanRate

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitationPlanRate_Key
required
integer <int32>

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

adult
required
boolean

Indicates that the Member associated with the capitation must be an adult in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

Beginning age for the required age range for the plan rate to apply to a capitation.

age_Thru
integer or null <int32>

Ending age for the required age range for the plan rate to apply to a capitation.

capitation_Category
string or null <= 8 characters

Indicates the category required for the plan rate to apply to a capitation.

capitation_Type
string or null <= 8 characters

Indicates the type required for the plan rate to apply to a capitation.

child
required
boolean

Indicates that the Member associated with the capitation must be an child in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the plan rate becomes/became effective.

end_Date
string or null <date-time>

Date when the plan rate expires/expired.

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

plan_ID
string or null <= 20 characters

ID of the plan associated with the plan rate.

rate
number or null <double>

Indicates the rate that will be applied by the plan rate.

sex
string or null <= 1 characters

Indicates the sex required for the plan rate to apply to a capitation.

tier
string or null <= 2 characters

Indicates the tier required for the plan rate to apply to a capiation.

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-plan-rates
Request samples
{
  • "capitationPlanRate_Key": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "capitation_Category": "string",
  • "capitation_Type": "string",
  • "child": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "rate": 0.1,
  • "sex": "s",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CapitationPlanRate

Lists all CapitationPlanRate. Supply optinal query parameter planID to filter by a specific plan.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
planID
string

Plan ID

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-plan-rates
Request samples 
Response samples 
No sample
Get CapitationPlanRate
Gets CapitationPlanRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationPlanRateKey
required
integer <int32> 
CapitationPlanRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/capitation-plan-rates/{capitationPlanRateKey}
Request samples 
Response samples 
No sample
Update CapitationPlanRate
Updates a specific CapitationPlanRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationPlanRateKey
required
integer <int32> 
CapitationPlanRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
adult
required
boolean
Indicates that the Member associated with the capitation must be an adult in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Beginning age for the required age range for the plan rate to apply to a capitation.


 
age_Thru
integer or null <int32> 
Ending age for the required age range for the plan rate to apply to a capitation.


 
capitation_Category
string or null  <= 8 characters 
Indicates the category required for the plan rate to apply to a capitation.


 
capitation_Type
string or null  <= 8 characters 
Indicates the type required for the plan rate to apply to a capitation.


 
child
required
boolean
Indicates that the Member associated with the capitation must be an child in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the plan rate becomes/became effective.


 
end_Date
string or null <date-time> 
Date when the plan rate expires/expired.


 
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


 
plan_ID
string or null  <= 20 characters 
ID of the plan associated with the plan rate.


 
rate
number or null <double> 
Indicates the rate that will be applied by the plan rate.


 
sex
string or null  <= 1 characters 
Indicates the sex required for the plan rate to apply to a capitation.


 
tier
string or null  <= 2 characters 
Indicates the tier required for the plan rate to apply to a capiation.


 
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-plan-rates/{capitationPlanRateKey}
Request samples 
{
  • "capitationPlanRate_Key": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "capitation_Category": "string",
  • "capitation_Type": "string",
  • "child": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "plan_ID": "string",
  • "rate": 0.1,
  • "sex": "s",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CapitationPlanRate
Deletes an CapitationPlanRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationPlanRateKey
required
integer <int32> 
CapitationPlanRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-plan-rates/{capitationPlanRateKey}
Request samples 
Create or Update Batch CapitationPlanRate
Create or Update multiple CapitationPlanRate 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 
capitationPlanRate_Key
required
integer <int32> 
ID of the capitation plan rate. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult
required
boolean
Indicates that the Member associated with the capitation must be an adult in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Beginning age for the required age range for the plan rate to apply to a capitation.


 
age_Thru
integer or null <int32> 
Ending age for the required age range for the plan rate to apply to a capitation.


 
capitation_Category
string or null  <= 8 characters 
Indicates the category required for the plan rate to apply to a capitation.


 
capitation_Type
string or null  <= 8 characters 
Indicates the type required for the plan rate to apply to a capitation.


 
child
required
boolean
Indicates that the Member associated with the capitation must be an child in order for the plan rate to apply to a capitation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the plan rate becomes/became effective.


 
end_Date
string or null <date-time> 
Date when the plan rate expires/expired.


 
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


 
plan_ID
string or null  <= 20 characters 
ID of the plan associated with the plan rate.


 
rate
number or null <double> 
Indicates the rate that will be applied by the plan rate.


 
sex
string or null  <= 1 characters 
Indicates the sex required for the plan rate to apply to a capitation.


 
tier
string or null  <= 2 characters 
Indicates the tier required for the plan rate to apply to a capiation.


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