Availity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Availity Claim Status Enhanced Claim Status API

5 actions 5 updates phrasing extends openapi/availity-enhanced-claim-status-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 5

$.info
$.paths['/clmsmgmt/claim-status/claim-status/v1/status/searchBy276'].get
$.paths['/clmsmgmt/claim-status/claim-status/v1/status/searchBy276'].post
$.paths['/clmsmgmt/claim-status/claim-status/v1/status/summarySearch'].post
$.paths['/clmsmgmt/claim-status/claim-status/v1/status/detailSearch'].post

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 Claim Status Enhanced Claim Status API
  version: 1.0.0
extends: openapi/availity-enhanced-claim-status-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['/clmsmgmt/claim-status/claim-status/v1/status/searchBy276'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll results of an X12 276 claim search
      effect: read
      questions:
      - How do I get the results of a 276 claim status search I already submitted?
      - Is my 276 claim status job finished yet?
      instructions:
      - text: Poll the 276 claim status search results for job {id}.
        slots:
          id: query.id
      - text: Check whether 276 search job {id} has returned claim results.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clmsmgmt/claim-status/claim-status/v1/status/searchBy276'].post
  update:
    x-apievangelist-phrasing:
      intent: Search claim status by patient using X12 276
      effect: read
      questions:
      - Can I look up a claim's status using the patient's name and birth date?
      - How do I submit an X12 276-style claim status request as JSON?
      - What do I need to send to search claims by patient and service date range?
      instructions:
      - text: '276 search at {payerId}: {patientFirstName} {patientLastName}, DOB {patientBirthDate}, {fromDate} to {toDate}, provider {providerLastName}.'
        slots:
          payerId: requestBody.payerId
          patientFirstName: requestBody.patientFirstName
          patientLastName: requestBody.patientLastName
          patientBirthDate: requestBody.patientBirthDate
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
          providerLastName: requestBody.providerLastName
      - text: 'Submit a 276 claim search for patient {patientLastName} with payer {payerId} where the patient is also the subscriber: {patientSameAsSubscriber}.'
        slots:
          patientLastName: requestBody.patientLastName
          payerId: requestBody.payerId
          patientSameAsSubscriber: requestBody.patientSameAsSubscriber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clmsmgmt/claim-status/claim-status/v1/status/summarySearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a summary search across claims
      effect: read
      questions:
      - Can I find all claims paid on a particular check number?
      - How do I get a high-level list of a member's claims across a range of service dates?
      - Can I narrow a claim summary search to a specific claim status?
      instructions:
      - text: Summary-search claims at payer {payerId} for member {memberId}, request type {requestType}.
        slots:
          payerId: requestBody.payerId
          memberId: requestBody.memberId
          requestType: requestBody.requestType
      - text: Find claims tied to check number {checkNumber} at payer {payerId}, request type {requestType}.
        slots:
          checkNumber: requestBody.checkNumber
          payerId: requestBody.payerId
          requestType: requestBody.requestType
      - text: List claims for NPI {providerNpi} serviced between {fromDate} and {toDate} with status {requestedStatus} at {payerId}.
        slots:
          providerNpi: requestBody.providerNpi
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
          requestedStatus: requestBody.requestedStatus
          payerId: requestBody.payerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clmsmgmt/claim-status/claim-status/v1/status/detailSearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up full detail for one claim
      effect: read
      questions:
      - How do I get detailed status for a single claim when I have the claim number?
      - Can I look up one claim's detail using our tax ID or NPI?
      instructions:
      - text: Get the detailed status of claim {claimNumber} at payer {payerId}, request type {requestType}.
        slots:
          claimNumber: requestBody.claimNumber
          payerId: requestBody.payerId
          requestType: requestBody.requestType
      - text: Look up claim {claimNumber} detail at {payerId} for tax ID {providerTaxId}, request type {requestType}.
        slots:
          claimNumber: requestBody.claimNumber
          payerId: requestBody.payerId
          providerTaxId: requestBody.providerTaxId
          requestType: requestBody.requestType
      method: generated
      generated: '2026-10-01'