Onboarding

Update Client Onboarding Details

Changed on Sep 10, 2026

Update a FHIR client. Optional Entities (GlobalEntityId is a UUID) replace mappings; EntityType is derived from the stored ClientType. Also backfills missing GlobalEntityId, EntityType, and ProviderTaxID on existing mappings from HHA. Send empty Entities array to remove all mappings.

patch/v1/fhir-onboarding/client/{client_id}

Request

Base URL
https://api.hhaexchange.com (the document declares no server; this is the origin it was published from)
URL
https://api.hhaexchange.com/v1/fhir-onboarding/client/{client_id}
Auth
OAuth 2
Client credentials
Token URL: https://api.hhaexchange.com/v1/fhir/auth/token scopes: write

Path parameters

client_idstring required

Client UUID

Request body

Descriptionstring nullable

Client description

RateLimitingPlanstring nullable

Rate limiting plan (Basic, Premium)

Statusstring nullable

Client status (Active, Inactive)

Example request

{
  "Description": "HHAX Client",
  "Entities": [
    {
      "GlobalEntityId": "d72ef4cd-0867-4e6c-abd2-d7f8b7f5fd03",
      "RateLimit": 100,
      "RateLimitWindow": "Second"
    },
    {
      "GlobalEntityId": "10fea9d1-079d-43c2-80e2-7615cb34dea6"
    }
  ],
  "RateLimitingPlan": "Premium",
  "Status": "Inactive"
}

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientName": "Client 1",
    "ClientType": "Provider",
    "CreatedAt": "2026-02-02T14:28:18.479016Z",
    "Description": "HHAX Client Updated",
    "Entities": [
      {
        "AgencyId": 123,
        "Env": "app",
        "GlobalEntityId": "d72ef4cd-0867-4e6c-abd2-d7f8b7f5fd03",
        "ProviderTaxId": "12-3456789",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -6789,
        "UserName": "FHIRAPIUser_1_123"
      },
      {
        "AgencyId": 678,
        "Env": "app2",
        "GlobalEntityId": "10fea9d1-079d-43c2-80e2-7615cb34dea6",
        "ProviderTaxId": "98-7654321",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -4567,
        "UserName": "FHIRAPIUser_1_678"
      },
      {
        "AgencyId": 789,
        "Env": "cloud",
        "GlobalEntityId": "7223b2d6-18f7-4831-bb27-419bd76fb276",
        "ProviderTaxId": "11-2223333",
        "RateLimit": 100,
        "RateLimitWindow": "Second",
        "UserId": -8765,
        "UserName": "FHIRAPIUser_1_789"
      }
    ],
    "EntityType": "Provider",
    "RateLimitingPlan": "Premium",
    "Status": "Active",
    "UpdatedAt": "2026-02-02T09:25:11.102958Z",
    "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
  },
  "Message": "Client onboarding details updated successfully"
}

Changes

Sep 10, 202633e78eb36727 Revision changes
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the new optional request property
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property /// to the response with the status

Operation history