Diagnostic Codes

Create DiagnosticCode

Creates a new DiagnosticCode

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
diagnostic_Code
required
string [ 1 .. 8 ] characters
diagnostic_Code_Type
required
string [ 1 .. 16 ] characters
effective_Date
required
string <date-time>
accident
required
boolean
age_Range_Type
string or null <= 1 characters
age_Restricted
required
boolean
age_Type
string or null <= 16 characters
drG_Code
string or null <= 8 characters
diag_Description
string or null <= 128 characters
diag_IVR
string or null <= 8 characters
diagnostic_Group
string or null <= 32 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
financial_Type
string or null <= 32 characters
from_Age
integer or null <int32>
gender
string or null <= 1 characters
long_Description
string or null <= 512 characters
pend_Ex_Code
string or null <= 6 characters
pend_Flag
string or null <= 1 characters
pre_Ex
required
boolean
sec111
required
boolean
term_Date
string or null <date-time>
thru_Age
integer or null <int32>
trigger_Diagnosis
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
valid
required
boolean
Responses
200

Success

401

Unauthorized

post/diagnostic-codes
Request samples
{
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "accident": true,
  • "age_Range_Type": "s",
  • "age_Restricted": true,
  • "age_Type": "string",
  • "drG_Code": "string",
  • "diag_Description": "string",
  • "diag_IVR": "string",
  • "diagnostic_Group": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "financial_Type": "string",
  • "from_Age": 0,
  • "gender": "s",
  • "long_Description": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "pre_Ex": true,
  • "sec111": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "thru_Age": 0,
  • "trigger_Diagnosis": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "valid": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DiagnosticCode

Lists all DiagnosticCode

SecurityapiKeyAuth and bearerAuth
Request
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/diagnostic-codes
Request samples 
Response samples 
No sample
Get DiagnosticCode
Gets DiagnosticCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
diagnosticCode
required
string
Diagnostic Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/{effectiveDate}
Request samples 
Response samples 
No sample
Update DiagnosticCode
Updates a specific DiagnosticCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
diagnosticCode
required
string
Diagnostic Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
 
effective_Date
required
string <date-time> 
 
accident
required
boolean
 
age_Range_Type
string or null  <= 1 characters 
 
age_Restricted
required
boolean
 
age_Type
string or null  <= 16 characters 
 
drG_Code
string or null  <= 8 characters 
 
diag_Description
string or null  <= 128 characters 
 
diag_IVR
string or null  <= 8 characters 
 
diagnostic_Group
string or null  <= 32 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
financial_Type
string or null  <= 32 characters 
 
from_Age
integer or null <int32> 
 
gender
string or null  <= 1 characters 
 
long_Description
string or null  <= 512 characters 
 
pend_Ex_Code
string or null  <= 6 characters 
 
pend_Flag
string or null  <= 1 characters 
 
pre_Ex
required
boolean
 
sec111
required
boolean
 
term_Date
string or null <date-time> 
 
thru_Age
integer or null <int32> 
 
trigger_Diagnosis
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
valid
required
boolean
 
Responses 
200
Success


401
Unauthorized


put/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/{effectiveDate}
Request samples 
{
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "accident": true,
  • "age_Range_Type": "s",
  • "age_Restricted": true,
  • "age_Type": "string",
  • "drG_Code": "string",
  • "diag_Description": "string",
  • "diag_IVR": "string",
  • "diagnostic_Group": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "financial_Type": "string",
  • "from_Age": 0,
  • "gender": "s",
  • "long_Description": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "pre_Ex": true,
  • "sec111": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "thru_Age": 0,
  • "trigger_Diagnosis": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "valid": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DiagnosticCode
Deletes an DiagnosticCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
diagnosticCode
required
string
Diagnostic Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/{effectiveDate}
Request samples 
Get The Most Recent DiagnosticCode
Gets The Most Recent DiagnosticCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
diagnosticCode
required
string
Diagnostic Code


 
diagnosticCodeType
required
string
Diagnostic Code Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/diagnostic-codes/{diagnosticCode}/{diagnosticCodeType}/current-diag
Request samples 
Response samples 
No sample
Create or Update Batch DiagnosticCode
Create or Update multiple DiagnosticCode at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
 
effective_Date
required
string <date-time> 
 
accident
required
boolean
 
age_Range_Type
string or null  <= 1 characters 
 
age_Restricted
required
boolean
 
age_Type
string or null  <= 16 characters 
 
drG_Code
string or null  <= 8 characters 
 
diag_Description
string or null  <= 128 characters 
 
diag_IVR
string or null  <= 8 characters 
 
diagnostic_Group
string or null  <= 32 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
financial_Type
string or null  <= 32 characters 
 
from_Age
integer or null <int32> 
 
gender
string or null  <= 1 characters 
 
long_Description
string or null  <= 512 characters 
 
pend_Ex_Code
string or null  <= 6 characters 
 
pend_Flag
string or null  <= 1 characters 
 
pre_Ex
required
boolean
 
sec111
required
boolean
 
term_Date
string or null <date-time> 
 
thru_Age
integer or null <int32> 
 
trigger_Diagnosis
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
valid
required
boolean
 
Responses 
207
Success


401
Unauthorized


put/diagnostic-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}