Explanation Codes

Create ExplanationCodes

Creates a new ExplanationCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
ex_Code
required
string [ 1 .. 6 ] characters
admin_Override
required
string = 1 characters
category
string or null <= 6 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
ex_Description
string or null <= 64 characters
ex_Result
string or null <= 1 characters
hipaA_Code
string or null <= 8 characters
hipaA_Group_Code
string or null <= 8 characters
long_Description
string or null <= 1024 characters
no_Print_On_Remit
required
string = 1 characters
override_Denied
required
boolean
override_Pend
required
boolean
patient_Responsibility
required
boolean
print_Only
required
boolean
suppress_EOB_Remit
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/ex-codes
Request samples
{
  • "ex_Code": "string",
  • "admin_Override": "s",
  • "category": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Description": "string",
  • "ex_Result": "s",
  • "hipaA_Code": "string",
  • "hipaA_Group_Code": "string",
  • "long_Description": "string",
  • "no_Print_On_Remit": "s",
  • "override_Denied": true,
  • "override_Pend": true,
  • "patient_Responsibility": true,
  • "print_Only": true,
  • "suppress_EOB_Remit": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ExplanationCodes

Lists all ExplanationCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/ex-codes
Request samples 
Response samples 
No sample
Get ExplanationCodes
Gets ExplanationCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
exCode
required
string
Ex Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/ex-codes/{exCode}
Request samples 
Response samples 
No sample
Update ExplanationCodes
Updates a specific ExplanationCodes.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
exCode
required
string
Ex Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
ex_Code
required
string  [ 1 .. 6 ] characters 
 
admin_Override
required
string  = 1 characters 
 
category
string or null  <= 6 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Description
string or null  <= 64 characters 
 
ex_Result
string or null  <= 1 characters 
 
hipaA_Code
string or null  <= 8 characters 
 
hipaA_Group_Code
string or null  <= 8 characters 
 
long_Description
string or null  <= 1024 characters 
 
no_Print_On_Remit
required
string  = 1 characters 
 
override_Denied
required
boolean
 
override_Pend
required
boolean
 
patient_Responsibility
required
boolean
 
print_Only
required
boolean
 
suppress_EOB_Remit
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/ex-codes/{exCode}
Request samples 
{
  • "ex_Code": "string",
  • "admin_Override": "s",
  • "category": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Description": "string",
  • "ex_Result": "s",
  • "hipaA_Code": "string",
  • "hipaA_Group_Code": "string",
  • "long_Description": "string",
  • "no_Print_On_Remit": "s",
  • "override_Denied": true,
  • "override_Pend": true,
  • "patient_Responsibility": true,
  • "print_Only": true,
  • "suppress_EOB_Remit": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ExplanationCodes
Deletes an ExplanationCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
exCode
required
string
Ex Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/ex-codes/{exCode}
Request samples 
Create or Update Batch ExplanationCodes
Create or Update multiple ExplanationCodes 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 
ex_Code
required
string  [ 1 .. 6 ] characters 
 
admin_Override
required
string  = 1 characters 
 
category
string or null  <= 6 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
ex_Description
string or null  <= 64 characters 
 
ex_Result
string or null  <= 1 characters 
 
hipaA_Code
string or null  <= 8 characters 
 
hipaA_Group_Code
string or null  <= 8 characters 
 
long_Description
string or null  <= 1024 characters 
 
no_Print_On_Remit
required
string  = 1 characters 
 
override_Denied
required
boolean
 
override_Pend
required
boolean
 
patient_Responsibility
required
boolean
 
print_Only
required
boolean
 
suppress_EOB_Remit
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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