Procedure Codes

Create ProcedureCode

Creates a new ProcedureCode

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
procedure_Code
required
string [ 1 .. 8 ] characters

Code assigned to the associated procedure.

age_Range_Type
string or null <= 1 characters

Indicates how age is defined within the age range. 'End of month' means that the age will be updated when the birth ends. 'Birth Date' means that the age will be updated on the date of birth.

age_Restricted
required
boolean

Indicates that the associated procedure is limited to a certain age range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_Type
string or null <= 16 characters

Identifies how the age range is defined.

category_ID
string or null <= 32 characters

Indicates the procedure category that the associated procedure belongs to.

description
string or null <= 128 characters

Text field where the User may enter a short description of the associated procedure.

effective_Date
string or null <date-time>

Date when the associated procedure code becomes/became effective.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

from_Age
integer or null <int32>

Identifies the starting age for the acceptable age range for the associated procedure code.

gender
string or null <= 1 characters

Indicates a required gender for the associated procedure code.

long_Description
string or null <= 512 characters

Text field where the User may enter a longer and more detailed description of the associated procedure.

network_Price
number or null <double>

Network Price associated with the procedure code

pend_Ex_Code
string or null <= 6 characters

Indicates the Ex Code that will be applied to claims that contain the associated procedure.

pend_Flag
string or null <= 1 characters

Allows the User to choose an Ex Code that will be applied to claims that contain the associated procedure.

procedure_Group
integer or null <int32>

Identifies the group of procedures that the associated procedure belongs to.

qualifier
string or null <= 2 characters

Identifies a procedure code as a revenue code.

require_Auth
required
boolean

Indicates that an auth will be required when the associated procedure is used within a claim. Note: This field is marked as NOT NULL in the database and therefore required by the API.

term_Date
string or null <date-time>

Date when the associated procedure code expires/expired.

thru_Age
integer or null <int32>

Identifies the ending age for the acceptable age range for the associated procedure code.

treatment_Type
string or null <= 8 characters

Identifier specifying the treatment type associated with the procedure code

ucR_Price
number or null <double>

