Provider

Create Provider

Creates a new Provider

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Unique idenfitier assigned to the Proivider record.

accepting_Age_From
integer or null <int32>

Beginning of the range of accepted patient ages.

accepting_Age_Thru
integer or null <int32>

End of the range of accepted patient ages.

accepting_Patients
required
boolean

Indicates whether the selected Provider is accepting new patients. 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.

accepts_Capitation
required
boolean

No longer in use. This fields has been replaced by the Credentialing tables. 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.

accepts_Plan_Fees
required
boolean

No longer in use. This fields has been replaced by the Credentialing tables.

accepts_Withhold
required
boolean

No longer in use. This fields has been replaced by the Credentialing tables. 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.

active
required
boolean

Indicates whether the Provider is active. 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.

address
string or null <= 90 characters

Street address of the rendering location.

address2
string or null <= 128 characters

Address line 2 for the Provider entity.

advice_To_Pay
required
boolean

When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. 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.

after_Hours_Procedures
string or null

No longer in use. This fields has been replaced by the Credentialing tables.

alternate_ID
string or null <= 20 characters

Alternate identifier for the selected Provider.

blid
string or null <= 64 characters

BaseLoad Key for this Service Provider location.

birth_Date
string or null <date-time>

Provider's date of birth. (Not required if Entity is non-Person)

birth_Place
string or null <= 50 characters

Provider's place of birth. (If the entity is a Person)

board_Certification
string or null

No longer in use. This fields has been replaced by the Credentialing tables.

city
string or null <= 30 characters

City of the rendering location.

communication_Method
string or null <= 16 characters

Indicates the Provider's preferred method of communication.

country_ID
string or null <= 8 characters

Country code associated with the Provider entity.

county_Code
string or null <= 8 characters

County code associated with the Provider entity.

deA_Number
string or null <= 20 characters

No longer in use. This fields has been replaced by the Credentialing tables.

discount_Percent
number or null <double>

This option adjusts the 'Allowed Amount' above (positive values) or below (negative values) the 'Billed Amount' by the entered percentage.

education
string or null

Educational background of the Provider. (If the entity is a Person)

effective_Date
string or null <date-time>

Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.

email_Address
string or null <= 128 characters

Email address of the Provider entity.

emergency_Country_Code
string or null <= 8 characters

Country code of the emergency phone number associated with the Provider entity.

emergency_Phone
string or null <= 20 characters

Emergency phone number of the Provider.

entity_ID
string or null <= 1 characters

Unique identifier assigned to the Provider entity.

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.

ethnicity_Code
string or null <= 1 characters

Identifies the type of individual Provider or Provider entity.

expiration_Date
string or null <date-time>

Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.

fax_Country_Code
string or null <= 8 characters

Country code of the fax number associated with the Provider entity.

fax_Number
string or null <= 20 characters

Fax number associated with the Provider's rendering location.

fax_Opt_Out
required
boolean

Indicates that the Provider is opted out of fax communication. 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.

federal_ID
string or null <= 20 characters

Provider's federal tax identification number.

first_Name
string or null <= 30 characters

First name of the Provider. (Not required if Entity is non-Person)

handicap_Access
required
boolean

Indicates whether the Provider facilities have handicap accessibility. 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.

home_Address
string or null <= 90 characters

Home address of the Provider. (If the entity is a Person)

home_City
string or null <= 30 characters

City of the home address of the Provider. (If the entity is a Person)

home_Country_Code
string or null <= 8 characters

Country code of the home phone number associated with the Provider entity.

home_Country_ID
string or null <= 8 characters

Country indicator for Provider home address.

home_Phone
string or null <= 20 characters

Home phone number of the Provider.

home_State
string or null <= 10 characters

State of the home address of the Provider. (If the entity is a Person)

home_Zip_Code
string or null <= 32 characters

Zip Code of the Provider's home address.

hours
string or null

Hours of operation for the Provider.

ivR_Code
string or null <= 10 characters

This field is sometimes used to track an IVR Code for the providers IVR system.

initial_Cred_Date
string or null <date-time>

No longer in use. This fields has been replaced by the Credentialing tables.

ins_Agent
string or null <= 50 characters

