availity · JSON Structure

Eligibility Eligibility Response Structure

EligibilityResponse schema from Availity API

Type: object Properties: 8

EligibilityResponse is a JSON Structure definition published by availity, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id controlNumber requestedDate serviceDate subscriber payer coverages planInformation

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/availity/refs/heads/main/json-structure/eligibility-eligibility-response-structure.json",
  "description": "EligibilityResponse schema from Availity API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Availity transaction ID"
    },
    "controlNumber": {
      "type": "string"
    },
    "requestedDate": {
      "type": "datetime"
    },
    "serviceDate": {
      "type": "date"
    },
    "subscriber": {
      "$ref": "#/components/schemas/SubscriberInfo"
    },
    "payer": {
      "$ref": "#/components/schemas/PayerInfo"
    },
    "coverages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Coverage"
      }
    },
    "planInformation": {
      "$ref": "#/components/schemas/PlanInformation"
    }
  },
  "name": "EligibilityResponse"
}