HHAeXchange

Supergood | HHAeXchange API

Alex Klarfeld

Alex Klarfeld

— 6 min read

Programmatically access Electronic Visit Verification (EVV), authorizations, visit maintenance, and Medicaid reimbursement workflows in HHAeXchange with a stable REST API. Supergood builds and operates production-grade, unofficial HHAeXchange integrations so your team can automate EVV-to-billing pipelines without heavy custom engineering.

In plain English: HHAeXchange is software that home and community-based service providers use to schedule care, verify in-home visits, track payer authorizations, and bill Medicaid/MCOs. With an unofficial API, you could sync patients and caregivers from your EHR, create and verify EVV visits, retrieve authorizations, package verified visits into claims, and reconcile payments—end to end.

If you’re a clinic, provider group, or revenue cycle team integrating your tech stack with HHAeXchange, you’ll gain concrete data flows and automations:

  • Pull: Patient/member profiles, caregiver rosters, payer authorizations, plan-of-care tasks, visit statuses, exception queues, verified visit exports, claim statuses, remittance summaries
  • Push: New/updated patients and caregivers from your EHR, scheduled visits, check-in/out events, visit edits with compliant reason codes, claim submissions referencing verified visits
  • Build: Authorization-aware scheduling, real-time EVV exception resolution, automatic claim assembly for 837P/I, reconciliation dashboards driven by EVV and remittance data

What is HHAeXchange?

HHAeXchange provides EVV and homecare management solutions used by provider agencies, clinics, and state Medicaid programs to ensure in-home and community-based services are delivered and documented as required by the 21st Century Cures Act. The platform spans caregiver mobile EVV, telephony, scheduling, visit documentation, authorization tracking, plan-of-care management, and billing/EDI connections to Medicaid and Managed Care Organizations (MCOs).

Many Medicaid programs and payer networks rely on HHAeXchange in whole or in part for EVV connectivity and billing workflows, with recent rollouts and expansions in states like Alabama, Illinois, Minnesota, New Jersey, Mississippi, and West Virginia.

Core product areas include:

  • EVV (mobile app, telephony/IVR, aggregator connections)
  • Scheduling and visit management
  • Patient/client and caregiver/provider rosters
  • Payer authorizations and service programs
  • Plan of Care (tasks, required documentation)
  • Exception handling, reason codes, and compliance reporting
  • Export and billing support for Medicaid/MCO claims (EDI 837) and remittances (EDI 835)

Common data entities:

  • Clients/Members (patients)
  • Caregivers/Employees (aides, nurses, staff)
  • Visits (EVV check-in/out, service codes, tasks)
  • Authorizations (payer/program, units, date ranges)
  • Plan of Care and visit tasks
  • Exceptions (late/missing calls, GPS mismatch, overlapping visits)
  • Schedules/Assignments
  • Claims (837P/I referencing verified visits)
  • Remittances (835 payment/denial summaries)

The HHAeXchange Integration Challenge

Organizations rely on HHAeXchange daily, but turning portal-based EVV workflows into automated pipelines is hard:

  • State- and payer-specific rules: Each Medicaid/MCO program may use distinct service codes, modifiers, reason codes, and EVV validation logic
  • Strong enterprise security: SSO/MFA, rotating cookies, and network controls complicate headless automation
  • Portal-first delivery: Visit maintenance, exceptions, and reporting often live in web apps or batch exports, not unified public APIs
  • File interfaces and timing windows: SFTP/EDI feeds, batching constraints, and daily submission windows must be respected
  • Compliance nuances: Visit edits require compliant reason codes and audit trails; evidence artifacts (GPS, signatures) must be preserved

How Supergood Creates HHAeXchange APIs

Supergood reverse-engineers authenticated browser flows, batch interfaces, and network interactions to deliver a resilient API endpoint layer.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes EVV, authorization, and claim objects so you can integrate once across states/MCOs
  • Aligns with customer entitlements and licensing constraints to ensure compliant access
  • Bridges batch exports and SFTP/EDI flows where applicable with signed URL retrieval and delivery

Use Cases

EHR-to-EVV Synchronization

  • Push patient and caregiver rosters from your EHR into HHAeXchange
  • Create visits automatically from your scheduling system with correct service codes and modifiers
  • Maintain a single source of truth for demographics and eligibility

Authorization-Aware Scheduling and Eligibility

  • Validate authorizations before scheduling or visit creation
  • Track remaining authorized units and prevent over-utilization
  • Surface program-specific rules to care coordinators

EVV Exception Resolution

  • Pull exception queues and route issues (e.g., late arrival, missing check-out, GPS mismatch) to staff for resolution
  • Apply compliant reason codes on visit edits with audit trails
  • Escalate unresolved exceptions prior to claim submission

Claims Generation and Reimbursement Automation

  • Bundle verified visits into 837P/I claims with payer-specific formatting
  • Submit via the configured channel (state portal, MCO gateway, or clearinghouse)
  • Track claim statuses and reconcile remittances alongside EVV evidence

Audit and Compliance

  • Export complete visit packets with timestamps, locations, signatures, and reason codes
  • Maintain machine-readable audit trails aligned to state/MCO requirements
  • Prove EVV coverage and claim provenance during reviews

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": {
      "type": "totp",
      "code": "123456"
    }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_29b71a",
    "name": "EVV Admin",
    "entitlements": ["evv", "authorizations", "claims"]
  }
}

Authorizations

GET /authorizations: Retrieve member/payer service authorizations with allowed units, service codes, and date ranges. Use this to validate scheduling and claim eligibility.

