Capitation Services

Create CapitationService

Creates a new CapitationService

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitationService_Key
required
integer <int32>

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

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Identifies the ICD version associated with the listed diagnostic codes. 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 capitation service becomes/became effective.

end_Date
string or null <date-time>

Date when the capitation service 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

from_Diag_Code
string or null <= 8 characters

Starting code for the range of acceptable diagnostic codes for the capitation service.

from_Procedure
string or null <= 8 characters

Starting code for the range of acceptable procedure codes for the capitation service.

network_ID
string or null <= 10 characters

ID of the network associated with the capitation service.

place_Of_Service
string or null <= 5 characters

Place of service associated with the capitation service.

require_PCP
required
boolean

When this flag is set, the list of TINS must match the PCP for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

specialty_Code
string or null <= 10 characters

Specialty code of the Provider associated with the capitation service.

thru_Diag_Code
string or null <= 8 characters

Ending code for the range of acceptable diagnostic codes for the capitation service.

thru_Procedure
string or null <= 8 characters

Ending code for the range of acceptable procedure codes for the network.

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-services
Request samples
{
  • "capitationService_Key": 0,
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Diag_Code": "string",
  • "from_Procedure": "string",
  • "network_ID": "string",
  • "place_Of_Service": "strin",
  • "require_PCP": true,
  • "specialty_Code": "string",
  • "thru_Diag_Code": "string",
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CapitationService

Lists all CapitationService

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/capitation-services
Request samples 
Response samples 
No sample
Get CapitationService
Gets CapitationService


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/capitation-services/{capitationServiceKey}
Request samples 
Response samples 
No sample
Update CapitationService
Updates a specific CapitationService.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Identifies the ICD version associated with the listed diagnostic codes. 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 capitation service becomes/became effective.


 
end_Date
string or null <date-time> 
Date when the capitation service 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


 
from_Diag_Code
string or null  <= 8 characters 
Starting code for the range of acceptable diagnostic codes for the capitation service.


 
from_Procedure
string or null  <= 8 characters 
Starting code for the range of acceptable procedure codes for the capitation service.


 
network_ID
string or null  <= 10 characters 
ID of the network associated with the capitation service.


 
place_Of_Service
string or null  <= 5 characters 
Place of service associated with the capitation service.


 
require_PCP
required
boolean
When this flag is set, the list of TINS must match the PCP for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specialty_Code
string or null  <= 10 characters 
Specialty code of the Provider associated with the capitation service.


 
thru_Diag_Code
string or null  <= 8 characters 
Ending code for the range of acceptable diagnostic codes for the capitation service.


 
thru_Procedure
string or null  <= 8 characters 
Ending code for the range of acceptable procedure codes for the network.


 
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-services/{capitationServiceKey}
Request samples 
{
  • "capitationService_Key": 0,
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Diag_Code": "string",
  • "from_Procedure": "string",
  • "network_ID": "string",
  • "place_Of_Service": "strin",
  • "require_PCP": true,
  • "specialty_Code": "string",
  • "thru_Diag_Code": "string",
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CapitationService
Deletes an CapitationService


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationServiceKey
required
integer <int32> 
CapitationService Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-services/{capitationServiceKey}
Request samples 
Create or Update Batch CapitationService
Create or Update multiple CapitationService 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 
capitationService_Key
required
integer <int32> 
ID of the capitation service. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Identifies the ICD version associated with the listed diagnostic codes. 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 capitation service becomes/became effective.


 
end_Date
string or null <date-time> 
Date when the capitation service 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


 
from_Diag_Code
string or null  <= 8 characters 
Starting code for the range of acceptable diagnostic codes for the capitation service.


 
from_Procedure
string or null  <= 8 characters 
Starting code for the range of acceptable procedure codes for the capitation service.


 
network_ID
string or null  <= 10 characters 
ID of the network associated with the capitation service.


 
place_Of_Service
string or null  <= 5 characters 
Place of service associated with the capitation service.


 
require_PCP
required
boolean
When this flag is set, the list of TINS must match the PCP for this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specialty_Code
string or null  <= 10 characters 
Specialty code of the Provider associated with the capitation service.


 
thru_Diag_Code
string or null  <= 8 characters 
Ending code for the range of acceptable diagnostic codes for the capitation service.


 
thru_Procedure
string or null  <= 8 characters 
Ending code for the range of acceptable procedure codes for the network.


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