Availity · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/availity-auth-attachments-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/v2/attachments'].post
$.paths['/value-adds/v2/attachments/{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) Auth Attachments API
  version: 1.0.0
extends: openapi/availity-auth-attachments-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/v2/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an authorization with supporting documents
      effect: write
      questions:
      - How do I attach medical records to an authorization request?
      - Can I send supporting documents for an existing certification number?
      instructions:
      - text: Send {attachments} to payer {payerId} for authorization {certificationNumber}, patient {patient}, subscriber {subscriber}, provider {provider}.
        slots:
          attachments: requestBody.attachments
          payerId: requestBody.payerId
          certificationNumber: requestBody.certificationNumber
          patient: requestBody.patient
          subscriber: requestBody.subscriber
          provider: requestBody.provider
      - text: Attach {attachments} to certification {certificationNumber} at {payerId}; patient {patient}, subscriber {subscriber}, provider {provider}.
        slots:
          attachments: requestBody.attachments
          certificationNumber: requestBody.certificationNumber
          payerId: requestBody.payerId
          patient: requestBody.patient
          subscriber: requestBody.subscriber
          provider: requestBody.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/value-adds/v2/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check processing status of an auth attachment
      effect: read
      questions:
      - Has the payer finished processing the documents I attached to my authorization?
      - How do I track an authorization attachment job?
      instructions:
      - text: Check the processing status of authorization attachment job {id}.
        slots:
          id: path.id
      - text: Tell me whether auth attachment {id} has been processed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'