Skip to content
YellowParrot ABDM DevKit

Architecture

All the ABDM logic and every safety rule live in one place, the DevKit workflows. The REST API and the AI tools are thin doors into it, so no way in can skip a check. Nothing in the core depends on AI.

AI assistantClaude, other MCP clientsYour app, any languageover the REST APIYour TypeScript codeimports the packagesDevKit workflowsYour user approves every request · the patient's consent is checked at every step· each user sees only their own work · every action is logged without patient detailsConsent ruleswho may see whatEncryptionABDM's schemeHealth recordsbuild and checkABDM clientV2 and V3 APIsMock ABDMbuilt in, synthetic dataABDM sandboxyour own test credentialsCertified servicefor production use
Three ways in, one set of rules, three places to connect. Mock ABDM (highlighted) is the default and needs nothing.

The packages

Section titled “The packages”
Layer Package In plain words
Ways in abdm-mcp-server, abdm-mcp-adapter Tools for AI assistants
abdm-rest-adapter, abdm-devkit (command line) REST API for any language
Workflows abdm-workflows Consent requests, record fetches, approvals, permissions and the audit log
Building blocks abdm-consent-engine Rules for what a consent allows
abdm-crypto ABDM’s encryption
abdm-fhir Builds and checks health records
abdm-client Talks to ABDM’s APIs (V2 and V3)
Foundation abdm-core Shared names, dates and types
Practice and tests abdm-mock-gateway, abdm-fixtures The practice ABDM and made-up patients and records
Servers abdm-callback-bridge Receives ABDM’s replies on Cloudflare

Where it runs

Section titled “Where it runs”
  • Practice ABDM: anywhere Node.js 22 runs.
  • Calls to ABDM’s real systems: must come from a network in India. ABDM blocks other countries. Tests on 2026-10-27 found Cloudflare Workers abroad blocked, while a cloud server in Mumbai reached ABDM normally, so any server or cloud region in India works.
  • Callback bridge: on Cloudflare, because it only receives messages from ABDM.

API versions

Section titled “API versions”

ABDM has two current API versions. Creating health IDs (M1) uses V3. For sharing records (M2 and M3), ABDM’s own guidance says V3 is not yet stable, so the DevKit can use V2 or V3 for each step, chosen in settings.