Usual and Customary Price associated with the procedure code

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/procedure-codes
Request samples
{
  • "procedure_Code": "string",
  • "age_Range_Type": "s",
  • "age_Restricted": true,
  • "age_Type": "string",
  • "category_ID": "string",
  • "description": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Age": 0,
  • "gender": "s",
  • "long_Description": "string",
  • "network_Price": 0.1,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "procedure_Group": 0,
  • "qualifier": "st",
  • "require_Auth": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "thru_Age": 0,
  • "treatment_Type": "string",
  • "ucR_Price": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProcedureCode

Lists all ProcedureCode

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/procedure-codes
Request samples 
Response samples 
No sample
Get ProcedureCode
Gets ProcedureCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/procedure-codes/{procedureCode}
Request samples 
Response samples 
No sample
Update ProcedureCode
Updates a specific ProcedureCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
procedure_Code
required
string  [ 1 .. 8 ] characters 
Code assigned to the associated procedure.


 
age_Range_Type
string or null  <= 1 characters 
Indicates how age is defined within the age range. 'End of month' means that the age will be updated when the birth ends. 'Birth Date' means that the age will be updated on the date of birth.


 
age_Restricted
required
boolean
Indicates that the associated procedure is limited to a certain age range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Type
string or null  <= 16 characters 
Identifies how the age range is defined.


 
category_ID
string or null  <= 32 characters 
Indicates the procedure category that the associated procedure belongs to.


 
description
string or null  <= 128 characters 
Text field where the User may enter a short description of the associated procedure.


 
effective_Date
string or null <date-time> 
Date when the associated procedure code becomes/became effective.


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


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


 
from_Age
integer or null <int32> 
Identifies the starting age for the acceptable age range for the associated procedure code.


 
gender
string or null  <= 1 characters 
Indicates a required gender for the associated procedure code.


 
long_Description
string or null  <= 512 characters 
Text field where the User may enter a longer and more detailed description of the associated procedure.


 
network_Price
number or null <double> 
Network Price associated with the procedure code


 
pend_Ex_Code
string or null  <= 6 characters 
Indicates the Ex Code that will be applied to claims that contain the associated procedure.


 
pend_Flag
string or null  <= 1 characters 
Allows the User to choose an Ex Code that will be applied to claims that contain the associated procedure.


 
procedure_Group
integer or null <int32> 
Identifies the group of procedures that the associated procedure belongs to.


 
qualifier
string or null  <= 2 characters 
Identifies a procedure code as a revenue code.


 
require_Auth
required
boolean
Indicates that an auth will be required when the associated procedure is used within a claim. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the associated procedure code expires/expired.


 
thru_Age
integer or null <int32> 
Identifies the ending age for the acceptable age range for the associated procedure code.


 
treatment_Type
string or null  <= 8 characters 
Identifier specifying the treatment type associated with the procedure code


 
ucR_Price
number or null <double> 
Usual and Customary Price associated with the procedure code


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


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


 
Responses 
200
Success


401
Unauthorized


put/procedure-codes/{procedureCode}
Request samples 
{
  • "procedure_Code": "string",
  • "age_Range_Type": "s",
  • "age_Restricted": true,
  • "age_Type": "string",
  • "category_ID": "string",
  • "description": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Age": 0,
  • "gender": "s",
  • "long_Description": "string",
  • "network_Price": 0.1,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "procedure_Group": 0,
  • "qualifier": "st",
  • "require_Auth": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "thru_Age": 0,
  • "treatment_Type": "string",
  • "ucR_Price": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProcedureCode
Deletes an ProcedureCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/procedure-codes/{procedureCode}
Request samples 
Create or Update Batch ProcedureCode
Create or Update multiple ProcedureCode 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 
procedure_Code
required
string  [ 1 .. 8 ] characters 
Code assigned to the associated procedure.


 
age_Range_Type
string or null  <= 1 characters 
Indicates how age is defined within the age range. 'End of month' means that the age will be updated when the birth ends. 'Birth Date' means that the age will be updated on the date of birth.


 
age_Restricted
required
boolean
Indicates that the associated procedure is limited to a certain age range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Type
string or null  <= 16 characters 
Identifies how the age range is defined.


 
category_ID
string or null  <= 32 characters 
Indicates the procedure category that the associated procedure belongs to.


 
description
string or null  <= 128 characters 
Text field where the User may enter a short description of the associated procedure.


 
effective_Date
string or null <date-time> 
Date when the associated procedure code becomes/became effective.


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


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


 
from_Age
integer or null <int32> 
Identifies the starting age for the acceptable age range for the associated procedure code.


 
gender
string or null  <= 1 characters 
Indicates a required gender for the associated procedure code.


 
long_Description
string or null  <= 512 characters 
Text field where the User may enter a longer and more detailed description of the associated procedure.


 
network_Price
number or null <double> 
Network Price associated with the procedure code


 
pend_Ex_Code
string or null  <= 6 characters 
Indicates the Ex Code that will be applied to claims that contain the associated procedure.


 
pend_Flag
string or null  <= 1 characters 
Allows the User to choose an Ex Code that will be applied to claims that contain the associated procedure.


 
procedure_Group
integer or null <int32> 
Identifies the group of procedures that the associated procedure belongs to.


 
qualifier
string or null  <= 2 characters 
Identifies a procedure code as a revenue code.


 
require_Auth
required
boolean
Indicates that an auth will be required when the associated procedure is used within a claim. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the associated procedure code expires/expired.


 
thru_Age
integer or null <int32> 
Identifies the ending age for the acceptable age range for the associated procedure code.


 
treatment_Type
string or null  <= 8 characters 
Identifier specifying the treatment type associated with the procedure code


 
ucR_Price
number or null <double> 
Usual and Customary Price associated with the procedure code


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


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


 
Responses 
207
Success


401
Unauthorized


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