Provider Credentialing Malpractice

Create ProviderCredMalpractice

Creates a new ProviderCredMalpractice

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

credCarrier_Key
required
integer <int32>

Identifies the malpractice insurance carrier. Note: This field is marked as NOT NULL in the database and therefore required by the API.

policy_Number
required
string [ 1 .. 32 ] characters

Policy number of the malpractice insurance.

aggregate_Limit
number or null <double>

Aggregate limit of the malpractice policy.

effective_Date
string or null <date-time>

Date when the malpractice insurance becomes/became effective.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 16 characters

Date when the record was first added to the system.

occurrence_Amount
number or null <double>

Occurrence amount of the malpractice policy.

specific_Limit
number or null <double>

Specific limit of the malpractice policy.

term_Date
string or null <date-time>

Date when the malpractice insurance expires/expired.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 16 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/provider-credentialing/{providerCredKey}/malpractice
Request samples
{
  • "providerCred_Key": 0,
  • "credCarrier_Key": 0,
  • "policy_Number": "string",
  • "aggregate_Limit": 0.1,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "occurrence_Amount": 0.1,
  • "specific_Limit": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredMalpractice

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

Get ProviderCredMalpractice

Gets ProviderCredMalpractice

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

ProviderCred Key

credCarrierKey
required
integer <int32>

CredCarrier Key

policyNumber
required
string

Policy Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/provider-credentialing/{providerCredKey}/malpractice/{credCarrierKey}/{policyNumber}
Request samples
Response samples
No sample

Update ProviderCredMalpractice

Updates a specific ProviderCredMalpractice.

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

ProviderCred Key

credCarrierKey
required
integer <int32>

CredCarrier Key

policyNumber
required
string

Policy Number

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

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

credCarrier_Key
required
integer <int32>

Identifies the malpractice insurance carrier. Note: This field is marked as NOT NULL in the database and therefore required by the API.

policy_Number
required
string [ 1 .. 32 ] characters

Policy number of the malpractice insurance.

aggregate_Limit
number or null <double>

Aggregate limit of the malpractice policy.

effective_Date
string or null <date-time>

Date when the malpractice insurance becomes/became effective.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 16 characters

Date when the record was first added to the system.

occurrence_Amount
number or null <double>

Occurrence amount of the malpractice policy.

specific_Limit
number or null <double>

Specific limit of the malpractice policy.

term_Date
string or null <date-time>

Date when the malpractice insurance expires/expired.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 16 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

put/provider-credentialing/{providerCredKey}/malpractice/{credCarrierKey}/{policyNumber}
Request samples
{
  • "providerCred_Key": 0,
  • "credCarrier_Key": 0,
  • "policy_Number": "string",
  • "aggregate_Limit": 0.1,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "occurrence_Amount": 0.1,
  • "specific_Limit": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ProviderCredMalpractice

Deletes an ProviderCredMalpractice

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

ProviderCred Key

credCarrierKey
required
integer <int32>

CredCarrier Key

policyNumber
required
string

Policy Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/provider-credentialing/{providerCredKey}/malpractice/{credCarrierKey}/{policyNumber}
Request samples

Create or Update Batch ProviderCredMalpractice

Create or Update multiple ProviderCredMalpractice 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 carrier 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.

credCarrier_Key
required
integer <int32>

Identifies the malpractice insurance carrier. Note: This field is marked as NOT NULL in the database and therefore required by the API.

policy_Number
required
string [ 1 .. 32 ] characters

Policy number of the malpractice insurance.

aggregate_Limit
number or null <double>

Aggregate limit of the malpractice policy.

effective_Date
string or null <date-time>

Date when the malpractice insurance becomes/became effective.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 16 characters

Date when the record was first added to the system.

occurrence_Amount
number or null <double>

Occurrence amount of the malpractice policy.

specific_Limit
number or null <double>

Specific limit of the malpractice policy.

term_Date
string or null <date-time>

Date when the malpractice insurance expires/expired.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 16 characters

Date when the record was last updated in the system.

Responses
207

Success

401

Unauthorized

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