Read the HIE-CM modules
Three modules on the HIE-CM gateway:
Start at Overview.
These pages follow the sandbox document pack.
Nothing in them has been run against the ABDM sandbox, so every page carries
verification: unverified. Where a request or response shape is not yet
published, the page says so instead
of guessing at a payload.
Try the session token call
The session token call is the first call every module needs, and the one operation with a working interactive reference. Send a request from /reference/hiecm-gateway. The four module references exist but carry no operations yet.
A callback appears on the module that owns it, as an OpenAPI 3.1 webhook,
because an ABDM callback is an HTTPS POST to a URL
you registered.
| Interactive reference | Scope |
|---|---|
| /reference/hiecm-gateway | Session token, used by all modules |
| /reference/hiecm-m1 | M1, ABHA identity |
| /reference/hiecm-m2 | M2, care context linking and HIP data sharing |
| /reference/hiecm-m3 | M3, consent and HIU data fetch |
| /reference/hiecm-m4 | M4, HPR and HFR registration |
Find your way around M4, UHI and NHCX
No endpoint is documented yet for M4, for the UHI gateway at /docs/uhi/v1, or for NHCX. Those pages tell you what is published and where to read it.
The M1 agent skill
The M1 documentation is now published as an agent skill: one file carrying every endpoint, the required headers, the two token rule and the encryption rule. Download it, or install it with one command, from M1 APIs. It is generated from these pages on every build, so a page that changes changes the skill.