Skip to content

Create Auth

Request

Creates a new Auth and returns the generated Auth.

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
auth_Numberstring or null, <= 20 characters

Unique identifier assigned to the authorization.

actual_Fromstring or null, (date-time)

Date when authorization usage begins/began.

actual_Locationstring or null, <= 4 characters

Location where the authorization was used.

actual_Thrustring or null, (date-time)

Date when authorization usage ends/ended.

additional_Visitsnumber 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_Actualnumber or null, (double)

Total approved amount that has been used.

amount_Approvednumber or null, (double)

Approved amount of the authorization.

amount_Deniednumber or null, (double)

Denied amount of the authorization.

amount_Requestednumber or null, (double)

Requested amount of the authorization.

approved_Bystring or null, <= 50 characters

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

approved_Datestring or null, (date-time)

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

approved_Frequencystring or null, <= 16 characters

Authorization frequency that is/was approved.

approved_Fromstring or null, (date-time)

Date when the authorization approval starts/started.

approved_Locationstring or null, <= 4 characters

Approved location of the authorization.

approved_Thrustring or null, (date-time)

Date when the authorization approval expires/expired.

assigned_Userstring or null, <= 20 characters

User that the authorization was assigned to.

audit_Flagstring or null, <= 1 characters

Information field used in custom reporting.

auth_Codestring or null, <= 8 characters

Code that indicates the authorization status.

auth_Typestring or null, <= 8 characters

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

auto_Accidentstring or null, <= 1 characters

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

bodyCode_IDstring or null, <= 8 characters

No longer in use.

careManager_Keyinteger or null, (int32)

ID of the Care Manager associated with the auth.

case_Index_Actualstring or null, <= 2 characters

Informational field used to identify the case index.

case_Index_Approvedstring or null, <= 2 characters

Informational field used to identify the case index.

case_Index_Deniedstring or null, <= 2 characters

Informational field used to identify the case index.

case_Index_Requestedstring or null, <= 2 characters

Informational field used to identify the case index.

case_Numberstring or null, <= 64 characters

Informational field used to house the case number.

cityCode_IDstring or null, <= 8 characters

No longer in use.

closedbooleanrequired

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_Categorystring or null, <= 8 characters

Identifies the category of the selected DRG Code.

drG_Codestring or null, <= 8 characters

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

daily_Livinginteger or null, (int32)

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

denied_Fromstring or null, (date-time)

Date when the authorization denial starts/started.

denied_Thrustring or null, (date-time)

Date when the authorization denial expires/expired.

discharge_Datestring or null, (date-time)

Date when the patient was discharged.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

federal_IDstring or null, <= 20 characters

VBA internal Federal_ID of the Provider associated with the Auth. Do not send NPI or another Provider alternate identifier.

ivR_Flagstring or null, <= 1 characters

Indicates that the Auth was Initiated via IVR.

injury_Datestring or null, (date-time)

Date when the injury occurred.

member_Seqstring or null, <= 2 characters

VBA internal Member_Seq of the Member associated with the Auth. Together with Subscriber_ID this is the Member composite key. Do not send a member alternate identifier.

monthly_Amountnumber or null, (double)

Information field used in custom reporting.

narrativestring or null

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

new_Or_Extendedbooleanrequired

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.

notesstring or null

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

ordered_By_IDstring or null, <= 20 characters

ID of the Provider who ordered this auth.

ordered_By_Namestring or null, <= 512 characters

Name of the Provider who ordered this auth.

other_Coverage_Primarystring or null, <= 1 characters

Information field used in custom reporting.

other_Insurancestring or null, <= 2 characters

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

payee_IDstring or null, <= 20 characters

ID of the Payee associated with the auth.

plan_IDstring or null, <= 20 characters

Unique identifier assigned to the plan.

previous_Authstring 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_Treatmentbooleanrequired

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_Authstring or null, <= 20 characters

References Prior Auth

provider_IDstring or null, <= 20 characters

VBA internal Provider_ID of the Provider associated with the Auth. Do not send NPI or another Provider alternate identifier; the Auth screen joins Provider data on this internal key.

radiating_Paininteger or null, (int32)

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

range_Of_Motioninteger or null, (int32)

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

received_Datestring or null, (date-time)

Date when the authorization was received.

referred_By_IDstring 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_Namestring or null, <= 512 characters

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

regionstring or null, <= 1 characters

Information field used in custom reporting.

reinsNotification_Datestring 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_Frequencystring or null, <= 16 characters

Authorization frequency that is/was requested.

requested_Fromstring or null, (date-time)

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

requested_Locationstring or null, <= 4 characters

Requested location of the authorization.

requested_Thrustring or null, (date-time)

Date when the authorization is/was requested to expire.

service_Codestring or null, <= 5 characters

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

service_Typestring or null, <= 10 characters

Type of service associated with the authorization.

statusstring or null, <= 8 characters

Identifies the current status of the authorization.

subscriber_IDstring or null, <= 9 characters

VBA internal Subscriber_ID of the Member associated with the Auth. Together with Member_Seq this is the Member composite key. Do not send a member alternate identifier.

tPlan_DownLoadedbooleanrequired

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_Datestring or null, (date-time)

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

tPlan_DownLoaded_Userstring or null, <= 20 characters

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

tPlan_Printedstring, = 1 charactersrequired

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

tPlan_Printed_Datestring or null, (date-time)

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

total_Actualnumber or null, (double)

No longer in use.

total_Approvednumber or null, (double)

No longer in use.

total_Requestednumber or null, (double)

No longer in use.

total_Unit_Typestring or null, <= 16 characters

No longer in use.

treatment_Typestring or null, <= 8 characters

Indicates the type of treatment that is being authorized.

type_Of_Servicestring or null, <= 5 characters

No longer in use.

unit_Typestring or null, <= 16 characters

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

units_Actualnumber or null, (double)

Total number of approved units that have been used.

units_Approvednumber or null, (double)

Number of units approved as part of the authorization.

units_Deniednumber or null, (double)

Number of units denied as part of the authorization.

units_Requestednumber or null, (double)

Number of units requested as part of the authorization.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

urgentbooleanrequired

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_Actualnumber or null, (double)

Number of visits used as part of the authorization.

visits_Approvednumber or null, (double)

Number of visits approved as part of the authorization.

visits_Requestednumber or null, (double)

Number of visits requested as part of the authorization.

visits_To_Datenumber or null, (double)

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

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/auths \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject

Authorization request/response DTO for Auth API create, update, and batch operations.

errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}