Care Cases

Create CareCase

Creates a new CareCase

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

CarePlan Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
case_Key
required
integer <int32>

Identifier of the case.

appointment_Date
string or null <date-time>

User Managed field: Date of next Appointment

assessment_Date
string or null <date-time>

User managed field: Date when the case was assessed.

carePlan_Key
required
integer <int32>

Identifies the type care associated with the case.

case_Assign_Type
string or null <= 16 characters

Who or what Entity the Case was assigned to.

case_End_Date
string or null <date-time>

Day when the case ended.

case_ID
string or null <= 64 characters

Identifier of the case.

case_Priority
integer or null <int32>

Identifies the priority of the case. 'Case Priorities' are configured within 'Care Management Configuration'.

case_Reason
string or null <= 32 characters

Identifies the reason of the case. 'Case Reasons' are configured within 'Care Management Configuration'.

case_Score
number or null <double>

User Managed field used when Auto Assigning cases.

case_Start_Date
string or null <date-time>

Day when the case began.

case_Status
string or null <= 8 characters

Identifies the status of the case. 'Case Statuses' are configured within 'Care Management Configuration'.

division_ID
string or null <= 20 characters

ID of the Division associated with the case.

do_Not_Contact
required
boolean

User Managed field for whether or not to contact member.

eligibility_Verified
string or null <date-time>

User Managed field: Date elegibility verified

eligibility_Verified_Comment
string or null <= 512 characters

User Managed field: Comment about Eligibility verification.

case_Close_Reason
string or null <= 32 characters

The identifier of the case close reason.

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 associated with the case.

member_Seq
string or null <= 2 characters

Sequential identifier of the Member associated with the case.

provider_ID
string or null <= 20 characters

ID of the Provider associated with the case.

subscriber_ID
string or null <= 9 characters

