Payer Concierge Rest API Documentation
Get Payer Concierge Payers
URL: http://eligibility.revx.technology:8082/api/v1/permissions/payers
Send using AuthenticationRequest
Response format
| Parameter | Description | Data Type |
| payers | List of all payers available for Payer Concierge | List<Payer> |
| AuthenticationResponse | See Authentication Response for more details | AuthenticationResponse |
Example:
http://eligibility.revx.technology:8082/api/v1/permissions/payers
Request
{
“authenticationRequest”: {
“userName”: <USERNAME>,
“password”: <PASSWORD>,
“token”: null,
“version”: null,
}
}
Response
{
“payers”: [
{
“payerId”: 10062,
“payerName”: Cigna,
},
{
“payerId”: 10002,
“payerName”: United Healthcare,
},
{
“payerId”: 33600,
“payerName”: Liberty Mutual,
},
{
“payerId”: 10051,
“payerName”: Blue Cross of California (Anthem),
},
{
“payerId”: 10004,
“payerName”: Aetna,
}
],
“authenticationResponse”: {
“isAuthenticated”: true,
“token”: “3f1f2b42-56d0-4b88-98c2-b59441a6094c”,
“errorCode”: null,
“errorMessage”: null,
}
}
Get Next Available Appointment
Request Format
| Parameter | Description | Data Type |
| payerID | Five character id for the payer | string |
| AuthenticationRequest | See Authentication Request for more details | AuthenticationRequest |
Response Format
| Parameter | Description | Data Type |
| nextAvailableAppointment | This is a timespan, which you can add to current local time to get the next available appointment time. It is recommended that you check this once a minute as some payers have frequent changes. | hh:mm:ss |
| AuthenticationResponse | See Authentication Response for more details | AuthenticationResponse |
Example:
Request
{
“payerId”: 10004,
“authenticationRequest”: {
“userName”: <USERNAME>,
“password”: <PASSWORD>,
“token”: null,
“version”: null,
}
}
Response
{
“nextAvailableAppointment”: 00:03:31,
“authenticationResponse”: {
“isAuthenticated”: true,
“token”: “3f1f2b42-56d0-4b88-98c2-b59441a6094c”,
“errorCode”: null,
“errorMessage”: null,
}
}
Schedule An Appointment
URL: https://eligibility.revx.technology:8082/api/v1/calls/queue
Request Format
| Parameter | Description | Data Type |
| callType | Test, Real, ClaimRecord | enum |
| payerID | Five character id for the payer | string |
| redirectPhone | “+1” and callback phone number | string |
| aniDigits | You will receive back these numbers when we call you. It must start with a 1 and be between 7 and 20 characters long | string |
| AuthenticationRequest | See Authentication Request for more details | AuthenticationRequest |
Response format
| Parameter | Description | Data Type |
| callID | Guid | |
| AuthenticationResponse | See Authentication Response for more details | AuthenticationResponse |
Example:
https://eligibility.revx.technology:8082/api/v1/calls/queue
Request
{
“call”: {
“callType”: Real,
“payerId”: 10062,
“redirectPhone”: “+13000000000”,
“aniDigits”:”117241326321″,
},
“authenticationRequest”: {
“userName”: <USERNAME>,
“password”: <PASSWORD>,
“token”: null,
“version”: null,
}
}
Response
{
“callId”: “93b8b7d8-276b-4ee6-9f6a-1c537e98e47f”,
“authenticationResponse”: {
“isAuthenticated”: true,
“token”: “3f1f2b42-56d0-4b88-98c2-b59441a6094c”,
“errorCode”: null,
“errorMessage”: null,
}
}
Get Call Details:
URL: https://eligibility.revx.technology:8082/api/v1/calls
Request Format
| Parameter | Description | Data Type |
| callID | Id for the call | Guid |
| AuthenticationRequest | See Authentication Request for more details | AuthenticationRequest |
Response format
| Parameter | Description | Data Type |
| callType | Test, Real, ClaimRecord | enum |
| status | InProgress, Done, Error, Queued
|
enum |
| ID | Id for the call | Guid |
| payerID | Five character id for the payer | string |
| payerName | Revemed’s name for the payer | string |
| payerPhoneNumber | Phone number to call payer back | string |
| queuedTimeMillis | Time that call was requested (milliseconds) | long |
| startTimeMillis | Time that call was started (milliseconds) | long |
| endTimeMillis | Time that call was disconnected (milliseconds) | long |
| finishedPromptsTimeMillis | Time that Revemed completed navigation of the IVR (milliseconds) | long |
| scheduledAppointmentTime | Time that Revemed promised call back time (milliseconds) | long |
| aniDigits | You will receive back these numbers when we call you. It must start with a 1 and be between 7 and 20 characters long | string |
| AuthenticationResponse | See Authentication Response for more details | AuthenticationResponse |
Example:
https://eligibility.revx.technology:8082/api/v1/calls
Request
{
“callId”: “93b8b7d8-276b-4ee6-9f6a-1c537e98e47f”,
“authenticationRequest”: {
“userName”: <USERNAME>,
“password”: <PASSWORD>,
“token”: null,
“version”: null,
}
}
Response
{
“callLog”: {
“type”: Real,
“status”: InProgress,
“id”: “93b8b7d8-276b-4ee6-9f6a-1c537e98e47f”,
“payerId”: 10062,
“payerName”: CIGNA-GreatWest,
“payerPhoneNumber”: “+18008824462”,
“queuedTimeMillis”: 1488540323000,
“startTimeMillis”: 1488540347000,
“endTimeMillis”: 1488540371979,
“finishedPromptsTimeMillis”: 1488540371979,
“scheduledAppointmentTime”: 1488540490000,
},
“aniDigits”:”117241326321″
“authenticationResponse”: {
“isAuthenticated”: true,
“token”: “3f1f2b42-56d0-4b88-98c2-b59441a6094c”,
“errorCode”: null,
“errorMessage”: null,
}
}
Object Models
AuthenticationRequest
Below are the parameters to be submitted with an authentication request.
| Parameter | Description | Data Type |
| userName | <USERNAME> | string |
| password | <PASSWORD> | string |
| token | Token provides temporary access to Revemed features and services without supplying password. | string |
| version | Planned future development | string |
AuthenticationResponse
| Parameter | Description | Data Type |
| isAuthenticated | Returns true when successfully authenticated. False when request was rejected. See error fields for more information | Boolean |
| token | Token provides temporary access to Revemed features and services without supplying password. | Guid |
| errorCode | Quick Code for the error | string |
| errorMessage | Full description of the error | string |
Payer
| Parameter | Description | Data Type |
| payerID | Five character id for the payer | string |
| payerName | Name of the payer | string |
This is a test