Sign in

v1

latestOpenAPI 3.1.02026-07-1382339.6 KB
Onboarding
Onboarding

Migrate Client (Data Migration)

Migrate one client with provided ClientId, XApiKey, and agencies. Creates FHIR.Clients, HHA users, and FHIR.ClientMappings. No AWS key creation, no IDP write.

post/v1/fhir-onboarding/client/migrate

Request body

ClientIdstring required

Client identifier (UUID) to migrate

ClientNamestring required

Name of the client

ClientType'FhirProvider' | 'FhirAggregator' | 'FhirThirdParty' | 'FhirPayer' required

Type of FHIR client (FhirProvider, FhirAggregator, FhirThirdParty, FhirPayer)

XApiKeystring required

API key to store for this client (from Identity/ClientVendors)

Descriptionstring nullable

Client description

Statusstring nullable

Client status (Active, Inactive) - default Active

RateLimitingPlanstring nullable

Rate limiting plan (Basic, Premium) - default Basic

Example request

{
  "Agencies": [
    {
      "AgencyId": 123,
      "Env": "app",
      "RateLimit": 50,
      "RateLimitWindow": "Minute"
    },
    {
      "AgencyId": 456
    },
    {
      "AgencyId": 789,
      "Env": "cloud",
      "RateLimit": 50,
      "RateLimitWindow": "Minute"
    }
  ],
  "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
  "ClientName": "Migrated Client One",
  "ClientType": "FhirProvider",
  "Description": "Migrated from legacy",
  "RateLimitingPlan": "Basic",
  "Status": "Active",
  "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
}

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "AgencyUsers": [
      {
        "AgencyId": 123,
        "Env": "app",
        "ProviderTaxId": "12-3456789",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -6789,
        "UserName": "FHIRAPIUser_1_123"
      },
      {
        "AgencyId": 678,
        "Env": "app2",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -4567,
        "UserName": "FHIRAPIUser_1_678"
      },
      {
        "AgencyId": 789,
        "Env": "cloud",
        "RateLimit": 100,
        "RateLimitWindow": "Second",
        "UserId": -8765,
        "UserName": "FHIRAPIUser_1_789"
      }
    ],
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientName": "Client 1",
    "ClientType": "FhirProvider",
    "CreatedAt": "2026-01-12T07:45:30Z",
    "Description": "HHAx Client",
    "RateLimitingPlan": "Basic",
    "Status": "Active",
    "UpdatedAt": "2026-01-12T09:10:15Z",
    "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
  }
}