Availity · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/availity-service-reviews-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 4

$.info
$.paths['/availity/intelligent-payer-network/v1/service-reviews'].get
$.paths['/availity/intelligent-payer-network/v1/service-reviews'].post
$.paths['/availity/intelligent-payer-network/v1/service-reviews/{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 (Prior Authorization) Service Reviews API
  version: 1.0.0
extends: openapi/availity-service-reviews-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: 3
- target: $.paths['/availity/intelligent-payer-network/v1/service-reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List past service review submissions
      effect: read
      questions:
      - Can I see all the prior authorization requests our practice has submitted?
      - Is there a way to list earlier service reviews for just one payer?
      instructions:
      - text: List my service review submissions for payer {payerId}.
        slots:
          payerId: query.payerId
      - text: Show my past prior authorization submissions, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/availity/intelligent-payer-network/v1/service-reviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a prior authorization request
      effect: write
      questions:
      - How do I request prior authorization from a health plan through Availity?
      - Can I send an X12 278 service review request as JSON?
      - What information does a payer need for a new service review submission?
      instructions:
      - text: Submit a {requestType} service review to payer {payerId} for subscriber {subscriber} from provider {provider}.
        slots:
          requestType: requestBody.requestType
          payerId: requestBody.payerId
          subscriber: requestBody.subscriber
          provider: requestBody.provider
      - text: Request prior authorization at {payerId} for {subscriber} covering {serviceInformation}, as provider {provider}, type {requestType}.
        slots:
          payerId: requestBody.payerId
          subscriber: requestBody.subscriber
          serviceInformation: requestBody.serviceInformation
          provider: requestBody.provider
          requestType: requestBody.requestType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/availity/intelligent-payer-network/v1/service-reviews/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service review's status and details
      effect: read
      questions:
      - Has my prior authorization request been approved yet?
      - How do I check the details of one service review I submitted?
      instructions:
      - text: Get the status of service review {id}.
        slots:
          id: path.id
      - text: Show the full details of prior authorization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'