> ## Documentation Index
> Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Eligibility

> Get eligibility information for a patient insurance



## OpenAPI

````yaml get /api/2.0/patient_insurances/{id}/eligibility/
openapi: 3.1.0
info:
  contact:
    name: Elation Health
    url: https://www.elationhealth.com/
  description: Elation Health API v2.0
  title: '[Premium] Patient Insurance API'
  version: 2.0.0
servers:
  - description: Sandbox Server
    url: https://sandbox.elationemr.com
  - description: Production Server
    url: https://api.app.elationemr.com
security: []
paths:
  /api/2.0/patient_insurances/{id}/eligibility/:
    get:
      tags:
        - Insurance Eligibility
      summary: Get Eligibility
      description: Get eligibility information for a patient insurance
      operationId: patient_insurances_eligibility_retrieve
      parameters:
        - description: The id of the patient insurance
          in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsuranceEligibility'
          description: ''
      security:
        - oauth2: []
components:
  schemas:
    InsuranceEligibility:
      properties:
        eligibility_check_timestamp:
          description: Eligibility check timestamp in ISO format.
          format: date-time
          type: string
        eligibility_details:
          $ref: '#/components/schemas/EligibilityDetails'
        eligibility_status:
          allOf:
            - $ref: '#/components/schemas/EligibilityStatusEnum'
          description: |-
            Status of eligibility check.

            * `active` - active
            * `inactive` - inactive
            * `error` - error
        patient_id:
          description: Patient's id in Elation system.
          type: integer
        patient_insurance_id:
          description: Patient's insurance id in Elation system.
          type: integer
        practice_id:
          description: Practice's id in Elation system.
          type: integer
      type: object
    EligibilityDetails:
      properties:
        coinsurance:
          description: Coinsurance percentage value as a decimal (e.g. 0.25).
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
          type: string
        coinsurance_ambiguous:
          type: boolean
        copay:
          description: copayment amount in dollars.
          format: double
          type:
            - number
            - 'null'
        copay_ambiguous:
          description: >-
            If true, the given copay value may not be accurate and the full
            eligibility report will need to be referenced for better details.
          type: boolean
        deductible:
          description: Deductible amount in dollars.
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
          type: string
        deductible_ambiguous:
          type: boolean
        deductible_remaining:
          description: Remaining deductible amount in dollars.
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
          type: string
        deductible_remaining_ambiguous:
          type: boolean
        errors:
          description: Error messages showing reason for failed eligibility check.
          items:
            additionalProperties: {}
            type: object
          type: array
      type: object
    EligibilityStatusEnum:
      description: |-
        * `active` - active
        * `inactive` - inactive
        * `error` - error
      enum:
        - active
        - inactive
        - error
      type: string
  securitySchemes:
    oauth2:
      flows:
        clientCredentials:
          scopes:
            act_as_user: >-
              Impersonate a provider via X-On-Behalf-Of (combinable with apiv2
              or system scopes)
            apiv2: Full access to the API
            system/{resource_name}.read: Read access to a specific resource
            system/{resource_name}.write: Write access to a specific resource
          tokenUrl: /api/2.0/oauth2/token/
      type: oauth2

````