CAcairhealth

POST /api/eligibility/v2

Changed on

Provides real-time access to patient eligibility benefits information, such as deductibles, copays, etc.

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/eligibility/v2
  • Auth
    HTTP bearer

Request body

patientFirstNamestring required

Patient first name

patientLastNamestring required

Patient last name

patientDOBstring required

Patient Date of Birth, formatted as MM-DD-YYYY

patientMemberIdstring required

Member ID of patient's insurance policy

dateOfCoveragestring required

Date to request coverage information. Formatted as MM-DD-YYYY

payerIdstring required

Payer ID. Accepts either the Stedi Payer ID (e.g. 'KMQTZ', 'HGJLR') or the Primary Payer ID (e.g. '87726') from the platform or the Fetch Enrollments API

providerIdstring required

Billing Provider ID. Accepts either the CAIR logical provider ID (from /admin/provider/<id>) or the clearinghouse provider ID from the Fetch Enrollments API

mockRequestboolean

Optional flag to only return mock data

serviceTypeCodesstring[]

Service type codes to request coverage information for

Response

Eligibility check successful

payerNamestring

Name of the insurance payer

status'Active Coverage' | 'Inactive'

Coverage status

memberIdstring

Member ID of the subscriber

groupNamestring

Group name from the plan

groupNumberstring

Group number from the plan

insuranceTypestring

Type of insurance (e.g. PPO, HMO)

planNamestring

Name of the plan

eligibilityBeginDatestring

Eligibility begin date (YYYY-MM-DD)

responseobject

Map of service type codes to benefit information

messagestring

Message of response. Any errors will be displayed here.

Changes

  • b32380ccde9aRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status