Care Case Diagnoses

Create CareCaseDiagnosis

Creates a new CareCaseDiagnosis

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

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseDiagnosis_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
diag_Stage
integer or null <int32>
diagnostic_Code
string or null <= 8 characters
diagnostic_Group
string or null <= 32 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/cases/{caseKey}/diagnoses
Request samples
{
  • "careCaseDiagnosis_Key": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "diag_Stage": 0,
  • "diagnostic_Code": "string",
  • "diagnostic_Group": "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 CareCaseDiagnosis

Lists all CareCaseDiagnosis 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}/diagnoses
Request samples
Response samples
No sample

Get CareCaseDiagnosis

Gets CareCaseDiagnosis

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

Case Key

careCaseDiagnosisKey
required
integer <int32>

CareCaseDiagnosis Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/cases/{caseKey}/diagnoses/{careCaseDiagnosisKey}
Request samples
Response samples
No sample

Update CareCaseDiagnosis

Updates a specific CareCaseDiagnosis.

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

Case Key

careCaseDiagnosisKey
required
integer <int32>

CareCaseDiagnosis Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseDiagnosis_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
diag_Stage
integer or null <int32>
diagnostic_Code
string or null <= 8 characters
diagnostic_Group
string or null <= 32 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/cases/{caseKey}/diagnoses/{careCaseDiagnosisKey}
Request samples
{
  • "careCaseDiagnosis_Key": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "diag_Stage": 0,
  • "diagnostic_Code": "string",
  • "diagnostic_Group": "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 CareCaseDiagnosis

Deletes an CareCaseDiagnosis

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

Case Key

careCaseDiagnosisKey
required
integer <int32>

CareCaseDiagnosis Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/cases/{caseKey}/diagnoses/{careCaseDiagnosisKey}
Request samples

Create or Update Batch CareCaseDiagnosis

Create or Update multiple CareCaseDiagnosis 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
careCaseDiagnosis_Key
required
integer <int32>
case_Key
required
integer <int32>
comment
string or null
diag_Stage
integer or null <int32>
diagnostic_Code
string or null <= 8 characters
diagnostic_Group
string or null <= 32 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/cases/{caseKey}/diagnoses-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}