# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Availity & Benefits Eligibility API
  version: 1.0.0
extends: openapi/availity-eligibility-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: 4
- target: $.paths['/availity/intelligent-payer-network/v1/eligibilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List past eligibility inquiries
      effect: read
      questions:
      - Can I see the eligibility checks my practice already ran last week?
      - Is there a way to pull my earlier eligibility inquiry results filtered by payer?
      - What eligibility inquiries have we submitted within a given date range?
      instructions:
      - text: List the eligibility inquiries we ran between {fromDate} and {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Show my previous eligibility inquiry results for payer {payerId}.
        slots:
          payerId: query.payerId
      - text: Page through my past eligibility checks, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/availity/intelligent-payer-network/v1/eligibilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a patient's insurance eligibility and benefits
      effect: read
      questions:
      - How do I verify a patient's insurance coverage before their appointment?
      - Can I find out a member's co-pay and deductible in real time through Availity?
      - Is there a real-time X12 270 eligibility and benefits check I can run for a dependent?
      instructions:
      - text: Run a real-time eligibility check for subscriber {subscriber} with payer {payer}.
        slots:
          subscriber: requestBody.subscriber
          payer: requestBody.payer
      - text: Verify coverage, co-pay and deductible for {subscriber} at {payer} as provider {provider}, control number {controlNumber}.
        slots:
          subscriber: requestBody.subscriber
          payer: requestBody.payer
          provider: requestBody.provider
          controlNumber: requestBody.controlNumber
      - text: Check benefits for dependent {dependent} under subscriber {subscriber} with {payer}.
        slots:
          dependent: requestBody.dependent
          subscriber: requestBody.subscriber
          payer: requestBody.payer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/availity/intelligent-payer-network/v1/eligibilities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one eligibility inquiry result
      effect: read
      questions:
      - How do I pull up the result of a specific eligibility check by its transaction ID?
      - Can I reopen a single eligibility response I already received?
      instructions:
      - text: Get the eligibility inquiry result for transaction {id}.
        slots:
          id: path.id
      - text: Show me the coverage details returned by eligibility check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/availity/intelligent-payer-network/v1/payers'].get
  update:
    x-apievangelist-phrasing:
      intent: List health plan payers supported for eligibility
      effect: read
      questions:
      - Which health plans can I run eligibility checks against?
      - What payer ID should I use for a given insurance company?
      - Can I filter the payer list to those that support a particular transaction type?
      instructions:
      - text: Find supported payers whose name matches {name}.
        slots:
          name: query.name
      - text: List payers that support the {supportedTransaction} transaction.
        slots:
          supportedTransaction: query.supportedTransaction
      - text: List every health plan payer available for eligibility transactions.
      method: generated
      generated: '2026-10-01'