Query parameters

  • memberId: string
  • programCode: string (e.g., PCS, PDN)
  • serviceCode: string (HCPCS/HCPCS-like)
  • activeOn: ISO 8601 date
  • payerId: string

Example response

{
  "items": [
    {
      "authorizationId": "auth_7342c1",
      "authorizationNumber": "NJ-2026-11872",
      "member": {
        "id": "mem_9b42f0",
        "mrn": "MRN-002918",
        "name": "Jordan Patel"
      },
      "payerId": "payer_nj-medicaid",
      "programCode": "PCS",
      "serviceCode": "T1019",
      "modifiers": ["U1"],
      "unitsApproved": 120,
      "unitsUsed": 36,
      "unitsRemaining": 84,
      "startDate": "2026-01-01",
      "endDate": "2026-03-31",
      "status": "active",
      "planOfCareId": "poc_41cf92"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Members

POST /members: Create or update a member (patient) profile. Supergood upserts by externalId or payer/member identifiers.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/members \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "ehr-mem-42391",
    "firstName": "Jordan",
    "lastName": "Patel",
    "dob": "1982-07-04",
    "medicaidId": "NJ1234567",
    "contact": {
      "phone": "+1-973-555-0199",
      "email": "[email protected]"
    },
    "address": {
      "line1": "100 Care Way",
      "city": "Newark",
      "region": "NJ",
      "postalCode": "07102"
    },
    "language": "en",
    "payerEnrollment": [
      {"payerId": "payer_nj-medicaid", "programCode": "PCS", "active": true}
    ]
  }'

Example response

{
  "memberId": "mem_9b42f0",
  "status": "updated",
  "externalId": "ehr-mem-42391"
}

EVV Visits

POST /evv/visits: Create or update an EVV visit with check-in/out events, service details, and verification metadata. Supports compliant edit reason codes and plan-of-care task capture.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/evv/visits \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "memberId": "mem_9b42f0",
    "caregiverId": "cgv_2208aa",
    "authorizationId": "auth_7342c1",
    "service": {"code": "T1019", "modifiers": ["U1"]},
    "visitDate": "2026-01-19",
    "checkIn": {
      "timestamp": "2026-01-19T14:02:33Z",
      "method": "mobile",
      "location": {"lat": 40.7357, "lng": -74.1724},
      "deviceId": "ios-12a3"
    },
    "checkOut": {
      "timestamp": "2026-01-19T15:01:47Z",
      "method": "mobile",
      "location": {"lat": 40.7359, "lng": -74.1721}
    },
    "pocTasks": ["bathing", "meal_prep"],
    "notes": "Client requested meal prep and light housekeeping.",
    "verification": {"gpsMatch": true, "signatureCapture": true},
    "reasonCodes": [],
    "referenceId": "ehr-schedule-42391"
  }'

Example response

{
  "visitId": "vst_58d3e0",
  "visitKey": "hha_7c9f61",
  "status": "verified",
  "exceptions": [],
  "createdAt": "2026-01-19T15:02:02Z",
  "referenceId": "ehr-schedule-42391"
}

Claims

POST /billing/claims: Assemble an 837P/I claim from verified visits. Supergood normalizes service lines and routes the generated file to the configured submission channel.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/billing/claims \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "format": "837P",
    "payerId": "payer_nj-medicaid",
    "billingProvider": {
      "npi": "1234567890",
      "taxId": "12-3456789",
      "taxonomy": "Home Health",
      "name": "BrightCare Home Services",
      "billingAddress": {
        "line1": "100 Care Way",
        "city": "Newark",
        "region": "NJ",
        "postalCode": "07102"
      }
    },
    "visits": [
      {"visitId": "vst_58d3e0", "units": 4, "serviceCode": "T1019", "modifiers": ["U1"]}
    ],
    "routing": "state_portal",
    "referenceId": "billing-batch-jan19",
    "includeVisitAttachments": true
  }'

Example response

{
  "claimBatchId": "clmb_71af2b",
  "status": "queued",
  "edi": {"format": "837P", "byteSize": 51234},
  "routing": "state_portal",
  "createdAt": "2026-01-19T16:05:42Z",
  "reviewUrl": "https://download.hhaexchange.example/signed/abc123...",
  "referenceId": "billing-batch-jan19"
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination
  • Rate limits: Tuned for enterprise throughput while honoring licensing and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of visits, authorizations, and claim artifacts
  • Security: Encrypted transport, scoped tokens, and audit logging; respects HHAeXchange entitlements and compliance requirements
  • Webhooks: Optional asynchronous delivery for exceptions, claim generation, and remittance updates

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume EVV and batch claims pipelines
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your HHAeXchange product mix, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened HHAeXchange adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as HHAeXchange evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which HHAeXchange products can this integration cover?

Supergood supports workflows across commonly used HHAeXchange EVV portals and agency-facing tools, subject to your licensing and entitlements. We scope coverage (e.g., mobile/telephony EVV, authorizations, visit exports, claim assembly) during integration assessment.

Q: How are MFA, SSO, and batch interfaces handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. For batch flows, we manage SFTP/EDI timing windows, generate 837 files, and retrieve signed URLs or delivery confirmations programmatically.

Q: Can I generate claims directly from verified visits?

Yes. You can assemble 837P/I from verified visits with payer-specific formatting. We can route submissions via your configured channel (state/MCO portals or clearinghouse) and return statuses and artifacts for reconciliation.

Ready to automate your HHAeXchange workflows?

Supergood can have your HHAeXchange integration live in days with no ongoing engineering maintenance.

Get Started →

Read more