Care Case Treatments

Create CareCaseTreatment

Creates a new CareCaseTreatment

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseTreatment_Key
required
integer <int32>
careCaseConcordance_Key
integer or null <int32>
careCaseEmeticRisk_Key
integer or null <int32>
careCaseIntent_Key
integer or null <int32>
careCaseLot_Key
integer or null <int32>
careCaseNeutropenicRisk_Key
integer or null <int32>
case_Key
required
integer <int32>
comments
string or null
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>
treatment_Type
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/treatments
Request samples
{
  • "careCaseTreatment_Key": 0,
  • "careCaseConcordance_Key": 0,
  • "careCaseEmeticRisk_Key": 0,
  • "careCaseIntent_Key": 0,
  • "careCaseLot_Key": 0,
  • "careCaseNeutropenicRisk_Key": 0,
  • "case_Key": 0,
  • "comments": "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",
  • "treatment_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseTreatment

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


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


 
careCaseTreatmentKey
required
integer <int32> 
CareCaseTreatment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/treatments/{careCaseTreatmentKey}
Request samples 
Response samples 
No sample
Update CareCaseTreatment
Updates a specific CareCaseTreatment.


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


 
careCaseTreatmentKey
required
integer <int32> 
CareCaseTreatment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseTreatment_Key
required
integer <int32> 
 
careCaseConcordance_Key
integer or null <int32> 
 
careCaseEmeticRisk_Key
integer or null <int32> 
 
careCaseIntent_Key
integer or null <int32> 
 
careCaseLot_Key
integer or null <int32> 
 
careCaseNeutropenicRisk_Key
integer or null <int32> 
 
case_Key
required
integer <int32> 
 
comments
string or null
 
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> 
 
treatment_Type
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/treatments/{careCaseTreatmentKey}
Request samples 
{
  • "careCaseTreatment_Key": 0,
  • "careCaseConcordance_Key": 0,
  • "careCaseEmeticRisk_Key": 0,
  • "careCaseIntent_Key": 0,
  • "careCaseLot_Key": 0,
  • "careCaseNeutropenicRisk_Key": 0,
  • "case_Key": 0,
  • "comments": "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",
  • "treatment_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseTreatment
Deletes an CareCaseTreatment


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


 
careCaseTreatmentKey
required
integer <int32> 
CareCaseTreatment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/treatments/{careCaseTreatmentKey}
Request samples 
Create or Update Batch CareCaseTreatment
Create or Update multiple CareCaseTreatment 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 
careCaseTreatment_Key
required
integer <int32> 
 
careCaseConcordance_Key
integer or null <int32> 
 
careCaseEmeticRisk_Key
integer or null <int32> 
 
careCaseIntent_Key
integer or null <int32> 
 
careCaseLot_Key
integer or null <int32> 
 
careCaseNeutropenicRisk_Key
integer or null <int32> 
 
case_Key
required
integer <int32> 
 
comments
string or null
 
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> 
 
treatment_Type
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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