Care Plan Scores

Create CarePlanScore

Creates a new CarePlanScore

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

CarePlan Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carePlanScore_Key
required
integer <int32>
carePlanScore_Seq
required
integer <int32>
carePlan_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
from_Score
number or null <double>
score_Description
string or null <= 512 characters
score_Operator
string or null <= 32 characters
thru_Score
number or null <double>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/care-plans/{carePlanKey}/scores
Request samples
{
  • "carePlanScore_Key": 0,
  • "carePlanScore_Seq": 0,
  • "carePlan_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Score": 0.1,
  • "score_Description": "string",
  • "score_Operator": "string",
  • "thru_Score": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CarePlanScore

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


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


 
carePlanScoreKey
required
integer <int32> 
CarePlanScore Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-plans/{carePlanKey}/scores/{carePlanScoreKey}
Request samples 
Response samples 
No sample
Update CarePlanScore
Updates a specific CarePlanScore.


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


 
carePlanScoreKey
required
integer <int32> 
CarePlanScore Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carePlanScore_Key
required
integer <int32> 
 
carePlanScore_Seq
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
from_Score
number or null <double> 
 
score_Description
string or null  <= 512 characters 
 
score_Operator
string or null  <= 32 characters 
 
thru_Score
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/care-plans/{carePlanKey}/scores/{carePlanScoreKey}
Request samples 
{
  • "carePlanScore_Key": 0,
  • "carePlanScore_Seq": 0,
  • "carePlan_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Score": 0.1,
  • "score_Description": "string",
  • "score_Operator": "string",
  • "thru_Score": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CarePlanScore
Deletes an CarePlanScore


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


 
carePlanScoreKey
required
integer <int32> 
CarePlanScore Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-plans/{carePlanKey}/scores/{carePlanScoreKey}
Request samples 
Create or Update Batch CarePlanScore
Create or Update multiple CarePlanScore 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 
carePlanScore_Key
required
integer <int32> 
 
carePlanScore_Seq
required
integer <int32> 
 
carePlan_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
from_Score
number or null <double> 
 
score_Description
string or null  <= 512 characters 
 
score_Operator
string or null  <= 32 characters 
 
thru_Score
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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