Grievances

Create Grievance

Creates a new Grievance

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
grievance_Key
required
integer <int32>

ID number of the grievance. Note: This field is marked as NOT NULL in the database and therefore required by the API.

admin_Change
string or null <= 4096 characters

Area where the User may describe the administrative change.

admin_Change_Date
string or null <date-time>

Date when the administrative change took place.

admin_Change_Type
string or null <= 32 characters

Type of change that was made by Administration. 'Admin. Change Types' are configured within 'Grievance Configuration'.

call_Key
integer or null <int32>

ID of the call from which the grievance was submitted.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

grievance_Category
string or null <= 32 characters

Category of the grievance. 'Greivance Categories' are configured within 'Grievance Configuration'.

grievance_Filed
string or null <date-time>

Date when the grievance was viewed and filed by an Administartor.

grievance_Received
string or null <date-time>

Date when the grievance was submitted.

grievance_Resolved
string or null <date-time>

Date when the grievance was resolved.

grievance_Source
string or null <= 16 characters

ID of the source of the grievance.

grievance_Status
string or null <= 32 characters

Status of the grievance. 'Greivance Statuses' are configured within 'Grievance Configuration'.

grievance_Type
string or null <= 32 characters

Type of the grievance. 'Grievance Types' are configured within 'Grievance Configuration'.

issue
string or null <= 4096 characters

Area where the User may describe the issue.

issue_Date
string or null <date-time>

Date when the issue occurred.

issue_Type
string or null <= 32 characters

Type of issue the grievance is associated with. 'Issue Types' are configured within 'Grievance Configuration'.

member_Seq
string or null <= 2 characters

Sequential identifier of the Member associated with the grievance.

patient_Account_Number
string or null <= 64 characters

Account number of the Patient associated with the grievance.

provider_ID
string or null <= 20 characters

ID of the Provider associated with the grievance.

resolution
string or null <= 4096 characters

Area where the User may describe the resolution.

resolution_Date
string or null <date-time>

Date when the resolution was implemented.

resolution_Type
string or null <= 32 characters

Type of resolution used to address the grievance. 'Resolution Types' are configured within 'Grievance Configuration'.

subscriber_ID
string or null <= 9 characters

Unique system assigned number for the Subscriber

update_Date
string <date-time>

