Availity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Availity Service Reviews (Prior Authorization) Is Auth Required API

3 actions 3 updates phrasing extends openapi/availity-is-auth-required-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Availity's API. It is a proposal applied on top of the contract, not a document Availity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/value-adds/v1/isauthrequired'].post
$.paths['/value-adds/v1/isauthrequired/{id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Availity Service Reviews (Prior Authorization) Is Auth Required API
  version: 1.0.0
extends: openapi/availity-is-auth-required-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/value-adds/v1/isauthrequired'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a payer requires prior authorization
      effect: read
      questions:
      - Does this procedure need prior authorization from the patient's health plan?
      - Can I find out if an auth is required before I submit a service review?
      instructions:
      - text: Check whether prior authorization is required for {serviceReview}.
        slots:
          serviceReview: requestBody.serviceReview
      - text: Find out if the payer needs an authorization for service {serviceReview} before I submit.
        slots:
          serviceReview: requestBody.serviceReview
      method: generated
      generated: '2026-10-01'
- target: $.paths['/value-adds/v1/isauthrequired/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an auth-required check
      effect: read
      questions:
      - Is the answer back on whether my service needs prior authorization?
      - How do I retrieve the outcome of an IsAuthRequired job?
      instructions:
      - text: Get the auth-required result for job {id}.
        slots:
          id: path.id
      - text: Poll IsAuthRequired check {id} and tell me if authorization is needed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'