Auth

Create Auth

Creates a new Auth and returns the generated Auth.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
auth_Number
string or null <= 20 characters

Unique identifier assigned to the authorization.

actual_From
string or null <date-time>

Date when authorization usage begins/began.

actual_Location
string or null <= 4 characters

Location where the authorization was used.

actual_Thru
string or null <date-time>

Date when authorization usage ends/ended.

additional_Visits
number or null <double>

No longer in use. This would track if an Auth had been adjusted to increase the number of approved visits. This is now done through the Auth Adjustment process where a new Auth is created referencing the original Auth.

amount_Actual
number or null <double>

Total approved amount that has been used.

amount_Approved
number or null <double>

Approved amount of the authorization.

amount_Denied
number or null <double>

Denied amount of the authorization.

amount_Requested
number or null <double>

Requested amount of the authorization.

approved_By
string or null <= 50 characters

User that either approved, pended, or denied the authorization.

approved_Date
string or null <date-time>

Date when the authorization was approved, denied, or pended as specified by the status field.

approved_Frequency
string or null <= 16 characters

Authorization frequency that is/was approved.

approved_From
string or null <date-time>

Date when the authorization approval starts/started.

approved_Location
string or null <= 4 characters

Approved location of the authorization.

approved_Thru
string or null <date-time>

Date when the authorization approval expires/expired.

assigned_User
string or null <= 20 characters

User that the authorization was assigned to.

audit_Flag
string or null <= 1 characters

Information field used in custom reporting.

auth_Code
string or null <= 8 characters

Code that indicates the authorization status.

auth_Type
string or null <= 8 characters

Indicates the type of authorization. Auth types can be configured within 'Auth Configuration'.

auto_Accident
string or null <= 1 characters

Check this box to indicate that the authorization is related to an automotive accident.

bodyCode_ID
string or null <= 8 characters

No longer in use.

careManager_Key
integer or null <int32>

ID of the Care Manager associated with the auth.

case_Index_Actual
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Approved
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Denied
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Requested
string or null <= 2 characters

Informational field used to identify the case index.

case_Number
string or null <= 64 characters

Informational field used to house the case number.

cityCode_ID
string or null <= 8 characters

No longer in use.

closed
required
boolean

Field no longer used. This is repalced by the Status field. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

drG_Category
string or null <= 8 characters

Identifies the category of the selected DRG Code.

drG_Code
string or null <= 8 characters

Specifies a DRG code that is to be associated with the authorization.

daily_Living
integer or null <int32>

Identifies that the authoization is associated with a claim that is affecting the patient's daily living.

denied_From
string or null <date-time>

Date when the authorization denial starts/started.

denied_Thru
string or null <date-time>

Date when the authorization denial expires/expired.

discharge_Date
string or null <date-time>

Date when the patient was discharged.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

federal_ID
string or null <= 20 characters

Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

ivR_Flag
string or null <= 1 characters

Indicates that the Auth was Initiated via IVR.

injury_Date
string or null <date-time>

Date when the injury occurred.

member_Seq
string or null <= 2 characters

Sequential identifier assigned to the Member.

monthly_Amount
number or null <double>

Information field used in custom reporting.

narrative
string or null

Field no longer used. For Notes/Comments/Narrative information you would use the Note Services area.

new_Or_Extended
required
boolean

Indicates that the associated authorization is a new authorization or an extension of the original authorization. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

notes
string or null

Field that allows the User to add any additional information to the authorization.

ordered_By_ID
string or null <= 20 characters

ID of the Provider who ordered this auth.

ordered_By_Name
string or null <= 512 characters

Name of the Provider who ordered this auth.

other_Coverage_Primary
string or null <= 1 characters

Information field used in custom reporting.

other_Insurance
string or null <= 2 characters

Check this box to indicate that the associated Member has other insurance.

payee_ID
string or null <= 20 characters

ID of the Payee associated with the auth.

plan_ID
string or null <= 20 characters

Unique identifier assigned to the plan.

previous_Auth
string or null <= 20 characters

This field is no longer used as it has been replaced by the the Auth Adjustment process where an AuthReference record is created instead.

