Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HHAeXchange Onboarding API

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

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.1.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.1.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 ClientOnboardingResponse (12 properties), ClientCreateResponse (12 properties), ClientMigrateRequest (8 properties), AgencyUser (7 properties). Each schema is shown below with its type and property counts.

ClientCreateResponse
object
Response schema for client create (onboarding) — ClientSecret plus AgencyUsers or PayerUser.
12 properties 6 required
ClientOnboardingResponse
object
Response schema for client onboarding details (GET/PATCH/migrate Data).
12 properties 4 required
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
ClientUpdateResponseWrapper
object
Wrapper for client onboarding update API responses (PATCH).
2 properties 2 required
PayerUser
object
Payer (Chha) mapping row in onboarding responses for FhirPayer clients (response-only).
6 properties 5 required
ClientOnboardingResponseWrapper
object
Wrapper for client onboarding API responses (GET).
2 properties 2 required
HTTPValidationError
object
1 property
ClientMigrateResponseWrapper
object
Wrapper for client migrate API response.
2 properties 2 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
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
AgencyUser
object
Agency row in onboarding responses: user + mapping env + rate limit fields (response-only).
7 properties 5 required
ClientUpdateRequest
object
Request schema for updating client onboarding details (env-per-mapping model). Use Agencies for FhirProvider / FhirAggregator / FhirThirdParty mapping updates.…
5 properties
ClientMigrateRequest
object
Request schema for migrating a client (data migration API).
8 properties 5 required
ClientCreateResponseWrapper
object
Wrapper for client create (onboarding) API response.
2 properties 2 required
OnboardingSummary
object
Present when agencies or payers were skipped or mapped with inactive HHA status.
5 properties

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
HHAeXchange Internal API