Provider Credentialing Practices

Create ProviderCredPracticeDetail

Creates a new ProviderCredPracticeDetail

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

Associates these custom practice detail values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.

credPracticeType_Key
required
integer <int32>

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

additional_Details
string or null <= 1024 characters

Free form entry of details for this practice record.

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.

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/provider-credentialing/{providerCredKey}/practices
Request samples
{
  • "providerCred_Key": 0,
  • "credPracticeType_Key": 0,
  • "additional_Details": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredPracticeDetail

Lists all ProviderCredPracticeDetail for the given providerCredKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

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/provider-credentialing/{providerCredKey}/practices
Request samples 
Response samples 
No sample
Get ProviderCredPracticeDetail
Gets ProviderCredPracticeDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
credPracticeTypeKey
required
integer <int32> 
CredPracticeType Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/practices/{credPracticeTypeKey}
Request samples 
Response samples 
No sample
Update ProviderCredPracticeDetail
Updates a specific ProviderCredPracticeDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
credPracticeTypeKey
required
integer <int32> 
CredPracticeType Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerCred_Key
required
integer <int32> 
Associates these custom practice detail values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
additional_Details
string or null  <= 1024 characters 
Free form entry of details for this practice record.


 
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.


 
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/provider-credentialing/{providerCredKey}/practices/{credPracticeTypeKey}
Request samples 
{
  • "providerCred_Key": 0,
  • "credPracticeType_Key": 0,
  • "additional_Details": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredPracticeDetail
Deletes an ProviderCredPracticeDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
credPracticeTypeKey
required
integer <int32> 
CredPracticeType Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/practices/{credPracticeTypeKey}
Request samples 
Create or Update Batch ProviderCredPracticeDetail
Create or Update multiple ProviderCredPracticeDetail 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
providerCredKey
required
integer <int32> 
ProviderCred Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerCred_Key
required
integer <int32> 
Associates these custom practice detail values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
additional_Details
string or null  <= 1024 characters 
Free form entry of details for this practice record.


 
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.


 
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/provider-credentialing/{providerCredKey}/practices-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}