previous_Treatment
required
boolean

Check this box to indicate that previous treatment had been administered. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

prior_Auth
string or null <= 20 characters

References Prior Auth

provider_ID
string or null <= 20 characters

Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

radiating_Pain
integer or null <int32>

Identifies that the authoization is associated with a claim where the patient is experiencing radiating pain.

range_Of_Motion
integer or null <int32>

Identifies that the authoization is associated with a claim that is affecting the patient's range of motion.

received_Date
string or null <date-time>

Date when the authorization was received.

referred_By_ID
string or null <= 20 characters

Unique identifier assigned to the Provider who is referring. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

referred_By_Name
string or null <= 512 characters

Name of the referring Provider. This field is automatically populated by the 'Referred By ID' field.

region
string or null <= 1 characters

Information field used in custom reporting.

reinsNotification_Date
string or null <date-time>

Date when the Reinsurance Notification report was run. Process automation will be prompted to send the auth reinsurance notification on this date.

requested_Frequency
string or null <= 16 characters

Authorization frequency that is/was requested.

requested_From
string or null <date-time>

Date when the authorization is/was requested to be effective.

requested_Location
string or null <= 4 characters

Requested location of the authorization.

requested_Thru
string or null <date-time>

Date when the authorization is/was requested to expire.

service_Code
string or null <= 5 characters

Code used to identify the service type associated with the authorization.

service_Type
string or null <= 10 characters

Type of service associated with the authorization.

status
string or null <= 8 characters

Identifies the current status of the authorization.

subscriber_ID
string or null <= 9 characters

Unique identifier assigned to the Subscriber associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

tPlan_DownLoaded
required
boolean

Indicates if the Treatment Plan was downloaded from the application. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

tPlan_DownLoaded_Date
string or null <date-time>

Indicates the date the Treatment Plan was downloaded from the application.

tPlan_DownLoaded_User
string or null <= 20 characters

Indicates the user what downloaded the Treatment Plan from the application.

tPlan_Printed
required
string = 1 characters

Flag indicating if this Auth has been printed as a Treatment Plan.

tPlan_Printed_Date
string or null <date-time>

The date this Auth has been printed as a Treatment Plan.

total_Actual
number or null <double>

No longer in use.

total_Approved
number or null <double>

No longer in use.

total_Requested
number or null <double>

No longer in use.

total_Unit_Type
string or null <= 16 characters

No longer in use.

treatment_Type
string or null <= 8 characters

Indicates the type of treatment that is being authorized.

type_Of_Service
string or null <= 5 characters

No longer in use.

unit_Type
string or null <= 16 characters

Unit type that is used for the associated service. Unit types can be configured in 'Auth Configuration'.

units_Actual
number or null <double>

Total number of approved units that have been used.

units_Approved
number or null <double>

Number of units approved as part of the authorization.

units_Denied
number or null <double>

Number of units denied as part of the authorization.

units_Requested
number or null <double>

Number of units requested as part of the authorization.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

urgent
required
boolean

Check this box to indicate that the authorization request is urgent. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

visits_Actual
number or null <double>

Number of visits used as part of the authorization.

visits_Approved
number or null <double>

Number of visits approved as part of the authorization.

visits_Requested
number or null <double>

Number of visits requested as part of the authorization.

visits_To_Date
number or null <double>

Number of visits that have been used up to the current date.

work_Related
string or null <= 1 characters

Check this box to indicate that the authorization is related to work.

Responses
200

Success

401

Unauthorized

