Care Case Medications

Create CareCaseMedication

Creates a new CareCaseMedication

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseMedication_Key
required
integer <int32>
case_Key
required
integer <int32>
dosage
number or null <double>
dosage_Unit
string or null <= 32 characters
drug_Code
string or null <= 20 characters
drug_Information
string or null <= 1024 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
med_Reconciliation_Date
string or null <date-time>
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/cases/{caseKey}/medications
Request samples
{
  • "careCaseMedication_Key": 0,
  • "case_Key": 0,
  • "dosage": 0.1,
  • "dosage_Unit": "string",
  • "drug_Code": "string",
  • "drug_Information": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "med_Reconciliation_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseMedication

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


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


 
careCaseMedicationKey
required
integer <int32> 
CareCaseMedication Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/medications/{careCaseMedicationKey}
Request samples 
Response samples 
No sample
Update CareCaseMedication
Updates a specific CareCaseMedication.


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


 
careCaseMedicationKey
required
integer <int32> 
CareCaseMedication Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseMedication_Key
required
integer <int32> 
 
case_Key
required
integer <int32> 
 
dosage
number or null <double> 
 
dosage_Unit
string or null  <= 32 characters 
 
drug_Code
string or null  <= 20 characters 
 
drug_Information
string or null  <= 1024 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
med_Reconciliation_Date
string or null <date-time> 
 
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/cases/{caseKey}/medications/{careCaseMedicationKey}
Request samples 
{
  • "careCaseMedication_Key": 0,
  • "case_Key": 0,
  • "dosage": 0.1,
  • "dosage_Unit": "string",
  • "drug_Code": "string",
  • "drug_Information": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "med_Reconciliation_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseMedication
Deletes an CareCaseMedication


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


 
careCaseMedicationKey
required
integer <int32> 
CareCaseMedication Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/medications/{careCaseMedicationKey}
Request samples 
Create or Update Batch CareCaseMedication
Create or Update multiple CareCaseMedication 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 
careCaseMedication_Key
required
integer <int32> 
 
case_Key
required
integer <int32> 
 
dosage
number or null <double> 
 
dosage_Unit
string or null  <= 32 characters 
 
drug_Code
string or null  <= 20 characters 
 
drug_Information
string or null  <= 1024 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
med_Reconciliation_Date
string or null <date-time> 
 
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/cases/{caseKey}/medications-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}