Provider Credentialing

Create ProviderCred

Creates a new ProviderCred

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

Unique identifier assigned to this credentialing process. Note: This field is marked as NOT NULL in the database and therefore required by the API.

application_Start_Date
string or null <date-time>

The date the application for this credentialing process based on the CredType.

committee_Date
string or null <date-time>

Date when the Committee approved the credential.

credType_Key
required
integer <int32>

Identifies the type of credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.

cred_Organization
string or null <= 512 characters

Indicates the organization through which the Provider was credentialed.

cred_Status
string or null <= 16 characters

Indicates the status of the credentialing. These status options are configured from 'Credential Status' within 'Credentialing Congifuration'.

effective_Date
required
string <date-time>

Date when the credentialing status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

practice_Payee_ID
string or null <= 20 characters

The Payee that is associated with the Provider's credential.

practice_Send_Check_To
string or null <= 8 characters

Indicates where checks should be sent. This is often to the Provider themselves or to their practice.

practice_Send_Check_To_Address
string or null <= 20 characters

Allows the User to select from the available practice addresses if 'Practice' is selected from the 'Send Check To' option.

provider_Bio
string or null <= 1024 characters

Free form entry of a provider bio for the provider directory on VBAGateway.

provider_ID
required
string [ 1 .. 20 ] characters

Provider assigned to this credentialing process.

specialty_Code
string or null <= 10 characters

Identifies the specialty that is associated with the Provider's credential.

term_Date
string or null <date-time>

Date when the credentialing status expires/expired.

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.

Responses
200

Success

401

Unauthorized

post/providers/{providerID}/credentialing
Request samples
{
  • "providerCred_Key": 0,
  • "application_Start_Date": "2019-08-24T14:15:22Z",
  • "committee_Date": "2019-08-24T14:15:22Z",
  • "credType_Key": 0,
  • "cred_Organization": "string",
  • "cred_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "practice_Payee_ID": "string",
  • "practice_Send_Check_To": "string",
  • "practice_Send_Check_To_Address": "string",
  • "provider_Bio": "string",
  • "provider_ID": "string",
  • "specialty_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCred

Lists all ProviderCred for the given providerID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

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/{providerID}/credentialing
Request samples 
Response samples 
No sample
Get ProviderCred
Gets ProviderCred


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerCredKey
required
integer <int32> 
ProviderCred Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerCredKey
required
integer <int32> 
ProviderCred Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerCred_Key
required
integer <int32> 
Unique identifier assigned to this credentialing process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
application_Start_Date
string or null <date-time> 
The date the application for this credentialing process based on the CredType.


 
committee_Date
string or null <date-time> 
Date when the Committee approved the credential.


 
credType_Key
required
integer <int32> 
Identifies the type of credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cred_Organization
string or null  <= 512 characters 
Indicates the organization through which the Provider was credentialed.


 
cred_Status
string or null  <= 16 characters 
Indicates the status of the credentialing. These status options are configured from 'Credential Status' within 'Credentialing Congifuration'.


 
effective_Date
required
string <date-time> 
Date when the credentialing status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
practice_Payee_ID
string or null  <= 20 characters 
The Payee that is associated with the Provider's credential.


 
practice_Send_Check_To
string or null  <= 8 characters 
Indicates where checks should be sent. This is often to the Provider themselves or to their practice.


 
practice_Send_Check_To_Address
string or null  <= 20 characters 
Allows the User to select from the available practice addresses if 'Practice' is selected from the 'Send Check To' option.


 
provider_Bio
string or null  <= 1024 characters 
Free form entry of a provider bio for the provider directory on VBAGateway.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Provider assigned to this credentialing process.


 
specialty_Code
string or null  <= 10 characters 
Identifies the specialty that is associated with the Provider's credential.


 
term_Date
string or null <date-time> 
Date when the credentialing status expires/expired.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}/credentialing/{providerCredKey}
Request samples 
{
  • "providerCred_Key": 0,
  • "application_Start_Date": "2019-08-24T14:15:22Z",
  • "committee_Date": "2019-08-24T14:15:22Z",
  • "credType_Key": 0,
  • "cred_Organization": "string",
  • "cred_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "practice_Payee_ID": "string",
  • "practice_Send_Check_To": "string",
  • "practice_Send_Check_To_Address": "string",
  • "provider_Bio": "string",
  • "provider_ID": "string",
  • "specialty_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCred
Deletes an ProviderCred


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerCredKey
required
integer <int32> 
ProviderCred Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/credentialing/{providerCredKey}
Request samples 
Create or Update Batch ProviderCred
Create or Update multiple ProviderCred at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerCred_Key
required
integer <int32> 
Unique identifier assigned to this credentialing process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
application_Start_Date
string or null <date-time> 
The date the application for this credentialing process based on the CredType.


 
committee_Date
string or null <date-time> 
Date when the Committee approved the credential.


 
credType_Key
required
integer <int32> 
Identifies the type of credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cred_Organization
string or null  <= 512 characters 
Indicates the organization through which the Provider was credentialed.


 
cred_Status
string or null  <= 16 characters 
Indicates the status of the credentialing. These status options are configured from 'Credential Status' within 'Credentialing Congifuration'.


 
effective_Date
required
string <date-time> 
Date when the credentialing status becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
practice_Payee_ID
string or null  <= 20 characters 
The Payee that is associated with the Provider's credential.


 
practice_Send_Check_To
string or null  <= 8 characters 
Indicates where checks should be sent. This is often to the Provider themselves or to their practice.


 
practice_Send_Check_To_Address
string or null  <= 20 characters 
Allows the User to select from the available practice addresses if 'Practice' is selected from the 'Send Check To' option.


 
provider_Bio
string or null  <= 1024 characters 
Free form entry of a provider bio for the provider directory on VBAGateway.


 
provider_ID
required
string  [ 1 .. 20 ] characters 
Provider assigned to this credentialing process.


 
specialty_Code
string or null  <= 10 characters 
Identifies the specialty that is associated with the Provider's credential.


 
term_Date
string or null <date-time> 
Date when the credentialing status expires/expired.


 
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.


 
Responses 
207
Success


401
Unauthorized


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