Care Plan Details

Create CarePlanDetail

Creates a new CarePlanDetail

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

CarePlan Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlan_Key
required
integer <int32>
carePlanDetail_Key
required
integer <int32>
carePlanDetail_Parent
required
integer <int32>
carePlanDetail_Seq
required
integer <int32>
carePlan_Category
string or null <= 32 characters
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_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>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-plans/{carePlanKey}/details
Request samples
{
  • "carePlan_Key": 0,
  • "carePlanDetail_Key": 0,
  • "carePlanDetail_Parent": 0,
  • "carePlanDetail_Seq": 0,
  • "carePlan_Category": "string",
  • "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_Result_Type": "string",
  • "item_Score": 0.1,
  • "item_Type": "string",
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CarePlanDetail

Lists all CarePlanDetail 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}/details
Request samples 
Response samples 
No sample
Get CarePlanDetail
Gets CarePlanDetail


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


 
carePlanDetailKey
required
integer <int32> 
CarePlanDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}/details/{carePlanDetailKey}
Request samples 
Response samples 
No sample
Update CarePlanDetail
Updates a specific CarePlanDetail.


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


 
carePlanDetailKey
required
integer <int32> 
CarePlanDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carePlan_Key
required
integer <int32> 
 
carePlanDetail_Key
required
integer <int32> 
 
carePlanDetail_Parent
required
integer <int32> 
 
carePlanDetail_Seq
required
integer <int32> 
 
carePlan_Category
string or null  <= 32 characters 
 
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_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> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/care-plans/{carePlanKey}/details/{carePlanDetailKey}
Request samples 
{
  • "carePlan_Key": 0,
  • "carePlanDetail_Key": 0,
  • "carePlanDetail_Parent": 0,
  • "carePlanDetail_Seq": 0,
  • "carePlan_Category": "string",
  • "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_Result_Type": "string",
  • "item_Score": 0.1,
  • "item_Type": "string",
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CarePlanDetail
Deletes an CarePlanDetail


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


 
carePlanDetailKey
required
integer <int32> 
CarePlanDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/details/{carePlanDetailKey}
Request samples 
Create or Update Batch CarePlanDetail
Create or Update multiple CarePlanDetail 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 
carePlan_Key
required
integer <int32> 
 
carePlanDetail_Key
required
integer <int32> 
 
carePlanDetail_Parent
required
integer <int32> 
 
carePlanDetail_Seq
required
integer <int32> 
 
carePlan_Category
string or null  <= 32 characters 
 
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_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> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/care-plans/{carePlanKey}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}