Care Case Clinical Facts

Create CareCaseClinicalFact

Creates a new CareCaseClinicalFact

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
careCaseClinicalFactCategory
required
string

CareCaseClinicalFactCategory

careCaseClinicalFactCategoryType
required
string

CareCaseClinicalFactCategoryType

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseClinicalFact_Key
required
integer <int32>

Identifier for the CareCaseClinicalFact

careCaseClinicalFactCategory
string or null <= 256 characters

User Managed field that ties to the Clinical Fact in the system

careCaseClinicalFactCategoryType
string or null <= 256 characters

User Managed field that ties to the Clinical Fact Type in the system

case_Key
integer or null <int32>

Identifier of the case.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts
Request samples
{
  • "careCaseClinicalFact_Key": 0,
  • "careCaseClinicalFactCategory": "string",
  • "careCaseClinicalFactCategoryType": "string",
  • "case_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseClinicalFact

Lists all CareCaseClinicalFact for the given careCaseClinicalFactCategory and careCaseClinicalFactCategoryType

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
careCaseClinicalFactCategory
required
string

CareCaseClinicalFactCategory

careCaseClinicalFactCategoryType
required
string

CareCaseClinicalFactCategoryType

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-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts
Request samples 
Response samples 
No sample
Get CareCaseClinicalFact
Gets CareCaseClinicalFact


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
careCaseClinicalFactCategory
required
string
CareCaseClinicalFactCategory


 
careCaseClinicalFactCategoryType
required
string
CareCaseClinicalFactCategoryType


 
careCaseClinicalFactKey
required
integer <int32> 
CareCaseClinicalFact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts/{careCaseClinicalFactKey}
Request samples 
Response samples 
No sample
Update CareCaseClinicalFact
Updates a specific CareCaseClinicalFact.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
careCaseClinicalFactCategory
required
string
CareCaseClinicalFactCategory


 
careCaseClinicalFactCategoryType
required
string
CareCaseClinicalFactCategoryType


 
careCaseClinicalFactKey
required
integer <int32> 
CareCaseClinicalFact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseClinicalFact_Key
required
integer <int32> 
Identifier for the CareCaseClinicalFact


 
careCaseClinicalFactCategory
string or null  <= 256 characters 
User Managed field that ties to the Clinical Fact in the system


 
careCaseClinicalFactCategoryType
string or null  <= 256 characters 
User Managed field that ties to the Clinical Fact Type in the system


 
case_Key
integer or null <int32> 
Identifier of the case.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts/{careCaseClinicalFactKey}
Request samples 
{
  • "careCaseClinicalFact_Key": 0,
  • "careCaseClinicalFactCategory": "string",
  • "careCaseClinicalFactCategoryType": "string",
  • "case_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseClinicalFact
Deletes an CareCaseClinicalFact


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
careCaseClinicalFactCategory
required
string
CareCaseClinicalFactCategory


 
careCaseClinicalFactCategoryType
required
string
CareCaseClinicalFactCategoryType


 
careCaseClinicalFactKey
required
integer <int32> 
CareCaseClinicalFact Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts/{careCaseClinicalFactKey}
Request samples 
Create or Update Batch CareCaseClinicalFact
Create or Update multiple CareCaseClinicalFact 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
careCaseClinicalFactCategory
required
string
CareCaseClinicalFactCategory


 
careCaseClinicalFactCategoryType
required
string
CareCaseClinicalFactCategoryType


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
careCaseClinicalFact_Key
required
integer <int32> 
Identifier for the CareCaseClinicalFact


 
careCaseClinicalFactCategory
string or null  <= 256 characters 
User Managed field that ties to the Clinical Fact in the system


 
careCaseClinicalFactCategoryType
string or null  <= 256 characters 
User Managed field that ties to the Clinical Fact Type in the system


 
case_Key
integer or null <int32> 
Identifier of the case.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/care-case-clinical-fact-categories/{careCaseClinicalFactCategory}/types/{careCaseClinicalFactCategoryType}/facts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}