post/auths
Request samples
{
  • "auth_Number": "string",
  • "actual_From": "2019-08-24T14:15:22Z",
  • "actual_Location": "stri",
  • "actual_Thru": "2019-08-24T14:15:22Z",
  • "additional_Visits": 0.1,
  • "amount_Actual": 0.1,
  • "amount_Approved": 0.1,
  • "amount_Denied": 0.1,
  • "amount_Requested": 0.1,
  • "approved_By": "string",
  • "approved_Date": "2019-08-24T14:15:22Z",
  • "approved_Frequency": "string",
  • "approved_From": "2019-08-24T14:15:22Z",
  • "approved_Location": "stri",
  • "approved_Thru": "2019-08-24T14:15:22Z",
  • "assigned_User": "string",
  • "audit_Flag": "s",
  • "auth_Code": "string",
  • "auth_Type": "string",
  • "auto_Accident": "s",
  • "bodyCode_ID": "string",
  • "careManager_Key": 0,
  • "case_Index_Actual": "st",
  • "case_Index_Approved": "st",
  • "case_Index_Denied": "st",
  • "case_Index_Requested": "st",
  • "case_Number": "string",
  • "cityCode_ID": "string",
  • "closed": true,
  • "drG_Category": "string",
  • "drG_Code": "string",
  • "daily_Living": 0,
  • "denied_From": "2019-08-24T14:15:22Z",
  • "denied_Thru": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "federal_ID": "string",
  • "ivR_Flag": "s",
  • "injury_Date": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "monthly_Amount": 0.1,
  • "narrative": "string",
  • "new_Or_Extended": true,
  • "notes": "string",
  • "ordered_By_ID": "string",
  • "ordered_By_Name": "string",
  • "other_Coverage_Primary": "s",
  • "other_Insurance": "st",
  • "payee_ID": "string",
  • "plan_ID": "string",
  • "previous_Auth": "string",
  • "previous_Treatment": true,
  • "prior_Auth": "string",
  • "provider_ID": "string",
  • "radiating_Pain": 0,
  • "range_Of_Motion": 0,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "referred_By_ID": "string",
  • "referred_By_Name": "string",
  • "region": "s",
  • "reinsNotification_Date": "2019-08-24T14:15:22Z",
  • "requested_Frequency": "string",
  • "requested_From": "2019-08-24T14:15:22Z",
  • "requested_Location": "stri",
  • "requested_Thru": "2019-08-24T14:15:22Z",
  • "service_Code": "strin",
  • "service_Type": "string",
  • "status": "string",
  • "subscriber_ID": "string",
  • "tPlan_DownLoaded": true,
  • "tPlan_DownLoaded_Date": "2019-08-24T14:15:22Z",
  • "tPlan_DownLoaded_User": "string",
  • "tPlan_Printed": "s",
  • "tPlan_Printed_Date": "2019-08-24T14:15:22Z",
  • "total_Actual": 0.1,
  • "total_Approved": 0.1,
  • "total_Requested": 0.1,
  • "total_Unit_Type": "string",
  • "treatment_Type": "string",
  • "type_Of_Service": "strin",
  • "unit_Type": "string",
  • "units_Actual": 0.1,
  • "units_Approved": 0.1,
  • "units_Denied": 0.1,
  • "units_Requested": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "urgent": true,
  • "visits_Actual": 0.1,
  • "visits_Approved": 0.1,
  • "visits_Requested": 0.1,
  • "visits_To_Date": 0.1,
  • "work_Related": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Create or Update Auth Batch

Creates or Updates Multiple Auths

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
auth_Number
string or null <= 20 characters

Unique identifier assigned to the authorization.

actual_From
string or null <date-time>

Date when authorization usage begins/began.

actual_Location
string or null <= 4 characters

Location where the authorization was used.

actual_Thru
string or null <date-time>

Date when authorization usage ends/ended.

additional_Visits
number or null <double>

No longer in use. This would track if an Auth had been adjusted to increase the number of approved visits. This is now done through the Auth Adjustment process where a new Auth is created referencing the original Auth.

amount_Actual
number or null <double>

Total approved amount that has been used.

amount_Approved
number or null <double>

Approved amount of the authorization.

amount_Denied
number or null <double>

Denied amount of the authorization.

amount_Requested
number or null <double>

Requested amount of the authorization.

approved_By
string or null <= 50 characters

User that either approved, pended, or denied the authorization.

approved_Date
string or null <date-time>

Date when the authorization was approved, denied, or pended as specified by the status field.

approved_Frequency
string or null <= 16 characters

Authorization frequency that is/was approved.

approved_From
string or null <date-time>

Date when the authorization approval starts/started.

approved_Location
string or null <= 4 characters

Approved location of the authorization.

approved_Thru
string or null <date-time>

Date when the authorization approval expires/expired.

assigned_User
string or null <= 20 characters

User that the authorization was assigned to.

audit_Flag
string or null <= 1 characters

Information field used in custom reporting.

auth_Code
string or null <= 8 characters

Code that indicates the authorization status.

auth_Type
string or null <= 8 characters

Indicates the type of authorization. Auth types can be configured within 'Auth Configuration'.

auto_Accident
string or null <= 1 characters

Check this box to indicate that the authorization is related to an automotive accident.

bodyCode_ID
string or null <= 8 characters

No longer in use.

careManager_Key
integer or null <int32>

ID of the Care Manager associated with the auth.

case_Index_Actual
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Approved
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Denied
string or null <= 2 characters

Informational field used to identify the case index.

case_Index_Requested
string or null <= 2 characters

Informational field used to identify the case index.

case_Number
string or null <= 64 characters

Informational field used to house the case number.

cityCode_ID
string or null <= 8 characters

No longer in use.

closed
required
boolean

Field no longer used. This is repalced by the Status field. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

drG_Category
string or null <= 8 characters

Identifies the category of the selected DRG Code.

drG_Code
string or null <= 8 characters

Specifies a DRG code that is to be associated with the authorization.

daily_Living
integer or null <int32>

Identifies that the authoization is associated with a claim that is affecting the patient's daily living.

denied_From
string or null <date-time>

Date when the authorization denial starts/started.

denied_Thru
string or null <date-time>

Date when the authorization denial expires/expired.

discharge_Date
string or null <date-time>

Date when the patient was discharged.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

federal_ID
string or null <= 20 characters

Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

ivR_Flag
string or null <= 1 characters

Indicates that the Auth was Initiated via IVR.

injury_Date
string or null <date-time>

Date when the injury occurred.

member_Seq
string or null <= 2 characters

Sequential identifier assigned to the Member.

monthly_Amount
number or null <double>

Information field used in custom reporting.

narrative
string or null

Field no longer used. For Notes/Comments/Narrative information you would use the Note Services area.

new_Or_Extended
required
boolean

Indicates that the associated authorization is a new authorization or an extension of the original authorization. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

notes
string or null

Field that allows the User to add any additional information to the authorization.

ordered_By_ID
string or null <= 20 characters

ID of the Provider who ordered this auth.

ordered_By_Name
string or null <= 512 characters

Name of the Provider who ordered this auth.

other_Coverage_Primary
string or null <= 1 characters

Information field used in custom reporting.

other_Insurance
string or null <= 2 characters

Check this box to indicate that the associated Member has other insurance.

payee_ID
string or null <= 20 characters

ID of the Payee associated with the auth.

plan_ID
string or null <= 20 characters

Unique identifier assigned to the plan.

previous_Auth
string or null <= 20 characters

This field is no longer used as it has been replaced by the the Auth Adjustment process where an AuthReference record is created instead.

previous_Treatment
required
boolean

Check this box to indicate that previous treatment had been administered. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

prior_Auth
string or null <= 20 characters

References Prior Auth

provider_ID
string or null <= 20 characters

Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

radiating_Pain
integer or null <int32>

Identifies that the authoization is associated with a claim where the patient is experiencing radiating pain.

range_Of_Motion
integer or null <int32>

Identifies that the authoization is associated with a claim that is affecting the patient's range of motion.

received_Date
string or null <date-time>

Date when the authorization was received.

referred_By_ID
string or null <= 20 characters

Unique identifier assigned to the Provider who is referring. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

referred_By_Name
string or null <= 512 characters

Name of the referring Provider. This field is automatically populated by the 'Referred By ID' field.

region
string or null <= 1 characters

Information field used in custom reporting.

reinsNotification_Date
string or null <date-time>

Date when the Reinsurance Notification report was run. Process automation will be prompted to send the auth reinsurance notification on this date.

requested_Frequency
string or null <= 16 characters

Authorization frequency that is/was requested.

requested_From
string or null <date-time>

Date when the authorization is/was requested to be effective.

requested_Location
string or null <= 4 characters

Requested location of the authorization.

requested_Thru
string or null <date-time>

Date when the authorization is/was requested to expire.

service_Code
string or null <= 5 characters

Code used to identify the service type associated with the authorization.

service_Type
string or null <= 10 characters

Type of service associated with the authorization.

status
string or null <= 8 characters

Identifies the current status of the authorization.

subscriber_ID
string or null <= 9 characters

Unique identifier assigned to the Subscriber associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

tPlan_DownLoaded
required
boolean

Indicates if the Treatment Plan was downloaded from the application. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

tPlan_DownLoaded_Date
string or null <date-time>

Indicates the date the Treatment Plan was downloaded from the application.

tPlan_DownLoaded_User
string or null <= 20 characters

Indicates the user what downloaded the Treatment Plan from the application.

tPlan_Printed
required
string = 1 characters

Flag indicating if this Auth has been printed as a Treatment Plan.

tPlan_Printed_Date
string or null <date-time>

The date this Auth has been printed as a Treatment Plan.

total_Actual
number or null <double>

No longer in use.

total_Approved
number or null <double>

No longer in use.

total_Requested
number or null <double>

No longer in use.

total_Unit_Type
string or null <= 16 characters

No longer in use.

treatment_Type
string or null <= 8 characters

Indicates the type of treatment that is being authorized.

type_Of_Service
string or null <= 5 characters

No longer in use.

unit_Type
string or null <= 16 characters

Unit type that is used for the associated service. Unit types can be configured in 'Auth Configuration'.

units_Actual
number or null <double>

Total number of approved units that have been used.

units_Approved
number or null <double>

Number of units approved as part of the authorization.

units_Denied
number or null <double>

Number of units denied as part of the authorization.

units_Requested
number or null <double>

Number of units requested as part of the authorization.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

urgent
required
boolean

Check this box to indicate that the authorization request is urgent. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

visits_Actual
number or null <double>

Number of visits used as part of the authorization.

visits_Approved
number or null <double>

Number of visits approved as part of the authorization.

visits_Requested
number or null <double>

Number of visits requested as part of the authorization.

visits_To_Date
number or null <double>

Number of visits that have been used up to the current date.

work_Related
string or null <= 1 characters

Check this box to indicate that the authorization is related to work.

Responses
207

Multicode response

401

Unauthorized

put/auths
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}

