Provider Credentialing Quality

Create ProviderCredQuality

Creates a new ProviderCredQuality

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 quality 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.

credQuality_Key
required
integer <int32>

Specifies the quality item that will be scored and rated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

quality_Date
string or null <date-time>

Date when the quality was rated.

quality_Rating
integer or null <int32>

Quality rating that was given to the item.

quality_Review
string or null <= 1024 characters

Free form entry of quality and review information for this record.

quality_Score
string or null <= 10 characters

Quality score that was given to the item.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/provider-credentialing/{providerCredKey}/qualities
Request samples
{
  • "providerCred_Key": 0,
  • "credQuality_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "quality_Date": "2019-08-24T14:15:22Z",
  • "quality_Rating": 0,
  • "quality_Review": "string",
  • "quality_Score": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredQuality

Lists all ProviderCredQuality 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}/qualities
Request samples
Response samples
No sample

Get ProviderCredQuality

Gets ProviderCredQuality

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

ProviderCred Key

credQualityKey
required
integer <int32>

CredQuality Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/provider-credentialing/{providerCredKey}/qualities/{credQualityKey}
Request samples
Response samples
No sample

Update ProviderCredQuality

Updates a specific ProviderCredQuality.

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

ProviderCred Key

credQualityKey
required
integer <int32>

CredQuality Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

Associates these custom quality 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.

credQuality_Key
required
integer <int32>

Specifies the quality item that will be scored and rated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

quality_Date
string or null <date-time>

Date when the quality was rated.

quality_Rating
integer or null <int32>

Quality rating that was given to the item.

quality_Review
string or null <= 1024 characters

Free form entry of quality and review information for this record.

quality_Score
string or null <= 10 characters

Quality score that was given to the item.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

put/provider-credentialing/{providerCredKey}/qualities/{credQualityKey}
Request samples
{
  • "providerCred_Key": 0,
  • "credQuality_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "quality_Date": "2019-08-24T14:15:22Z",
  • "quality_Rating": 0,
  • "quality_Review": "string",
  • "quality_Score": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ProviderCredQuality

Deletes an ProviderCredQuality

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

ProviderCred Key

credQualityKey
required
integer <int32>

CredQuality Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/provider-credentialing/{providerCredKey}/qualities/{credQualityKey}
Request samples

Create or Update Batch ProviderCredQuality

Create or Update multiple ProviderCredQuality 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 quality 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.

credQuality_Key
required
integer <int32>

Specifies the quality item that will be scored and rated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

quality_Date
string or null <date-time>

Date when the quality was rated.

quality_Rating
integer or null <int32>

Quality rating that was given to the item.

quality_Review
string or null <= 1024 characters

Free form entry of quality and review information for this record.

quality_Score
string or null <= 10 characters

Quality score that was given to the item.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
207

Success

401

Unauthorized

put/provider-credentialing/{providerCredKey}/qualities-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}