Care Plan Rule Criterias

Create CarePlanRuleCriteria

Creates a new CarePlanRuleCriteria

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

CarePlan Key

carePlanRuleKey
required
integer <int32>

CarePlanRule Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlanRuleCriteria_Key
required
integer <int32>
carePlanRule_Key
required
integer <int32>
criteria_CarePlanDetail_Key
integer or null <int32>
criteria_From_Date
string or null <date-time>
criteria_From_Decimal
number or null <double>
criteria_From_Number
integer or null <int32>
criteria_From_String
string or null <= 256 characters
criteria_Operator
string or null <= 32 characters
criteria_Thru_Date
string or null <date-time>
criteria_Thru_Decimal
number or null <double>
criteria_Thru_Number
integer or null <int32>
criteria_Thru_String
string or null <= 256 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
question_CarePlanDetail_Key
required
integer <int32>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias
Request samples
{
  • "carePlanRuleCriteria_Key": 0,
  • "carePlanRule_Key": 0,
  • "criteria_CarePlanDetail_Key": 0,
  • "criteria_From_Date": "2019-08-24T14:15:22Z",
  • "criteria_From_Decimal": 0.1,
  • "criteria_From_Number": 0,
  • "criteria_From_String": "string",
  • "criteria_Operator": "string",
  • "criteria_Thru_Date": "2019-08-24T14:15:22Z",
  • "criteria_Thru_Decimal": 0.1,
  • "criteria_Thru_Number": 0,
  • "criteria_Thru_String": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "question_CarePlanDetail_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CarePlanRuleCriteria

Lists all CarePlanRuleCriteria for the given carePlanRuleKey

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

CarePlan Key

carePlanRuleKey
required
integer <int32>

CarePlanRule 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}/rules/{carePlanRuleKey}/criterias
Request samples 
Response samples 
No sample
Get CarePlanRuleCriteria
Gets CarePlanRuleCriteria


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


 
carePlanRuleKey
required
integer <int32> 
CarePlanRule Key


 
carePlanRuleCriteriaKey
required
integer <int32> 
CarePlanRuleCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias/{carePlanRuleCriteriaKey}
Request samples 
Response samples 
No sample
Update CarePlanRuleCriteria
Updates a specific CarePlanRuleCriteria.


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


 
carePlanRuleKey
required
integer <int32> 
CarePlanRule Key


 
carePlanRuleCriteriaKey
required
integer <int32> 
CarePlanRuleCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carePlanRuleCriteria_Key
required
integer <int32> 
 
carePlanRule_Key
required
integer <int32> 
 
criteria_CarePlanDetail_Key
integer or null <int32> 
 
criteria_From_Date
string or null <date-time> 
 
criteria_From_Decimal
number or null <double> 
 
criteria_From_Number
integer or null <int32> 
 
criteria_From_String
string or null  <= 256 characters 
 
criteria_Operator
string or null  <= 32 characters 
 
criteria_Thru_Date
string or null <date-time> 
 
criteria_Thru_Decimal
number or null <double> 
 
criteria_Thru_Number
integer or null <int32> 
 
criteria_Thru_String
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
question_CarePlanDetail_Key
required
integer <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias/{carePlanRuleCriteriaKey}
Request samples 
{
  • "carePlanRuleCriteria_Key": 0,
  • "carePlanRule_Key": 0,
  • "criteria_CarePlanDetail_Key": 0,
  • "criteria_From_Date": "2019-08-24T14:15:22Z",
  • "criteria_From_Decimal": 0.1,
  • "criteria_From_Number": 0,
  • "criteria_From_String": "string",
  • "criteria_Operator": "string",
  • "criteria_Thru_Date": "2019-08-24T14:15:22Z",
  • "criteria_Thru_Decimal": 0.1,
  • "criteria_Thru_Number": 0,
  • "criteria_Thru_String": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "question_CarePlanDetail_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CarePlanRuleCriteria
Deletes an CarePlanRuleCriteria


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


 
carePlanRuleKey
required
integer <int32> 
CarePlanRule Key


 
carePlanRuleCriteriaKey
required
integer <int32> 
CarePlanRuleCriteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/rules/{carePlanRuleKey}/criterias/{carePlanRuleCriteriaKey}
Request samples 
Create or Update Batch CarePlanRuleCriteria
Create or Update multiple CarePlanRuleCriteria 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


 
carePlanRuleKey
required
integer <int32> 
CarePlanRule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
carePlanRuleCriteria_Key
required
integer <int32> 
 
carePlanRule_Key
required
integer <int32> 
 
criteria_CarePlanDetail_Key
integer or null <int32> 
 
criteria_From_Date
string or null <date-time> 
 
criteria_From_Decimal
number or null <double> 
 
criteria_From_Number
integer or null <int32> 
 
criteria_From_String
string or null  <= 256 characters 
 
criteria_Operator
string or null  <= 32 characters 
 
criteria_Thru_Date
string or null <date-time> 
 
criteria_Thru_Decimal
number or null <double> 
 
criteria_Thru_Number
integer or null <int32> 
 
criteria_Thru_String
string or null  <= 256 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
question_CarePlanDetail_Key
required
integer <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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