ID of the Subscriber associated with the case.

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/care-plans/{carePlanKey}/cases
Request samples
{
  • "case_Key": 0,
  • "appointment_Date": "2019-08-24T14:15:22Z",
  • "assessment_Date": "2019-08-24T14:15:22Z",
  • "carePlan_Key": 0,
  • "case_Assign_Type": "string",
  • "case_End_Date": "2019-08-24T14:15:22Z",
  • "case_ID": "string",
  • "case_Priority": 0,
  • "case_Reason": "string",
  • "case_Score": 0.1,
  • "case_Start_Date": "2019-08-24T14:15:22Z",
  • "case_Status": "string",
  • "division_ID": "string",
  • "do_Not_Contact": true,
  • "eligibility_Verified": "2019-08-24T14:15:22Z",
  • "eligibility_Verified_Comment": "string",
  • "case_Close_Reason": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCase

Lists all CareCase for the given carePlanKey

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

CarePlan 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/care-plans/{carePlanKey}/cases
Request samples 
Response samples 
No sample
Get CareCase
Gets CareCase


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}/cases/{caseKey}
Request samples 
Response samples 
No sample
Update CareCase
Updates a specific CareCase.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
case_Key
required
integer <int32> 
Identifier of the case.


 
appointment_Date
string or null <date-time> 
User Managed field: Date of next Appointment


 
assessment_Date
string or null <date-time> 
User managed field: Date when the case was assessed.


 
carePlan_Key
required
integer <int32> 
Identifies the type care associated with the case.


 
case_Assign_Type
string or null  <= 16 characters 
Who or what Entity the Case was assigned to.


 
case_End_Date
string or null <date-time> 
Day when the case ended.


 
case_ID
string or null  <= 64 characters 
Identifier of the case.


 
case_Priority
integer or null <int32> 
Identifies the priority of the case. 'Case Priorities' are configured within 'Care Management Configuration'.


 
case_Reason
string or null  <= 32 characters 
Identifies the reason of the case. 'Case Reasons' are configured within 'Care Management Configuration'.


 
case_Score
number or null <double> 
User Managed field used when Auto Assigning cases.


 
case_Start_Date
string or null <date-time> 
Day when the case began.


 
case_Status
string or null  <= 8 characters 
Identifies the status of the case. 'Case Statuses' are configured within 'Care Management Configuration'.


 
division_ID
string or null  <= 20 characters 
ID of the Division associated with the case.


 
do_Not_Contact
required
boolean
User Managed field for whether or not to contact member.


 
eligibility_Verified
string or null <date-time> 
User Managed field: Date elegibility verified


 
eligibility_Verified_Comment
string or null  <= 512 characters 
User Managed field: Comment about Eligibility verification.


 
case_Close_Reason
string or null  <= 32 characters 
The identifier of the case close reason.


 
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 associated with the case.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier of the Member associated with the case.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the case.


 
subscriber_ID
string or null  <= 9 characters 
ID of the Subscriber associated with the case.


 
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/care-plans/{carePlanKey}/cases/{caseKey}
Request samples 
{
  • "case_Key": 0,
  • "appointment_Date": "2019-08-24T14:15:22Z",
  • "assessment_Date": "2019-08-24T14:15:22Z",
  • "carePlan_Key": 0,
  • "case_Assign_Type": "string",
  • "case_End_Date": "2019-08-24T14:15:22Z",
  • "case_ID": "string",
  • "case_Priority": 0,
  • "case_Reason": "string",
  • "case_Score": 0.1,
  • "case_Start_Date": "2019-08-24T14:15:22Z",
  • "case_Status": "string",
  • "division_ID": "string",
  • "do_Not_Contact": true,
  • "eligibility_Verified": "2019-08-24T14:15:22Z",
  • "eligibility_Verified_Comment": "string",
  • "case_Close_Reason": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "member_Seq": "st",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCase
Deletes an CareCase


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carePlanKey
required
integer <int32> 
CarePlan Key


 
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/cases/{caseKey}
Request samples 
Create or Update Batch CareCase
Create or Update multiple CareCase 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
carePlanKey
required
integer <int32> 
CarePlan Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
case_Key
required
integer <int32> 
Identifier of the case.


 
appointment_Date
string or null <date-time> 
User Managed field: Date of next Appointment


 
assessment_Date
string or null <date-time> 
User managed field: Date when the case was assessed.


 
carePlan_Key
required
integer <int32> 
Identifies the type care associated with the case.


 
case_Assign_Type
string or null  <= 16 characters 
Who or what Entity the Case was assigned to.


 
case_End_Date
string or null <date-time> 
Day when the case ended.


 
case_ID
string or null  <= 64 characters 
Identifier of the case.


 
case_Priority
integer or null <int32> 
Identifies the priority of the case. 'Case Priorities' are configured within 'Care Management Configuration'.


 
case_Reason
string or null  <= 32 characters 
Identifies the reason of the case. 'Case Reasons' are configured within 'Care Management Configuration'.


 
case_Score
number or null <double> 
User Managed field used when Auto Assigning cases.


 
case_Start_Date
string or null <date-time> 
Day when the case began.


 
case_Status
string or null  <= 8 characters 
Identifies the status of the case. 'Case Statuses' are configured within 'Care Management Configuration'.


 
division_ID
string or null  <= 20 characters 
ID of the Division associated with the case.


 
do_Not_Contact
required
boolean
User Managed field for whether or not to contact member.


 
eligibility_Verified
string or null <date-time> 
User Managed field: Date elegibility verified


 
eligibility_Verified_Comment
string or null  <= 512 characters 
User Managed field: Comment about Eligibility verification.


 
case_Close_Reason
string or null  <= 32 characters 
The identifier of the case close reason.


 
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 associated with the case.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier of the Member associated with the case.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the case.


 
subscriber_ID
string or null  <= 9 characters 
ID of the Subscriber associated with the case.


 
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/care-plans/{carePlanKey}/cases-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}