Care Plan Rules

Create CarePlanRule

Creates a new CarePlanRule

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

CarePlan Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlanRule_Key
required
integer <int32>
carePlan_Key
required
integer <int32>
description
string or null <= 512 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-plans/{carePlanKey}/rules
Request samples
{
  • "carePlanRule_Key": 0,
  • "carePlan_Key": 0,
  • "description": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CarePlanRule

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


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


 
Responses 
200
Success


401
Unauthorized


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


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
carePlanRule_Key
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
description
string or null  <= 512 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/care-plans/{carePlanKey}/rules/{carePlanRuleKey}
Request samples 
{
  • "carePlanRule_Key": 0,
  • "carePlan_Key": 0,
  • "description": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CarePlanRule
Deletes an CarePlanRule


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


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/rules/{carePlanRuleKey}
Request samples 
Create or Update Batch CarePlanRule
Create or Update multiple CarePlanRule 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 
carePlanRule_Key
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
description
string or null  <= 512 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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