Date 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/grievances
Request samples
{
  • "grievance_Key": 0,
  • "admin_Change": "string",
  • "admin_Change_Date": "2019-08-24T14:15:22Z",
  • "admin_Change_Type": "string",
  • "call_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "grievance_Category": "string",
  • "grievance_Filed": "2019-08-24T14:15:22Z",
  • "grievance_Received": "2019-08-24T14:15:22Z",
  • "grievance_Resolved": "2019-08-24T14:15:22Z",
  • "grievance_Source": "string",
  • "grievance_Status": "string",
  • "grievance_Type": "string",
  • "issue": "string",
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_Type": "string",
  • "member_Seq": "st",
  • "patient_Account_Number": "string",
  • "provider_ID": "string",
  • "resolution": "string",
  • "resolution_Date": "2019-08-24T14:15:22Z",
  • "resolution_Type": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Grievance

Lists all Grievance

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
grievanceKey
required
integer <int32> 
Grievance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/grievances/{grievanceKey}
Request samples 
Response samples 
No sample
Update Grievance
Updates a specific Grievance.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
grievanceKey
required
integer <int32> 
Grievance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
grievance_Key
required
integer <int32> 
ID number of the grievance. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
admin_Change
string or null  <= 4096 characters 
Area where the User may describe the administrative change.


 
admin_Change_Date
string or null <date-time> 
Date when the administrative change took place.


 
admin_Change_Type
string or null  <= 32 characters 
Type of change that was made by Administration. 'Admin. Change Types' are configured within 'Grievance Configuration'.


 
call_Key
integer or null <int32> 
ID of the call from which the grievance was submitted.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
grievance_Category
string or null  <= 32 characters 
Category of the grievance. 'Greivance Categories' are configured within 'Grievance Configuration'.


 
grievance_Filed
string or null <date-time> 
Date when the grievance was viewed and filed by an Administartor.


 
grievance_Received
string or null <date-time> 
Date when the grievance was submitted.


 
grievance_Resolved
string or null <date-time> 
Date when the grievance was resolved.


 
grievance_Source
string or null  <= 16 characters 
ID of the source of the grievance.


 
grievance_Status
string or null  <= 32 characters 
Status of the grievance. 'Greivance Statuses' are configured within 'Grievance Configuration'.


 
grievance_Type
string or null  <= 32 characters 
Type of the grievance. 'Grievance Types' are configured within 'Grievance Configuration'.


 
issue
string or null  <= 4096 characters 
Area where the User may describe the issue.


 
issue_Date
string or null <date-time> 
Date when the issue occurred.


 
issue_Type
string or null  <= 32 characters 
Type of issue the grievance is associated with. 'Issue Types' are configured within 'Grievance Configuration'.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier of the Member associated with the grievance.


 
patient_Account_Number
string or null  <= 64 characters 
Account number of the Patient associated with the grievance.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the grievance.


 
resolution
string or null  <= 4096 characters 
Area where the User may describe the resolution.


 
resolution_Date
string or null <date-time> 
Date when the resolution was implemented.


 
resolution_Type
string or null  <= 32 characters 
Type of resolution used to address the grievance. 'Resolution Types' are configured within 'Grievance Configuration'.


 
subscriber_ID
string or null  <= 9 characters 
Unique system assigned number for the Subscriber


 
update_Date
string <date-time> 
Date 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/grievances/{grievanceKey}
Request samples 
{
  • "grievance_Key": 0,
  • "admin_Change": "string",
  • "admin_Change_Date": "2019-08-24T14:15:22Z",
  • "admin_Change_Type": "string",
  • "call_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "grievance_Category": "string",
  • "grievance_Filed": "2019-08-24T14:15:22Z",
  • "grievance_Received": "2019-08-24T14:15:22Z",
  • "grievance_Resolved": "2019-08-24T14:15:22Z",
  • "grievance_Source": "string",
  • "grievance_Status": "string",
  • "grievance_Type": "string",
  • "issue": "string",
  • "issue_Date": "2019-08-24T14:15:22Z",
  • "issue_Type": "string",
  • "member_Seq": "st",
  • "patient_Account_Number": "string",
  • "provider_ID": "string",
  • "resolution": "string",
  • "resolution_Date": "2019-08-24T14:15:22Z",
  • "resolution_Type": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Grievance
Deletes an Grievance


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
grievanceKey
required
integer <int32> 
Grievance Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/grievances/{grievanceKey}
Request samples 
Batch Delete Grievance
Delete a list of Grievances.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
grievance_Key
required
integer <int32> 
ID number of the grievance. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
admin_Change
string or null  <= 4096 characters 
Area where the User may describe the administrative change.


 
admin_Change_Date
string or null <date-time> 
Date when the administrative change took place.


 
admin_Change_Type
string or null  <= 32 characters 
Type of change that was made by Administration. 'Admin. Change Types' are configured within 'Grievance Configuration'.


 
call_Key
integer or null <int32> 
ID of the call from which the grievance was submitted.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
grievance_Category
string or null  <= 32 characters 
Category of the grievance. 'Greivance Categories' are configured within 'Grievance Configuration'.


 
grievance_Filed
string or null <date-time> 
Date when the grievance was viewed and filed by an Administartor.


 
grievance_Received
string or null <date-time> 
Date when the grievance was submitted.


 
grievance_Resolved
string or null <date-time> 
Date when the grievance was resolved.


 
grievance_Source
string or null  <= 16 characters 
ID of the source of the grievance.


 
grievance_Status
string or null  <= 32 characters 
Status of the grievance. 'Greivance Statuses' are configured within 'Grievance Configuration'.


 
grievance_Type
string or null  <= 32 characters 
Type of the grievance. 'Grievance Types' are configured within 'Grievance Configuration'.


 
issue
string or null  <= 4096 characters 
Area where the User may describe the issue.


 
issue_Date
string or null <date-time> 
Date when the issue occurred.


 
issue_Type
string or null  <= 32 characters 
Type of issue the grievance is associated with. 'Issue Types' are configured within 'Grievance Configuration'.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier of the Member associated with the grievance.


 
patient_Account_Number
string or null  <= 64 characters 
Account number of the Patient associated with the grievance.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the grievance.


 
resolution
string or null  <= 4096 characters 
Area where the User may describe the resolution.


 
resolution_Date
string or null <date-time> 
Date when the resolution was implemented.


 
resolution_Type
string or null  <= 32 characters 
Type of resolution used to address the grievance. 'Resolution Types' are configured within 'Grievance Configuration'.


 
subscriber_ID
string or null  <= 9 characters 
Unique system assigned number for the Subscriber


 
update_Date
string <date-time> 
Date 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 
204
Success


401
Unauthorized


delete/grievances-batch
Request samples 
[
  • {
    }
]
Create or Update Batch Grievance
Create or Update multiple Grievance 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 
grievance_Key
required
integer <int32> 
ID number of the grievance. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
admin_Change
string or null  <= 4096 characters 
Area where the User may describe the administrative change.


 
admin_Change_Date
string or null <date-time> 
Date when the administrative change took place.


 
admin_Change_Type
string or null  <= 32 characters 
Type of change that was made by Administration. 'Admin. Change Types' are configured within 'Grievance Configuration'.


 
call_Key
integer or null <int32> 
ID of the call from which the grievance was submitted.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
grievance_Category
string or null  <= 32 characters 
Category of the grievance. 'Greivance Categories' are configured within 'Grievance Configuration'.


 
grievance_Filed
string or null <date-time> 
Date when the grievance was viewed and filed by an Administartor.


 
grievance_Received
string or null <date-time> 
Date when the grievance was submitted.


 
grievance_Resolved
string or null <date-time> 
Date when the grievance was resolved.


 
grievance_Source
string or null  <= 16 characters 
ID of the source of the grievance.


 
grievance_Status
string or null  <= 32 characters 
Status of the grievance. 'Greivance Statuses' are configured within 'Grievance Configuration'.


 
grievance_Type
string or null  <= 32 characters 
Type of the grievance. 'Grievance Types' are configured within 'Grievance Configuration'.


 
issue
string or null  <= 4096 characters 
Area where the User may describe the issue.


 
issue_Date
string or null <date-time> 
Date when the issue occurred.


 
issue_Type
string or null  <= 32 characters 
Type of issue the grievance is associated with. 'Issue Types' are configured within 'Grievance Configuration'.


 
member_Seq
string or null  <= 2 characters 
Sequential identifier of the Member associated with the grievance.


 
patient_Account_Number
string or null  <= 64 characters 
Account number of the Patient associated with the grievance.


 
provider_ID
string or null  <= 20 characters 
ID of the Provider associated with the grievance.


 
resolution
string or null  <= 4096 characters 
Area where the User may describe the resolution.


 
resolution_Date
string or null <date-time> 
Date when the resolution was implemented.


 
resolution_Type
string or null  <= 32 characters 
Type of resolution used to address the grievance. 'Resolution Types' are configured within 'Grievance Configuration'.


 
subscriber_ID
string or null  <= 9 characters 
Unique system assigned number for the Subscriber


 
update_Date
string <date-time> 
Date 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/grievances-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
File Grievance Advanced API 
Files a Grievance for a Member or Subscriber and gives back the created grievance for further processing.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
grievance_Source
string or null
 
subscriber_ID
string or null
 
member_Seq
string or null
 
provider_ID
string or null
 
auth_Number
string or null
 
call_Key
integer or null <int32> 
 
claim_Number
integer or null <int32> 
 
user_ID
string or null
 
Responses 
200
Success


401
Unauthorized


post/grievances-file
Request samples 
{
  • "grievance_Source": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "provider_ID": "string",
  • "auth_Number": "string",
  • "call_Key": 0,
  • "claim_Number": 0,
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}