Availity · Schema

ClaimStatusResponse

HealthcareClearinghouseHIPAAX12 EDIEligibilityClaimsPrior AuthorizationRevenue Cycle ManagementPayersPrice Transparency

Properties

Name Type Description
id string Availity transaction ID
status string
traceIds object
amounts object
completeCode string
errors array
View JSON Schema on GitHub

JSON Schema

availity-claimstatusresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClaimStatusResponse",
  "title": "ClaimStatusResponse",
  "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": "number",
          "example": 250.0
        },
        "allowed": {
          "type": "number",
          "example": 200.0
        },
        "paid": {
          "type": "number",
          "example": 160.0
        },
        "patientResponsibility": {
          "type": "number",
          "example": 40.0
        }
      }
    },
    "completeCode": {
      "type": "string",
      "example": "COMPLETE"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}