Operate HIPAA accounts
As a Workforce Intelligence operator, understand HIPAA mode: which upstream routes may serve a HIPAA account, how to mark a vendor key eligible, how operators turn the mode on or off, and what is recorded.
HIPAA mode is a setting on one Workforce Intelligence account. While it is on, every request the
account makes is served only through HIPAA-eligible routes: the first choice, every fallback, every
retry on another key, exact model names, embeddings, images and model lookups alike. When no
eligible route is available, the request fails with HTTP 503 and the error code
hipaa_no_eligible_route. It never moves to a route that is not eligible.
Which routes are eligible#
- AWS Bedrock. Every Bedrock route is eligible, because the AWS Business Associate Agreement covers all of Bedrock. There is no setting for this, and it holds whichever credentials sign Bedrock calls (the service's AWS role, or the dev credentials a development stack may use).
- A vendor's own API (Anthropic, OpenAI, Google Gemini, xAI) is eligible only through a key
marked eligible in the upstream key document (
WICENTRAL_UPSTREAM_KEYS). A key without the mark never serves a HIPAA account, even when it is the only key that could answer.
Mark a key eligible only when the operator of this service holds a Business Associate Agreement that covers that key's
vendor account. Add "hipaa_eligible": true to the key's entry:
{"openai": [{"id": "o1", "secret": "sk-...", "state": "active", "hipaa_eligible": true},
{"id": "o2", "secret": "sk-...", "state": "active"}]}
The value must be true or false. Any other value (a string, a number, null) makes the whole
document invalid: the service logs upstream_keypool_reload_rejected and keeps the previous key set
in service. Ordinary accounts use flagged and unflagged keys alike.
The HIPAA-eligible routes card on the Upstream keys and models page lists the vendor keys marked eligible, by id, and whether HIPAA mode can be turned on right now (see Read the upstream page).
Turning HIPAA mode on#
Only an operator can turn HIPAA mode on, because it requires a signed business associate agreement (BAA) between the customer and Workforce Intelligence Inc. Make sure the signed BAA is on file before you turn it on: you confirm it on the form each time, and your confirmation is recorded. The account owner cannot turn it on or off; while it is on, the owner's Overview shows a HIPAA mode card that says "This account runs only on HIPAA-eligible models.", with no controls. While it is off, the owner's Overview shows nothing about it.
Any account can be turned on, however it is billed:
- Open the account from Accounts. The HIPAA mode card shows HIPAA mode (On or Off) and, while it is off, Can be turned on: Yes, or No with the capabilities that have no eligible route.
- Turn on operator mode (see Turn on operator mode). While operator mode is off the card says "To make changes, turn on operator mode in the banner above." instead of a button.
- Check that the signed BAA is on file, then check the box I have confirmed that a BAA agreement has been signed between this customer and Workforce Intelligence Inc. The Turn on HIPAA mode button stays disabled until the box is checked.
- Select Turn on HIPAA mode.
The confirmation is required: if the form arrives without the box checked, the page says "Confirm that a BAA has been signed before turning on HIPAA mode.", nothing changes, and the refused attempt is recorded in the operator log (see What is recorded).
When it cannot be turned on, the card has no button and links to the Upstream keys and models page. The service first checks that it can serve a HIPAA account at all: at least one HIPAA-eligible route must be available right now for chat, for embeddings and for image generation (a connected AWS Bedrock that offers the model, or a vendor key marked eligible). When one of them has none, turning the mode on is refused, with no override, and the message names what is missing ("HIPAA mode cannot be turned on: no HIPAA-eligible route is configured for ..."). A refused preflight changes nothing and records nothing.
Turning HIPAA mode off#
Only an operator can turn HIPAA mode off, with operator mode on. Turning it off needs no BAA confirmation. On the account's HIPAA mode card, select Turn off HIPAA mode, then select Turn off HIPAA mode again in the "Turn off HIPAA mode?" dialog. The account owner has no way to turn it off.
If operator mode ends while the account page is open, submitting either change does nothing: the page says Operator mode is off and nothing is recorded. Unlock operator mode and repeat it.
Turning the mode on when it is already on, or off when it is already off, changes nothing and records nothing. If someone else changes the setting at the same moment, your change is refused instead of overwriting theirs; reload the account and try again.
What the customer's installation sees#
- The account's status reports
hipaa: true. - The model list shows only the models that an eligible route can serve right now.
- A model lookup returns a model that has an eligible route, and says for any model whether one is
available right now (
hipaa_eligible). - A request with no eligible route available fails with HTTP 503
hipaa_no_eligible_routeand aRetry-Afterheader. The message names no vendor and contains nothing from the request.
What is recorded#
The account's own history records each change, with the operator's user id as the actor
(operator:<id>) and the before and after values off and on (never an email or a key):
| Account history action | When |
|---|---|
account.hipaa_enabled |
An operator turned HIPAA mode on. The entry also records that the operator confirmed a signed BAA (baa_confirmed: true). |
account.hipaa_disabled |
An operator turned HIPAA mode off. |
Operator actions are also recorded in the operator log, with your user id and the account id:
| Operator action | When |
|---|---|
account.set_hipaa |
You turned HIPAA mode on for an account; the entry records your BAA confirmation (baa_confirmed: true). Also recorded, as a failure with the reason baa_not_confirmed, when the form arrived without the BAA box checked, and as a failure when the change failed after it was allowed. |
account.clear_hipaa |
You turned HIPAA mode off (or the change failed after it was allowed). |
Unlocking and exiting operator mode are recorded as operator_mode.unlock and operator_mode.exit.
The service also logs hipaa_no_eligible_route (a warning) when a HIPAA account's request finds
no eligible route, and hipaa_route_violation (an alert) if a route that is not eligible ever
reaches the point of a request; that request is stopped before anything is sent and answers HTTP
500.