No longer in use. This fields has been replaced by the Credentialing tables.

ins_Carrier
string or null <= 50 characters

No longer in use. This fields has been replaced by the Credentialing tables.

ins_Coverage_Amt
string or null <= 50 characters

No longer in use. This fields has been replaced by the Credentialing tables.

ins_Expiration_Date
string or null <date-time>

No longer in use. This fields has been replaced by the Credentialing tables.

ins_Policy_Number
string or null <= 25 characters

No longer in use. This fields has been replaced by the Credentialing tables.

languages
string or null

Lists the languages that able to be spoken/translated at the facility.

last_Name
string or null <= 30 characters

Last name of the Provider. (Not required if Entity is non-Person)

latitude
number or null <double>

Latitudinal coordinate of the Provider entity's location.

license_Number
string or null <= 20 characters

No longer in use. This fields has been replaced by the Credentialing tables.

longitude
number or null <double>

Longitudinal coordinate of the Provider entity's location.

malp_Aggregate_Limit
integer or null <int32>

No longer in use. This fields has been replaced by the Credentialing tables.

malp_Carrier_ID
string or null <= 20 characters

No longer in use. This fields has been replaced by the Credentialing tables.

malp_Exp_Date
string or null <date-time>

No longer in use. This fields has been replaced by the Credentialing tables.

malp_Policys
string or null <= 200 characters

No longer in use. This fields has been replaced by the Credentialing tables.

malp_Specific_Limit
integer or null <int32>

No longer in use. This fields has been replaced by the Credentialing tables.

medicaid_ID
string or null <= 20 characters

Unique Medicaid identifier associated with the Provider.

medicare_Cert_ID
string or null <= 20 characters

No longer in use. This fields has been replaced by the Credentialing tables.

middle_Name
string or null <= 20 characters

Middle initial of the Provider.

nitrous_Oxide
required
boolean

Indicates whether the Provider facilities have nitrous oxide available for patients. 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.

no_Pends_On_Remit
string or null <= 1 characters

When this option is selected, the Provider remit will not include pends. This only works if a custom report is designed to use this option.

notes
string or null

No longer in use. Replaced by the NoteData, NoteSource and NoteReference tables.

oshA_Procedures
string or null

No longer in use. This fields has been replaced by the Credentialing tables.

office_Manager
string or null <= 50 characters

Name of the Provider's Office Manager.

org_Name
string or null <= 512 characters

Organization that the Provider belongs to.

other_Name
string or null <= 96 characters

Any other names that the Provider uses.

pend_Ex_Code
string or null <= 6 characters

Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.

pend_Flag
string or null <= 1 characters

Indicates whether an Ex Code should be applied to claims that involve payments to the selected Provider.

phone_Country_Code
string or null <= 8 characters

Country code of the phone number associated with the Provider entity.

phone_Number
string or null <= 20 characters

Phone number associated with the Provider's rendering location.

plan_Provider
required
boolean

This is an information field used for custom reporting.

practice_Type
string or null <= 16 characters

Defines the type of the selected Provider.

print_Auth
required
boolean

This is an information field used for custom reporting.

provider_Type
string or null <= 10 characters

Identifies the type of individual Provider or Provider entity.

require_Fee_Sched
string or null <= 1 characters

This is an information field used for custom reporting.

sex
string or null <= 1 characters

Biological sex of the Provider.

soc_Sec_Number
string or null <= 10 characters

Social Security Number of the Provider.

sole_Proprietor
required
boolean

No longer in use. This fields has been replaced by the Credentialing tables. 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.

specialties
string or null <= 50 characters

Specialty/Specialties of the individual Provider/entity.

state
string or null <= 10 characters

State of the rendering location.

suffix
string or null <= 20 characters

Suffix associated with the Provider.

upiN_Number
string or null <= 20 characters

This is an information field used for custom reporting.

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.

use_Procedure_Code
required
boolean

When this option is selected, adjudication will error any of this Provider's claims that contain revenue codes. 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.

website
string or null <= 128 characters

Website of the Provider entity.

years_Practiced
integer or null <int32>

Number of years that the Provider has been practicing.

zip_Code
string or null <= 32 characters

