NHCX has API references
NHCX API references cover the exchange in 14 modules, from the session token and the participant registry to claims, payment notices and biometric authentication. Each of its 63 calls has its own page with the headers, the body and a request you can send, and each of the 21 callbacks you host has a page of its own. Error codes lists the codes recorded for the exchange gateway, the standard payer sheet and the PMJAY reference payer.
Point your agent at NHCX
Build with AI connects your coding agent to the
Docs MCP server, which searches the NHCX catalogue alongside HIE-CM's. llms.txt now lists
an index for each NHCX API module, so an agent can fetch one module's pages as Markdown.
Seven NHCX agent skills
Seven agent skills build NHCX into a hospital information system or a claims desk, one use case each: coverage, the insurance plan, pre-authorisation, the claim, payment, communication and reprocess. Build with AI lists them with the command that installs each.
Start on the NHCX sandbox
Get your sandbox credentials covers what you need before you register, the test participants and the dummy payer. The Quickstart then takes you from a session token to a participant search and a fetched certificate, with nothing built yet.
The NHCX security audit has a page
Security audit covers the functional and security tests every participant passes before production, and the certificates production onboarding reviews.
Troubleshooting NHCX by what you see
Troubleshooting starts from what you see rather than from the error code:
- Every call returns 401.
- Your callback URL is rejected.
- A 202 arrives and no callback follows.
- The recipient cannot decrypt your message.
- The payer rejects your bundle.
- Responses arrive against the wrong request.