Availity · Schema

AttachmentRequest

HealthcareClearinghouseHIPAAX12 EDIEligibilityClaimsPrior AuthorizationRevenue Cycle ManagementPayersPrice Transparency

Properties

Name Type Description
payerId string
patient object
subscriber object
provider object
certificationNumber string
attachments array
View JSON Schema on GitHub

JSON Schema

availity-attachmentrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AttachmentRequest",
  "title": "AttachmentRequest",
  "type": "object",
  "required": [
    "payerId",
    "patient",
    "subscriber",
    "provider",
    "certificationNumber",
    "attachments"
  ],
  "properties": {
    "payerId": {
      "type": "string",
      "example": "BCBS001"
    },
    "patient": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "example": "Jane"
        },
        "lastName": {
          "type": "string",
          "example": "Smith"
        }
      }
    },
    "subscriber": {
      "type": "object",
      "properties": {
        "memberId": {
          "type": "string",
          "example": "MEM123456"
        }
      }
    },
    "provider": {
      "type": "object",
      "properties": {
        "npi": {
          "type": "string",
          "example": "1234567890"
        }
      }
    },
    "certificationNumber": {
      "type": "string",
      "example": "AUTH-2025-001234"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contentType": {
            "type": "string",
            "example": "application/pdf"
          },
          "title": {
            "type": "string",
            "example": "Clinical Notes"
          },
          "data": {
            "type": "string",
            "format": "byte"
          }
        }
      }
    }
  }
}