Zip Code of the Provider's rendering location.

Responses
200

Success

401

Unauthorized

post/providers
Request samples
{
  • "provider_ID": "string",
  • "accepting_Age_From": 0,
  • "accepting_Age_Thru": 0,
  • "accepting_Patients": true,
  • "accepts_Capitation": true,
  • "accepts_Plan_Fees": true,
  • "accepts_Withhold": true,
  • "active": true,
  • "address": "string",
  • "address2": "string",
  • "advice_To_Pay": true,
  • "after_Hours_Procedures": "string",
  • "alternate_ID": "string",
  • "blid": "string",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "birth_Place": "string",
  • "board_Certification": "string",
  • "city": "string",
  • "communication_Method": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "deA_Number": "string",
  • "discount_Percent": 0.1,
  • "education": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "email_Address": "string",
  • "emergency_Country_Code": "string",
  • "emergency_Phone": "string",
  • "entity_ID": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ethnicity_Code": "s",
  • "expiration_Date": "2019-08-24T14:15:22Z",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "fax_Opt_Out": true,
  • "federal_ID": "string",
  • "first_Name": "string",
  • "handicap_Access": true,
  • "home_Address": "string",
  • "home_City": "string",
  • "home_Country_Code": "string",
  • "home_Country_ID": "string",
  • "home_Phone": "string",
  • "home_State": "string",
  • "home_Zip_Code": "string",
  • "hours": "string",
  • "ivR_Code": "string",
  • "initial_Cred_Date": "2019-08-24T14:15:22Z",
  • "ins_Agent": "string",
  • "ins_Carrier": "string",
  • "ins_Coverage_Amt": "string",
  • "ins_Expiration_Date": "2019-08-24T14:15:22Z",
  • "ins_Policy_Number": "string",
  • "languages": "string",
  • "last_Name": "string",
  • "latitude": 0.1,
  • "license_Number": "string",
  • "longitude": 0.1,
  • "malp_Aggregate_Limit": 0,
  • "malp_Carrier_ID": "string",
  • "malp_Exp_Date": "2019-08-24T14:15:22Z",
  • "malp_Policys": "string",
  • "malp_Specific_Limit": 0,
  • "medicaid_ID": "string",
  • "medicare_Cert_ID": "string",
  • "middle_Name": "string",
  • "nitrous_Oxide": true,
  • "no_Pends_On_Remit": "s",
  • "notes": "string",
  • "oshA_Procedures": "string",
  • "office_Manager": "string",
  • "org_Name": "string",
  • "other_Name": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "plan_Provider": true,
  • "practice_Type": "string",
  • "print_Auth": true,
  • "provider_Type": "string",
  • "require_Fee_Sched": "s",
  • "sex": "s",
  • "soc_Sec_Number": "string",
  • "sole_Proprietor": true,
  • "specialties": "string",
  • "state": "string",
  • "suffix": "string",
  • "upiN_Number": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Procedure_Code": true,
  • "website": "string",
  • "years_Practiced": 0,
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Provider

Lists all Provider

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/providers
Request samples 
Response samples 
No sample
Get Provider
Gets Provider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}
Request samples 
Response samples 
No sample
Update Provider
Updates a specific Provider.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
provider_ID
string or null  <= 20 characters 
Unique idenfitier assigned to the Proivider record.


 
accepting_Age_From
integer or null <int32> 
Beginning of the range of accepted patient ages.


 
accepting_Age_Thru
integer or null <int32> 
End of the range of accepted patient ages.


 
accepting_Patients
required
boolean
Indicates whether the selected Provider is accepting new patients.  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.


 
accepts_Capitation
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
accepts_Plan_Fees
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.


 
accepts_Withhold
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
active
required
boolean
Indicates whether the Provider is active.  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.


 
address
string or null  <= 90 characters 
Street address of the rendering location.


 
address2
string or null  <= 128 characters 
Address line 2 for the Provider entity.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed.  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.


 
after_Hours_Procedures
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
alternate_ID
string or null  <= 20 characters 
Alternate identifier for the selected Provider.


 
blid
string or null  <= 64 characters 
BaseLoad Key for this Service Provider location.


 
birth_Date
string or null <date-time> 
Provider's date of birth. (Not required if Entity is non-Person)


 
birth_Place
string or null  <= 50 characters 
Provider's place of birth. (If the entity is a Person)


 
board_Certification
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
city
string or null  <= 30 characters 
City of the rendering location.


 
communication_Method
string or null  <= 16 characters 
Indicates the Provider's preferred method of communication.


 
country_ID
string or null  <= 8 characters 
Country code associated with the Provider entity.


 
county_Code
string or null  <= 8 characters 
County code associated with the Provider entity.


 
deA_Number
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
discount_Percent
number or null <double> 
This option adjusts the 'Allowed Amount' above (positive values) or below (negative values) the 'Billed Amount' by the entered percentage.


 
education
string or null
Educational background of the Provider. (If the entity is a Person)


 
effective_Date
string or null <date-time> 
Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.


 
email_Address
string or null  <= 128 characters 
Email address of the Provider entity.


 
emergency_Country_Code
string or null  <= 8 characters 
Country code of the emergency phone number associated with the Provider entity.


 
emergency_Phone
string or null  <= 20 characters 
Emergency phone number of the Provider.


 
entity_ID
string or null  <= 1 characters 
Unique identifier assigned to the Provider entity.


 
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.


 
ethnicity_Code
string or null  <= 1 characters 
Identifies the type of individual Provider or Provider entity.


 
expiration_Date
string or null <date-time> 
Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the fax number associated with the Provider entity.


 
fax_Number
string or null  <= 20 characters 
Fax number associated with the Provider's rendering location.


 
fax_Opt_Out
required
boolean
Indicates that the Provider is opted out of fax communication.  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.


 
federal_ID
string or null  <= 20 characters 
Provider's federal tax identification number.


 
first_Name
string or null  <= 30 characters 
First name of the Provider. (Not required if Entity is non-Person)


 
handicap_Access
required
boolean
Indicates whether the Provider facilities have handicap accessibility.  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.


 
home_Address
string or null  <= 90 characters 
Home address of the Provider. (If the entity is a Person)


 
home_City
string or null  <= 30 characters 
City of the home address of the Provider. (If the entity is a Person)


 
home_Country_Code
string or null  <= 8 characters 
Country code of the home phone number associated with the Provider entity.


 
home_Country_ID
string or null  <= 8 characters 
Country indicator for Provider home address.


 
home_Phone
string or null  <= 20 characters 
Home phone number of the Provider.


 
home_State
string or null  <= 10 characters 
State of the home address of the Provider. (If the entity is a Person)


 
home_Zip_Code
string or null  <= 32 characters 
Zip Code of the Provider's home address.


 
hours
string or null
Hours of operation for the Provider.


 
ivR_Code
string or null  <= 10 characters 
This field is sometimes used to track an IVR Code for the providers IVR system.


 
initial_Cred_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Agent
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Carrier
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Coverage_Amt
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Expiration_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Policy_Number
string or null  <= 25 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
languages
string or null
Lists the languages that able to be spoken/translated at the facility.


 
last_Name
string or null  <= 30 characters 
Last name of the Provider. (Not required if Entity is non-Person)


 
latitude
number or null <double> 
Latitudinal coordinate of the Provider entity's location.


 
license_Number
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
longitude
number or null <double> 
Longitudinal coordinate of the Provider entity's location.


 
malp_Aggregate_Limit
integer or null <int32> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Carrier_ID
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Exp_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Policys
string or null  <= 200 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Specific_Limit
integer or null <int32> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
medicaid_ID
string or null  <= 20 characters 
Unique Medicaid identifier associated with the Provider.


 
medicare_Cert_ID
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
middle_Name
string or null  <= 20 characters 
Middle initial of the Provider.


 
nitrous_Oxide
required
boolean
Indicates whether the Provider facilities have nitrous oxide available for patients.  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.


 
no_Pends_On_Remit
string or null  <= 1 characters 
When this option is selected, the Provider remit will not include pends. This only works if a custom report is designed to use this option.


 
notes
string or null
No longer in use. Replaced by the NoteData, NoteSource and NoteReference tables.


 
oshA_Procedures
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
office_Manager
string or null  <= 50 characters 
Name of the Provider's Office Manager.


 
org_Name
string or null  <= 512 characters 
Organization that the Provider belongs to.


 
other_Name
string or null  <= 96 characters 
Any other names that the Provider uses.


 
pend_Ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.


 
pend_Flag
string or null  <= 1 characters 
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Provider.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the phone number associated with the Provider entity.


 
phone_Number
string or null  <= 20 characters 
Phone number associated with the Provider's rendering location.


 
plan_Provider
required
boolean
This is an information field used for custom reporting.


 
practice_Type
string or null  <= 16 characters 
Defines the type of the selected Provider.


 
print_Auth
required
boolean
This is an information field used for custom reporting.


 
provider_Type
string or null  <= 10 characters 
Identifies the type of individual Provider or Provider entity.


 
require_Fee_Sched
string or null  <= 1 characters 
This is an information field used for custom reporting.


 
sex
string or null  <= 1 characters 
Biological sex of the Provider.


 
soc_Sec_Number
string or null  <= 10 characters 
Social Security Number of the Provider.


 
sole_Proprietor
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
specialties
string or null  <= 50 characters 
Specialty/Specialties of the individual Provider/entity.


 
state
string or null  <= 10 characters 
State of the rendering location.


 
suffix
string or null  <= 20 characters 
Suffix associated with the Provider.


 
upiN_Number
string or null  <= 20 characters 
This is an information field used for custom reporting.


 
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.


 
use_Procedure_Code
required
boolean
When this option is selected, adjudication will error any of this Provider's claims that contain revenue codes.  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.


 
website
string or null  <= 128 characters 
Website of the Provider entity.


 
years_Practiced
integer or null <int32> 
Number of years that the Provider has been practicing.


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Provider's rendering location.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}
Request samples 
{
  • "provider_ID": "string",
  • "accepting_Age_From": 0,
  • "accepting_Age_Thru": 0,
  • "accepting_Patients": true,
  • "accepts_Capitation": true,
  • "accepts_Plan_Fees": true,
  • "accepts_Withhold": true,
  • "active": true,
  • "address": "string",
  • "address2": "string",
  • "advice_To_Pay": true,
  • "after_Hours_Procedures": "string",
  • "alternate_ID": "string",
  • "blid": "string",
  • "birth_Date": "2019-08-24T14:15:22Z",
  • "birth_Place": "string",
  • "board_Certification": "string",
  • "city": "string",
  • "communication_Method": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "deA_Number": "string",
  • "discount_Percent": 0.1,
  • "education": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "email_Address": "string",
  • "emergency_Country_Code": "string",
  • "emergency_Phone": "string",
  • "entity_ID": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ethnicity_Code": "s",
  • "expiration_Date": "2019-08-24T14:15:22Z",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "fax_Opt_Out": true,
  • "federal_ID": "string",
  • "first_Name": "string",
  • "handicap_Access": true,
  • "home_Address": "string",
  • "home_City": "string",
  • "home_Country_Code": "string",
  • "home_Country_ID": "string",
  • "home_Phone": "string",
  • "home_State": "string",
  • "home_Zip_Code": "string",
  • "hours": "string",
  • "ivR_Code": "string",
  • "initial_Cred_Date": "2019-08-24T14:15:22Z",
  • "ins_Agent": "string",
  • "ins_Carrier": "string",
  • "ins_Coverage_Amt": "string",
  • "ins_Expiration_Date": "2019-08-24T14:15:22Z",
  • "ins_Policy_Number": "string",
  • "languages": "string",
  • "last_Name": "string",
  • "latitude": 0.1,
  • "license_Number": "string",
  • "longitude": 0.1,
  • "malp_Aggregate_Limit": 0,
  • "malp_Carrier_ID": "string",
  • "malp_Exp_Date": "2019-08-24T14:15:22Z",
  • "malp_Policys": "string",
  • "malp_Specific_Limit": 0,
  • "medicaid_ID": "string",
  • "medicare_Cert_ID": "string",
  • "middle_Name": "string",
  • "nitrous_Oxide": true,
  • "no_Pends_On_Remit": "s",
  • "notes": "string",
  • "oshA_Procedures": "string",
  • "office_Manager": "string",
  • "org_Name": "string",
  • "other_Name": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "plan_Provider": true,
  • "practice_Type": "string",
  • "print_Auth": true,
  • "provider_Type": "string",
  • "require_Fee_Sched": "s",
  • "sex": "s",
  • "soc_Sec_Number": "string",
  • "sole_Proprietor": true,
  • "specialties": "string",
  • "state": "string",
  • "suffix": "string",
  • "upiN_Number": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Procedure_Code": true,
  • "website": "string",
  • "years_Practiced": 0,
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Provider
Deletes an Provider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}
Request samples 
Create or Update Batch Provider
Create or Update multiple Provider 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 
provider_ID
string or null  <= 20 characters 
Unique idenfitier assigned to the Proivider record.


 
accepting_Age_From
integer or null <int32> 
Beginning of the range of accepted patient ages.


 
accepting_Age_Thru
integer or null <int32> 
End of the range of accepted patient ages.


 
accepting_Patients
required
boolean
Indicates whether the selected Provider is accepting new patients.  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.


 
accepts_Capitation
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
accepts_Plan_Fees
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.


 
accepts_Withhold
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
active
required
boolean
Indicates whether the Provider is active.  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.


 
address
string or null  <= 90 characters 
Street address of the rendering location.


 
address2
string or null  <= 128 characters 
Address line 2 for the Provider entity.


 
advice_To_Pay
required
boolean
When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed.  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.


 
after_Hours_Procedures
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
alternate_ID
string or null  <= 20 characters 
Alternate identifier for the selected Provider.


 
blid
string or null  <= 64 characters 
BaseLoad Key for this Service Provider location.


 
birth_Date
string or null <date-time> 
Provider's date of birth. (Not required if Entity is non-Person)


 
birth_Place
string or null  <= 50 characters 
Provider's place of birth. (If the entity is a Person)


 
board_Certification
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
city
string or null  <= 30 characters 
City of the rendering location.


 
communication_Method
string or null  <= 16 characters 
Indicates the Provider's preferred method of communication.


 
country_ID
string or null  <= 8 characters 
Country code associated with the Provider entity.


 
county_Code
string or null  <= 8 characters 
County code associated with the Provider entity.


 
deA_Number
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
discount_Percent
number or null <double> 
This option adjusts the 'Allowed Amount' above (positive values) or below (negative values) the 'Billed Amount' by the entered percentage.


 
education
string or null
Educational background of the Provider. (If the entity is a Person)


 
effective_Date
string or null <date-time> 
Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.


 
email_Address
string or null  <= 128 characters 
Email address of the Provider entity.


 
emergency_Country_Code
string or null  <= 8 characters 
Country code of the emergency phone number associated with the Provider entity.


 
emergency_Phone
string or null  <= 20 characters 
Emergency phone number of the Provider.


 
entity_ID
string or null  <= 1 characters 
Unique identifier assigned to the Provider entity.


 
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.


 
ethnicity_Code
string or null  <= 1 characters 
Identifies the type of individual Provider or Provider entity.


 
expiration_Date
string or null <date-time> 
Indicates the effectiveness of this provider at this service location. Independent of Network effectiveness.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the fax number associated with the Provider entity.


 
fax_Number
string or null  <= 20 characters 
Fax number associated with the Provider's rendering location.


 
fax_Opt_Out
required
boolean
Indicates that the Provider is opted out of fax communication.  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.


 
federal_ID
string or null  <= 20 characters 
Provider's federal tax identification number.


 
first_Name
string or null  <= 30 characters 
First name of the Provider. (Not required if Entity is non-Person)


 
handicap_Access
required
boolean
Indicates whether the Provider facilities have handicap accessibility.  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.


 
home_Address
string or null  <= 90 characters 
Home address of the Provider. (If the entity is a Person)


 
home_City
string or null  <= 30 characters 
City of the home address of the Provider. (If the entity is a Person)


 
home_Country_Code
string or null  <= 8 characters 
Country code of the home phone number associated with the Provider entity.


 
home_Country_ID
string or null  <= 8 characters 
Country indicator for Provider home address.


 
home_Phone
string or null  <= 20 characters 
Home phone number of the Provider.


 
home_State
string or null  <= 10 characters 
State of the home address of the Provider. (If the entity is a Person)


 
home_Zip_Code
string or null  <= 32 characters 
Zip Code of the Provider's home address.


 
hours
string or null
Hours of operation for the Provider.


 
ivR_Code
string or null  <= 10 characters 
This field is sometimes used to track an IVR Code for the providers IVR system.


 
initial_Cred_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Agent
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Carrier
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Coverage_Amt
string or null  <= 50 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Expiration_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
ins_Policy_Number
string or null  <= 25 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
languages
string or null
Lists the languages that able to be spoken/translated at the facility.


 
last_Name
string or null  <= 30 characters 
Last name of the Provider. (Not required if Entity is non-Person)


 
latitude
number or null <double> 
Latitudinal coordinate of the Provider entity's location.


 
license_Number
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
longitude
number or null <double> 
Longitudinal coordinate of the Provider entity's location.


 
malp_Aggregate_Limit
integer or null <int32> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Carrier_ID
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Exp_Date
string or null <date-time> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Policys
string or null  <= 200 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
malp_Specific_Limit
integer or null <int32> 
No longer in use. This fields has been replaced by the Credentialing tables.


 
medicaid_ID
string or null  <= 20 characters 
Unique Medicaid identifier associated with the Provider.


 
medicare_Cert_ID
string or null  <= 20 characters 
No longer in use. This fields has been replaced by the Credentialing tables.


 
middle_Name
string or null  <= 20 characters 
Middle initial of the Provider.


 
nitrous_Oxide
required
boolean
Indicates whether the Provider facilities have nitrous oxide available for patients.  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.


 
no_Pends_On_Remit
string or null  <= 1 characters 
When this option is selected, the Provider remit will not include pends. This only works if a custom report is designed to use this option.


 
notes
string or null
No longer in use. Replaced by the NoteData, NoteSource and NoteReference tables.


 
oshA_Procedures
string or null
No longer in use. This fields has been replaced by the Credentialing tables.


 
office_Manager
string or null  <= 50 characters 
Name of the Provider's Office Manager.


 
org_Name
string or null  <= 512 characters 
Organization that the Provider belongs to.


 
other_Name
string or null  <= 96 characters 
Any other names that the Provider uses.


 
pend_Ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that should be applied when the 'Apply Ex Code' option is selected.


 
pend_Flag
string or null  <= 1 characters 
Indicates whether an Ex Code should be applied to claims that involve payments to the selected Provider.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the phone number associated with the Provider entity.


 
phone_Number
string or null  <= 20 characters 
Phone number associated with the Provider's rendering location.


 
plan_Provider
required
boolean
This is an information field used for custom reporting.


 
practice_Type
string or null  <= 16 characters 
Defines the type of the selected Provider.


 
print_Auth
required
boolean
This is an information field used for custom reporting.


 
provider_Type
string or null  <= 10 characters 
Identifies the type of individual Provider or Provider entity.


 
require_Fee_Sched
string or null  <= 1 characters 
This is an information field used for custom reporting.


 
sex
string or null  <= 1 characters 
Biological sex of the Provider.


 
soc_Sec_Number
string or null  <= 10 characters 
Social Security Number of the Provider.


 
sole_Proprietor
required
boolean
No longer in use. This fields has been replaced by the Credentialing tables.  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.


 
specialties
string or null  <= 50 characters 
Specialty/Specialties of the individual Provider/entity.


 
state
string or null  <= 10 characters 
State of the rendering location.


 
suffix
string or null  <= 20 characters 
Suffix associated with the Provider.


 
upiN_Number
string or null  <= 20 characters 
This is an information field used for custom reporting.


 
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.


 
use_Procedure_Code
required
boolean
When this option is selected, adjudication will error any of this Provider's claims that contain revenue codes.  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.


 
website
string or null  <= 128 characters 
Website of the Provider entity.


 
years_Practiced
integer or null <int32> 
Number of years that the Provider has been practicing.


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Provider's rendering location.


 
Responses 
207
Success


401
Unauthorized


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