Care Case Details

Create CareCaseDetail

Creates a new CareCaseDetail

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
case_Key
required
integer <int32>
caseDetail_Key
required
integer <int32>
carePlan_Category
string or null <= 32 characters
caseDetail_Parent
required
integer <int32>
caseDetail_Seq
required
integer <int32>
email_Body
string or null
email_Recipient
string or null <= 512 characters
email_Subject
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
event_Subject
string or null <= 256 characters
item_Definition
string or null <= 512 characters
item_Metadata
string or null <= 1024 characters
item_Result_Type
string or null <= 32 characters
item_Score
number or null <double>
item_Type
string or null <= 32 characters
reportDefinition_Key
integer or null <int32>
reportSeries_Key
integer or null <int32>
result_Date
string or null <date-time>
result_Decimal
number or null <double>
result_Number
integer or null <int32>
result_Score
number or null <double>
result_Selected
required
boolean
result_String
string or null <= 4000 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/details
Request samples
{
  • "case_Key": 0,
  • "caseDetail_Key": 0,
  • "carePlan_Category": "string",
  • "caseDetail_Parent": 0,
  • "caseDetail_Seq": 0,
  • "email_Body": "string",
  • "email_Recipient": "string",
  • "email_Subject": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Subject": "string",
  • "item_Definition": "string",
  • "item_Metadata": "string",
  • "item_Result_Type": "string",
  • "item_Score": 0.1,
  • "item_Type": "string",
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "result_Date": "2019-08-24T14:15:22Z",
  • "result_Decimal": 0.1,
  • "result_Number": 0,
  • "result_Score": 0.1,
  • "result_Selected": true,
  • "result_String": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseDetail

Lists all CareCaseDetail for the given caseKey

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

Case 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/cases/{caseKey}/details
Request samples 
Response samples 
No sample
Get CareCaseDetail
Gets CareCaseDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
caseDetailKey
required
integer <int32> 
CaseDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/details/{caseDetailKey}
Request samples 
Response samples 
No sample
Update CareCaseDetail
Updates a specific CareCaseDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
caseDetailKey
required
integer <int32> 
CaseDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
case_Key
required
integer <int32> 
 
caseDetail_Key
required
integer <int32> 
 
carePlan_Category
string or null  <= 32 characters 
 
caseDetail_Parent
required
integer <int32> 
 
caseDetail_Seq
required
integer <int32> 
 
email_Body
string or null
 
email_Recipient
string or null  <= 512 characters 
 
email_Subject
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
event_Subject
string or null  <= 256 characters 
 
item_Definition
string or null  <= 512 characters 
 
item_Metadata
string or null  <= 1024 characters 
 
item_Result_Type
string or null  <= 32 characters 
 
item_Score
number or null <double> 
 
item_Type
string or null  <= 32 characters 
 
reportDefinition_Key
integer or null <int32> 
 
reportSeries_Key
integer or null <int32> 
 
result_Date
string or null <date-time> 
 
result_Decimal
number or null <double> 
 
result_Number
integer or null <int32> 
 
result_Score
number or null <double> 
 
result_Selected
required
boolean
 
result_String
string or null  <= 4000 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/details/{caseDetailKey}
Request samples 
{
  • "case_Key": 0,
  • "caseDetail_Key": 0,
  • "carePlan_Category": "string",
  • "caseDetail_Parent": 0,
  • "caseDetail_Seq": 0,
  • "email_Body": "string",
  • "email_Recipient": "string",
  • "email_Subject": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Subject": "string",
  • "item_Definition": "string",
  • "item_Metadata": "string",
  • "item_Result_Type": "string",
  • "item_Score": 0.1,
  • "item_Type": "string",
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "result_Date": "2019-08-24T14:15:22Z",
  • "result_Decimal": 0.1,
  • "result_Number": 0,
  • "result_Score": 0.1,
  • "result_Selected": true,
  • "result_String": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseDetail
Deletes an CareCaseDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
caseDetailKey
required
integer <int32> 
CaseDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/details/{caseDetailKey}
Request samples 
Create or Update Batch CareCaseDetail
Create or Update multiple CareCaseDetail 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
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
case_Key
required
integer <int32> 
 
caseDetail_Key
required
integer <int32> 
 
carePlan_Category
string or null  <= 32 characters 
 
caseDetail_Parent
required
integer <int32> 
 
caseDetail_Seq
required
integer <int32> 
 
email_Body
string or null
 
email_Recipient
string or null  <= 512 characters 
 
email_Subject
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
event_Subject
string or null  <= 256 characters 
 
item_Definition
string or null  <= 512 characters 
 
item_Metadata
string or null  <= 1024 characters 
 
item_Result_Type
string or null  <= 32 characters 
 
item_Score
number or null <double> 
 
item_Type
string or null  <= 32 characters 
 
reportDefinition_Key
integer or null <int32> 
 
reportSeries_Key
integer or null <int32> 
 
result_Date
string or null <date-time> 
 
result_Decimal
number or null <double> 
 
result_Number
integer or null <int32> 
 
result_Score
number or null <double> 
 
result_Selected
required
boolean
 
result_String
string or null  <= 4000 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/cases/{caseKey}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}