Skip to content

docs(prior-auth): document CDS_REQUIRED_HEADERS and CDS_ENABLED_HOOKS #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
not-in-stock merged 2 commits into from
May 29, 2026
Merged

docs(prior-auth): document CDS_REQUIRED_HEADERS and CDS_ENABLED_HOOKS #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9163171
docs(prior-auth): document CDS_REQUIRED_HEADERS and CDS_ENABLED_HOOKS
not-in-stock May 29, 2026
6b931aa
docs(prior-auth): document CDS_REQUIRED_HEADERS and CDS_ENABLED_HOOKS
not-in-stock May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/prior-auth/crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,26 @@ The service holds the payer's coverage rules: medical policy, formulary tiers, n

For a complete local setup example, see [Quickstart: Run locally](../get-started/quickstart-run-locally.md).

## Required headers

Operators can require specific HTTP headers on every inbound hook request via a comma-separated allowlist. When any listed header is missing or blank, Payerbox rejects the request with `400` and an `OperationOutcome` before reaching the Decision Service. Discovery (`GET /cds-services`) is not gated — only hook POSTs.

```
CDS_REQUIRED_HEADERS=x-client-id
```

Header names are case-insensitive. Default (unset) — no header validation, requests pass through.

## Enabled hooks

To advertise only a subset of the supported hooks — useful while the upstream Decision Service is implementing CRD incrementally — operators can pass a comma-separated allowlist of hook ids. When set, `GET /cds-services` returns only the listed ids and `POST /cds-services/<other-id>` returns `404` with an `OperationOutcome`.

```
CDS_ENABLED_HOOKS=order-sign-crd,order-select-crd
```

Valid ids are `order-sign-crd`, `order-select-crd`, `order-dispatch-crd`, `appointment-book-crd`; matching is case-insensitive. Default (unset) — all four hooks are exposed.

## Supported hooks

| Hook | When it fires | Reference |
Expand Down
Loading