Get Auth

Gets a specific Auth.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
authNumber
required
string

Auth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/auths/{authNumber}
Request samples 
Response samples 
No sample
Update Auth
Updates a specific Auth and returns the updated Auth after changes have been applied.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authNumber
required
string
Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
auth_Number
string or null  <= 20 characters 
Unique identifier assigned to the authorization.


 
actual_From
string or null <date-time> 
Date when authorization usage begins/began.


 
actual_Location
string or null  <= 4 characters 
Location where the authorization was used.


 
actual_Thru
string or null <date-time> 
Date when authorization usage ends/ended.


 
additional_Visits
number or null <double> 
No longer in use. This would track if an Auth had been adjusted to increase the number of approved visits. This is now done through the Auth Adjustment process where a new Auth is created referencing the original Auth.


 
amount_Actual
number or null <double> 
Total approved amount that has been used.


 
amount_Approved
number or null <double> 
Approved amount of the authorization.


 
amount_Denied
number or null <double> 
Denied amount of the authorization.


 
amount_Requested
number or null <double> 
Requested amount of the authorization.


 
approved_By
string or null  <= 50 characters 
User that either approved, pended, or denied the authorization.


 
approved_Date
string or null <date-time> 
Date when the authorization was approved, denied, or pended as specified by the status field.


 
approved_Frequency
string or null  <= 16 characters 
Authorization frequency that is/was approved.


 
approved_From
string or null <date-time> 
Date when the authorization approval starts/started.


 
approved_Location
string or null  <= 4 characters 
Approved location of the authorization.


 
approved_Thru
string or null <date-time> 
Date when the authorization approval expires/expired.


 
assigned_User
string or null  <= 20 characters 
User that the authorization was assigned to.


 
audit_Flag
string or null  <= 1 characters 
Information field used in custom reporting.


 
auth_Code
string or null  <= 8 characters 
Code that indicates the authorization status.


 
auth_Type
string or null  <= 8 characters 
Indicates the type of authorization. Auth types can be configured within 'Auth Configuration'.


 
auto_Accident
string or null  <= 1 characters 
Check this box to indicate that the authorization is related to an automotive accident.


 
bodyCode_ID
string or null  <= 8 characters 
No longer in use.


 
careManager_Key
integer or null <int32> 
ID of the Care Manager associated with the auth.


 
case_Index_Actual
string or null  <= 2 characters 
Informational field used to identify the case index.


 
case_Index_Approved
string or null  <= 2 characters 
Informational field used to identify the case index.


 
case_Index_Denied
string or null  <= 2 characters 
Informational field used to identify the case index.


 
case_Index_Requested
string or null  <= 2 characters 
Informational field used to identify the case index.


 
case_Number
string or null  <= 64 characters 
Informational field used to house the case number.


 
cityCode_ID
string or null  <= 8 characters 
No longer in use.


 
closed
required
boolean
Field no longer used. This is repalced by the Status field.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
drG_Category
string or null  <= 8 characters 
Identifies the category of the selected DRG Code.


 
drG_Code
string or null  <= 8 characters 
Specifies a DRG code that is to be associated with the authorization.


 
daily_Living
integer or null <int32> 
Identifies that the authoization is associated with a claim that is affecting the patient's daily living.


 
denied_From
string or null <date-time> 
Date when the authorization denial starts/started.


 
denied_Thru
string or null <date-time> 
Date when the authorization denial expires/expired.


 
discharge_Date
string or null <date-time> 
Date when the patient was discharged.


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


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


 
federal_ID
string or null  <= 20 characters 
Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.


 
ivR_Flag
string or null  <= 1 characters 
Indicates that the Auth was Initiated via IVR.


 
injury_Date
string or null <date-time> 
Date when the injury occurred.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier assigned to the Member.


 
monthly_Amount
number or null <double> 
Information field used in custom reporting.


 
narrative
string or null
Field no longer used. For Notes/Comments/Narrative information you would use the Note Services area.


 
new_Or_Extended
required
boolean
Indicates that the associated authorization is a new authorization or an extension of the original authorization.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
notes
string or null
Field that allows the User to add any additional information to the authorization.


 
ordered_By_ID
string or null  <= 20 characters 
ID of the Provider who ordered this auth.


 
ordered_By_Name
string or null  <= 512 characters 
Name of the Provider who ordered this auth.


 
other_Coverage_Primary
string or null  <= 1 characters 
Information field used in custom reporting.


 
other_Insurance
string or null  <= 2 characters 
Check this box to indicate that the associated Member has other insurance.


 
payee_ID
string or null  <= 20 characters 
ID of the Payee associated with the auth.


 
plan_ID
string or null  <= 20 characters 
Unique identifier assigned to the plan.


 
previous_Auth
string or null  <= 20 characters 
This field is no longer used as it has been replaced by the the Auth Adjustment process where an AuthReference record is created instead.


 
previous_Treatment
required
boolean
Check this box to indicate that previous treatment had been administered.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
prior_Auth
string or null  <= 20 characters 
References Prior Auth


 
provider_ID
string or null  <= 20 characters 
Unique identifier assigned to the Provider associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.


 
radiating_Pain
integer or null <int32> 
Identifies that the authoization is associated with a claim where the patient is experiencing radiating pain.


 
range_Of_Motion
integer or null <int32> 
Identifies that the authoization is associated with a claim that is affecting the patient's range of motion.


 
received_Date
string or null <date-time> 
Date when the authorization was received.


 
referred_By_ID
string or null  <= 20 characters 
Unique identifier assigned to the Provider who is referring. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.


 
referred_By_Name
string or null  <= 512 characters 
Name of the referring Provider. This field is automatically populated by the 'Referred By ID' field.


 
region
string or null  <= 1 characters 
Information field used in custom reporting.


 
reinsNotification_Date
string or null <date-time> 
Date when the Reinsurance Notification report was run. Process automation will be prompted to send the auth reinsurance notification on this date.


 
requested_Frequency
string or null  <= 16 characters 
Authorization frequency that is/was requested.


 
requested_From
string or null <date-time> 
Date when the authorization is/was requested to be effective.


 
requested_Location
string or null  <= 4 characters 
Requested location of the authorization.


 
requested_Thru
string or null <date-time> 
Date when the authorization is/was requested to expire.


 
service_Code
string or null  <= 5 characters 
Code used to identify the service type associated with the authorization.


 
service_Type
string or null  <= 10 characters 
Type of service associated with the authorization.


 
status
string or null  <= 8 characters 
Identifies the current status of the authorization.


 
subscriber_ID
string or null  <= 9 characters 
Unique identifier assigned to the Subscriber associated with the Auth. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.


 
tPlan_DownLoaded
required
boolean
Indicates if the Treatment Plan was downloaded from the application.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
tPlan_DownLoaded_Date
string or null <date-time> 
Indicates the date the Treatment Plan was downloaded from the application.


 
tPlan_DownLoaded_User
string or null  <= 20 characters 
Indicates the user what downloaded the Treatment Plan from the application.


 
tPlan_Printed
required
string  = 1 characters 
Flag indicating if this Auth has been printed as a Treatment Plan.


 
tPlan_Printed_Date
string or null <date-time> 
The date this Auth has been printed as a Treatment Plan.


 
total_Actual
number or null <double> 
No longer in use.


 
total_Approved
number or null <double> 
No longer in use.


 
total_Requested
number or null <double> 
No longer in use.


 
total_Unit_Type
string or null  <= 16 characters 
No longer in use.


 
treatment_Type
string or null  <= 8 characters 
Indicates the type of treatment that is being authorized.


 
type_Of_Service
string or null  <= 5 characters 
No longer in use.


 
unit_Type
string or null  <= 16 characters 
Unit type that is used for the associated service. Unit types can be configured in 'Auth Configuration'.


 
units_Actual
number or null <double> 
Total number of approved units that have been used.


 
units_Approved
number or null <double> 
Number of units approved as part of the authorization.


 
units_Denied
number or null <double> 
Number of units denied as part of the authorization.


 
units_Requested
number or null <double> 
Number of units requested as part of the authorization.


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


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


 
urgent
required
boolean
Check this box to indicate that the authorization request is urgent.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
visits_Actual
number or null <double> 
Number of visits used as part of the authorization.


 
visits_Approved
number or null <double> 
Number of visits approved as part of the authorization.


 
visits_Requested
number or null <double> 
Number of visits requested as part of the authorization.


 
visits_To_Date
number or null <double> 
Number of visits that have been used up to the current date.


 
work_Related
string or null  <= 1 characters 
Check this box to indicate that the authorization is related to work.


 
Responses 
200
Success


