availity · JSON Structure

Claim Status Claim Status Response Structure

ClaimStatusResponse schema from Availity API

Type: object Properties: 6

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

Properties

id status traceIds amounts completeCode errors

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/claim-status-claim-status-response-structure.json",
  "description": "ClaimStatusResponse schema from Availity API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Availity transaction ID",
      "example": "500123"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACKNOWLEDGED",
        "ACTION_REQUIRED",
        "ADJUSTED",
        "CAPITATED",
        "DENIED",
        "ERROR",
        "FINALIZED",
        "PAID",
        "PENDING",
        "REJECTED",
        "RETURNED_TO_PROVIDER"
      ],
      "example": "PAID"
    },
    "traceIds": {
      "type": "object",
      "properties": {
        "AVAILITY_TRACE_ID": {
          "type": "string",
          "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
        },
        "PAYER_TRACE_ID": {
          "type": "string",
          "example": "277-trace-001"
        }
      }
    },
    "amounts": {
      "type": "object",
      "properties": {
        "billed": {
          "type": "double",
          "example": 250.0
        },
        "allowed": {
          "type": "double",
          "example": 200.0
        },
        "paid": {
          "type": "double",
          "example": 160.0
        },
        "patientResponsibility": {
          "type": "double",
          "example": 40.0
        }
      }
    },
    "completeCode": {
      "type": "string",
      "example": "COMPLETE"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "name": "ClaimStatusResponse"
}