How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HHAeXchange

HHAeXchange Onboarding API

The Onboarding API from HHAeXchange — 3 operation(s) for onboarding.

Documentation Provider Profile APIs.io OpenAPI GitHub

HHAeXchange Onboarding API is one of 3 APIs that HHAeXchange publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a status page, and rate-limit docs.

This API exposes 4 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.hhaexchange.com.

4 operations 3 paths 16 schemas 1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.hhaexchange.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

HHAeXchange Onboarding API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (bearerAuth) using the clientCredentials flow, exposing 1 scope.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Onboarding 4
POST
/v1/fhir-onboarding/client
Create Client (Onboarding)
create_client_v1_fhir_onboarding_client_post body → 201422
POST
/v1/fhir-onboarding/client/migrate
Migrate Client (Data Migration)
migrate_client_v1_fhir_onboarding_client_migrate_post body → 201422
GET
/v1/fhir-onboarding/client/{client_id}
Get Client Onboarding Details
get_client_v1_fhir_onboarding_client__client_id__get 1 param → 200422
PATCH
/v1/fhir-onboarding/client/{client_id}
Update Client Onboarding Details
update_client_v1_fhir_onboarding_client__client_id__patch 1 param body → 200422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ClientCreateResponse (12 properties), ClientOnboardingResponse (12 properties), ClientMigrateRequest (8 properties), AgencyUser (7 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
ClientCreateRequest
object
Request schema for creating (onboarding) a new FHIR client. Use Agencies for FhirProvider / FhirAggregator / FhirThirdParty. Use Payer (exactly one item) for F…
5 properties 2 required
ClientCreateResponse
object
Response schema for client create (onboarding) — ClientSecret plus AgencyUsers or PayerUser.
12 properties 6 required
PayerOnboardingInput
object
One payer (Chha) item for FhirPayer onboarding and PATCH mapping updates. PayerId maps to FHIR.ClientMappings.AgencyId. When Env is omitted, empty, or whitespa…
4 properties 1 required
AgencyUser
object
Agency row in onboarding responses: user + mapping env + rate limit fields (response-only).
7 properties 5 required
ClientOnboardingResponseWrapper
object
Wrapper for client onboarding API responses (GET).
2 properties 2 required
PayerUser
object
Payer (Chha) mapping row in onboarding responses for FhirPayer clients (response-only).
6 properties 5 required
ClientCreateResponseWrapper
object
Wrapper for client create (onboarding) API response.
2 properties 2 required
HTTPValidationError
object
1 property
OnboardingSummary
object
Present when agencies or payers were skipped or mapped with inactive HHA status.
5 properties
ClientUpdateRequest
object
Request schema for updating client onboarding details (env-per-mapping model). Use Agencies for FhirProvider / FhirAggregator / FhirThirdParty mapping updates.…
5 properties
ClientMigrateResponseWrapper
object
Wrapper for client migrate API response.
2 properties 2 required
ClientMigrateRequest
object
Request schema for migrating a client (data migration API).
8 properties 5 required
AgencyOnboardingInput
object
One agency item used by onboarding, migrate, and update requests. Field requirements: - AgencyId is required (positive integer; agency/vendor identifier). - En…
4 properties 1 required
ClientOnboardingResponse
object
Response schema for client onboarding details (GET/PATCH/migrate Data).
12 properties 4 required
ClientUpdateResponseWrapper
object
Wrapper for client onboarding update API responses (PATCH).
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhaexchange-onboarding-api-openapi.yml Raw ↑

Other APIs HHAeXchange publishes across the network.

HHAeXchange Configuration API
AE Profile APIs.io
HHAeXchange Internal API
AE Profile APIs.io
#Onboarding
← Back to H APIs
API Details
ID
hhaexchange:hhaexchange-onboarding-api
Base URL
https://api.hhaexchange.com
Docs
https://knowledge.hhaexchange.com/edi/Content/Documentation/EDI/API.htm
Provider
HHAeXchange
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=hhaexchange-onboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hhaexchange-onboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of HHAeXchange Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.