401
Unauthorized


put/auths/{authNumber}
Request samples 
{
  • "auth_Number": "string",
  • "actual_From": "2019-08-24T14:15:22Z",
  • "actual_Location": "stri",
  • "actual_Thru": "2019-08-24T14:15:22Z",
  • "additional_Visits": 0.1,
  • "amount_Actual": 0.1,
  • "amount_Approved": 0.1,
  • "amount_Denied": 0.1,
  • "amount_Requested": 0.1,
  • "approved_By": "string",
  • "approved_Date": "2019-08-24T14:15:22Z",
  • "approved_Frequency": "string",
  • "approved_From": "2019-08-24T14:15:22Z",
  • "approved_Location": "stri",
  • "approved_Thru": "2019-08-24T14:15:22Z",
  • "assigned_User": "string",
  • "audit_Flag": "s",
  • "auth_Code": "string",
  • "auth_Type": "string",
  • "auto_Accident": "s",
  • "bodyCode_ID": "string",
  • "careManager_Key": 0,
  • "case_Index_Actual": "st",
  • "case_Index_Approved": "st",
  • "case_Index_Denied": "st",
  • "case_Index_Requested": "st",
  • "case_Number": "string",
  • "cityCode_ID": "string",
  • "closed": true,
  • "drG_Category": "string",
  • "drG_Code": "string",
  • "daily_Living": 0,
  • "denied_From": "2019-08-24T14:15:22Z",
  • "denied_Thru": "2019-08-24T14:15:22Z",
  • "discharge_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "federal_ID": "string",
  • "ivR_Flag": "s",
  • "injury_Date": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "monthly_Amount": 0.1,
  • "narrative": "string",
  • "new_Or_Extended": true,
  • "notes": "string",
  • "ordered_By_ID": "string",
  • "ordered_By_Name": "string",
  • "other_Coverage_Primary": "s",
  • "other_Insurance": "st",
  • "payee_ID": "string",
  • "plan_ID": "string",
  • "previous_Auth": "string",
  • "previous_Treatment": true,
  • "prior_Auth": "string",
  • "provider_ID": "string",
  • "radiating_Pain": 0,
  • "range_Of_Motion": 0,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "referred_By_ID": "string",
  • "referred_By_Name": "string",
  • "region": "s",
  • "reinsNotification_Date": "2019-08-24T14:15:22Z",
  • "requested_Frequency": "string",
  • "requested_From": "2019-08-24T14:15:22Z",
  • "requested_Location": "stri",
  • "requested_Thru": "2019-08-24T14:15:22Z",
  • "service_Code": "strin",
  • "service_Type": "string",
  • "status": "string",
  • "subscriber_ID": "string",
  • "tPlan_DownLoaded": true,
  • "tPlan_DownLoaded_Date": "2019-08-24T14:15:22Z",
  • "tPlan_DownLoaded_User": "string",
  • "tPlan_Printed": "s",
  • "tPlan_Printed_Date": "2019-08-24T14:15:22Z",
  • "total_Actual": 0.1,
  • "total_Approved": 0.1,
  • "total_Requested": 0.1,
  • "total_Unit_Type": "string",
  • "treatment_Type": "string",
  • "type_Of_Service": "strin",
  • "unit_Type": "string",
  • "units_Actual": 0.1,
  • "units_Approved": 0.1,
  • "units_Denied": 0.1,
  • "units_Requested": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "urgent": true,
  • "visits_Actual": 0.1,
  • "visits_Approved": 0.1,
  • "visits_Requested": 0.1,
  • "visits_To_Date": 0.1,
  • "work_Related": "s"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Auth
Deletes an Auth.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authNumber
required
string
Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/auths/{authNumber}
Request samples 
Get VBA Auth
Gets a specific Auth with VBASoftware custom fields included.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authNumber
required
string
Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/auths-vba/{authNumber}
Request samples 
Response samples 
No sample
Auth Adjustment Advanced API 
Performs an Auth Adjustment using the values and flags specified


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authNumber
required
string
Auth Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
auth_Number
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the authorization.


 
approved_From
string or null <date-time> 
The new date when the authorization approval starts/started.


 
approved_Thru
string or null <date-time> 
The new date when the authorization approval expires/expired


 
recalcIBNR
required
boolean
Indicates if the IBNR should be recalculated after the Auth Adjustment


 
copyProcCodes
required
boolean
Indicates if the ProcCodes should be copied after Auth Adjustment


 
copyDiagCodes
required
boolean
Indicates if the DiagCodes should be copied after Auth Adjustment


 
procedure_Code
string or null
When CopyProcCodes is NOT used, you can pass a single Procedure Code here to populate the adjusted auth with a default Procedure Code value.


 
Responses 
200
Success


401
Unauthorized


post/auths/{authNumber}/adjust
Request samples 
{
  • "auth_Number": "string",
  • "approved_From": "2019-08-24T14:15:22Z",
  • "approved_Thru": "2019-08-24T14:15:22Z",
  • "recalcIBNR": true,
  • "copyProcCodes": true,
  • "copyDiagCodes": true,
  • "procedure_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Process a change in Auth Status Advanced API 
Initiates an Auth Status change.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
authNumber
required
string
the Entity


 
newAuthCode
required
string
New Auth Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/auths/{authNumber}/process-status/{newAuthCode}
Request samples 
Response samples 
No sample