Tross
Demo dataBook a demo
AVAILITY

List prior auth search options

List prior authorization search options.

POSThttps://preview.ontross.com/api/integrations/availity/list-prior-auth-search-options
Request Fields
input.organization_limit
integer
Number of organizations to fetch in this single page (1–50).
Example
25
Default
25
input.organization_offset
integer
Zero-based organization page offset; pass organization_next_offset to continue.
Example
0
Default
0
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
organizations
array
One page of the signed-in user's organization choices.
organizations[].organization_id
string
Availity organization id, for reference.
Example
"123456"
organizations[].customer_id
string
Pass this value as organization_customer_id to search-prior-auths.
Example
"0001234"
organizations[].name
string
Organization label displayed by Availity.
Example
"Example Clinic"
organization_offset
integer
Offset returned by Availity for this organization page.
Example
0
organization_limit
integer
Limit returned by Availity for this organization page.
Example
25
organization_returned_count
integer
Number of organization choices in this response.
Example
2
organization_total_count
integer
Total organization choices reported by Availity.
Example
2
organization_has_more
boolean
Whether another organization page is available.
Example
false
organization_next_offset
integer
Pass as organization_offset to fetch the next organization page.
Example
25
payers
array
Unique payer choices allowed by the Authorization Dashboard permission; Availity supplies these in one permission response.
payers[].payer_id
string
Pass this value as payer_id to search-prior-auths.
Example
"00987"
payers[].name
string
Payer label displayed by Availity.
Example
"Example Health Plan"
payers[].organization_customer_ids
array
Customer IDs whose Authorization Dashboard permission includes this payer.
Example
["0001234"]
payer_count
integer
Number of unique payer choices.
Example
106
has_dashboard_permission
boolean
Whether Availity returned the Authorization Dashboard permission.
Example
true
status_options
array
Every provider dashboard status choice, its search value, and matched wire statuses.
status_options[].label
string
Status displayed by Availity.
Example
"Approved"
status_options[].value
string
Canonical value accepted in search-prior-auths statuses.
Example
"APPROVED"
status_options[].wire_values
array
Availity dashboard statuses matched by this choice.
Example
["APPROVED","EMERGENCY_ADMIT","NOT_PRIMARY_COB","COMPLETE"]
transaction_type_options
array
Every provider dashboard transaction type choice and matched patient classes.
transaction_type_options[].label
string
Transaction type displayed by Availity and accepted in search-prior-auths transaction_types.
Example
"Outpatient"
transaction_type_options[].value
string
Canonical key accepted in search-prior-auths transaction_types.
Example
"OUTPATIENT"
transaction_type_options[].wire_values
array
Availity patient classes matched by this choice.
Example
["OUTPATIENT"]
date_range_options
array
All preset date ranges accepted by search-prior-auths; custom dates use start_date and end_date.
date_range_options[].label
string
Human-readable option label.
Example
"Last 90 Days"
date_range_options[].value
string
Value accepted by search-prior-auths.
Example
"LAST_90_DAYS"
view_options
array
Dashboard tabs accepted by search-prior-auths.
view_options[].label
string
Human-readable option label.
Example
"Last 90 Days"
view_options[].value
string
Value accepted by search-prior-auths.
Example
"LAST_90_DAYS"
sort_options
array
Sort values accepted by search-prior-auths.
sort_options[].label
string
Human-readable option label.
Example
"Last 90 Days"
sort_options[].value
string
Value accepted by search-prior-auths.
Example
"LAST_90_DAYS"
page_sizes
array
Dashboard page sizes accepted by search-prior-auths.
Example
[10,25,50]
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/availity/list-prior-auth-search-options \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"organization_limit":25,"organization_offset":0},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "organization_limit": 25,
    "organization_offset": 0
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "organizations": [
      {
        "organization_id": "123456",
        "customer_id": "0001234",
        "name": "Example Clinic"
      }
    ],
    "organization_offset": 0,
    "organization_limit": 25,
    "organization_returned_count": 2,
    "organization_total_count": 2,
    "organization_has_more": false,
    "organization_next_offset": 25,
    "payers": [
      {
        "payer_id": "00987",
        "name": "Example Health Plan",
        "organization_customer_ids": [
          "0001234"
        ]
      }
    ],
    "payer_count": 106,
    "has_dashboard_permission": true,
    "status_options": [
      {
        "label": "Approved",
        "value": "APPROVED",
        "wire_values": [
          "APPROVED",
          "EMERGENCY_ADMIT",
          "NOT_PRIMARY_COB",
          "COMPLETE"
        ]
      }
    ],
    "transaction_type_options": [
      {
        "label": "Outpatient",
        "value": "OUTPATIENT",
        "wire_values": [
          "OUTPATIENT"
        ]
      }
    ],
    "date_range_options": [
      {
        "label": "Last 90 Days",
        "value": "LAST_90_DAYS"
      }
    ],
    "view_options": [
      {
        "label": "Last 90 Days",
        "value": "LAST_90_DAYS"
      }
    ],
    "sort_options": [
      {
        "label": "Last 90 Days",
        "value": "LAST_90_DAYS"
      }
    ],
    "page_sizes": [
      10,
      25,
      50
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}