Agent-ready OpenAPI document · curated by JenticHealthcareEhr Emrnone48 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Route consent requests, care-context discovery, and health-data flows between Indian Consent Managers, Health Information Providers, and Health Information Users on the NDHM network.
Use for: I need to initiate a consent request for a patient's lab reports, Discover care contexts for a patient across HIPs, Notify a HIP that consent was granted by the patient, Fetch a consent artefact by its ID
Not supported: Does not host patient records, issue ABHA Health IDs, or run the patient-facing consent UI - use for orchestration of discovery, consent, and data flows between HIPs, HIUs, and CMs only.
Jentic publishes the only available OpenAPI specification for Gateway, keeping it validated and agent-ready. The NDHM Gateway is the central hub of India's National Digital Health Mission that routes interactions between Consent Managers (CMs), Health Information Providers (HIPs), and Health Information Users (HIUs). The 48-endpoint surface covers care-context discovery, account linking, consent flows, health-data flow, identification, and monitoring - split across CM-facing, HIP-facing, and HIU-facing roles. Authorisation uses signed JWTs distributed via the Gateway's openid-configuration and certs endpoints.
Install Jentic One Beta
Connect the Gateway to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Gateway, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fndhm.gov.in%2Fndhm-gateway" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fndhm.gov.in%2Fndhm-gateway" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Gateway API.
Discover patient care contexts across registered Health Information Providers
Initiate consent requests on behalf of Health Information Users
Notify HIPs and HIUs of consent grant, revocation, and expiry events
Coordinate health-data transfer flows including encryption key exchange
Resolve patient identifiers to ABHA Health IDs for cross-provider linkage
Provide JWT verification certificates and OpenID configuration for relying parties
Use Cases
Patterns agents use Gateway API for, with concrete tasks.
★ Cross-Provider Health Record Discovery
An HIU (e.g., a teleconsultation app) queries the NDHM Gateway to discover which HIPs hold records for a patient identified by ABHA. POST /v0.5/care-contexts/discover broadcasts the request and HIPs respond asynchronously through /on-discover. This replaces ad-hoc point-to-point integrations between hospitals and apps.
Call POST /v0.5/care-contexts/discover with the patient's ABHA identifier and listen for the corresponding /on-discover callback
Consent-Based Data Sharing Workflow
An HIU requests consent from a Consent Manager to access patient records for a specific HIP and date range. POST /v0.5/consent-requests/init starts the flow, the patient grants or denies via the CM app, and POST /v0.5/consents/hiu/notify delivers the consent artefact when granted. The Gateway orchestrates the full lifecycle including status checks via /consent-requests/status.
Call POST /v0.5/consent-requests/init with the HIU id, purpose, and time range; poll /v0.5/consent-requests/status until the artefact is available
Health Information Transfer Coordination
Once consent is granted, the Gateway coordinates the encrypted health-information transfer between HIP and HIU including key exchange and delivery notifications. The data-flow endpoints publish lifecycle events that auditors and analytics pipelines subscribe to. Built around the NDHM data-flow protocol.
Listen for /v0.5/health-information/notify events with status DATA_DELIVERED and reconcile against the original consent artefact
Agent-Driven NDHM Integration
Health-tech teams use AI agents through Jentic to bootstrap an integration with the NDHM Gateway. The agent searches for the right consent or discovery endpoint, loads its schema, and submits the request, while Jentic handles the JWT-based bearer authorisation. Useful for building proof-of-concept HIUs and HIPs.
Search Jentic for 'initiate NDHM consent request' and execute POST /v0.5/consent-requests/init with the required HIU and patient fields
Key Endpoints
48 endpoints — jentic publishes the only available openapi specification for gateway, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v0.5/care-contexts/discover
Discover patient accounts across HIPs
POST
/v0.5/consent-requests/init
Create a consent request
POST
/v0.5/consents/fetch
Fetch a consent artefact
POST
/v0.5/consents/hiu/notify
Notify HIU of consent decision
GET
/v0.5/.well-known/openid-configuration
Get OpenID configuration
GET
/v0.5/certs
Get JWT verification certificates
POST
/v0.5/care-contexts/discover
Discover patient accounts across HIPs
POST
/v0.5/consent-requests/init
Create a consent request
POST
/v0.5/consents/fetch
Fetch a consent artefact
POST
/v0.5/consents/hiu/notify
Notify HIU of consent decision
GET
/v0.5/.well-known/openid-configuration
Get OpenID configuration
GET
/v0.5/certs
Get JWT verification certificates
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
G
Gateway
- Foundational (C-)52/100
99
Foundational Compliance71
Developer Experience & Jentic Compatibility22
AI-Readiness & Agent Experience94
Agent Usability100
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
96%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
71
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
15%
Example Density
How richly the API is illustrated with examples.
96%
Example Validity
Percentage of examples that conform to their schemas.
74%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
22
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
40%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the NDHM Gateway by hand means signing JWTs, managing Gateway client credentials on the dev.ndhm.gov.in host, and handling the asynchronous discovery, consent, and data-flow callbacks yourself. Through Jentic you install once, import the Gateway from the API Directory, store the client credentials once, and your agent calls it.
Permission scoping
The Gateway carries HIU id, purpose, and consent ids in the request body rather than in the URL path, so scope the agent to the operations it needs, such as initiating a consent request. You choose the operations it may call, so care-context discovery or consent-fetch calls are not included unless you add them.
Credential isolation
Your NDHM JWT signing keys and Gateway client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. Private keys and raw tokens never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'initiate an NDHM consent request', and Jentic returns POST /v0.5/consent-requests/init with its input schema so the agent supplies HIU id and purpose without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Gateway API through Jentic.
Why is there no official OpenAPI spec for Gateway?
NDHM does not publish a maintained OpenAPI specification - only Markdown reference docs and a deprecated apis.guru import. Jentic generates and maintains this spec so that AI agents and developers can call Gateway via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the NDHM Gateway use?
The Gateway uses signed JWTs issued through its OpenID-style flow. Clients fetch the public verification certificates from GET /v0.5/certs and validate Gateway-issued tokens against them. The OpenAPI spec leaves `securitySchemes` empty because authorisation is handled at the JWT layer rather than via standard HTTP schemes.
Can I initiate a consent request through this API?
Yes. POST /v0.5/consent-requests/init starts a consent request as an HIU. The Consent Manager then prompts the patient and notifies the HIU via POST /v0.5/consents/hiu/notify when the artefact is ready, or your service can poll /v0.5/consent-requests/status.
What are the rate limits for the NDHM Gateway?
NDHM does not publish hard rate limits in the spec. The sandbox at dev.ndhm.gov.in applies fair-use throttling appropriate for development and certification testing. Production rate limits depend on the client's onboarding tier with the National Health Authority.
How do I discover patient care contexts through Jentic?
Search Jentic for 'discover NDHM care contexts', load the schema for POST /v0.5/care-contexts/discover, and execute with the patient's ABHA identifier. The Gateway broadcasts to registered HIPs and your callback URL receives /on-discover responses.
Is the NDHM Gateway free to use?
Yes. The Gateway is operated by India's National Health Authority and is free for accredited HIUs, HIPs, and CMs. Production access requires onboarding and certification through the NHA.
Can I limit what my agent is allowed to do with the NDHM Gateway API?
Yes. Because you run Jentic One yourself, your own rules decide which NDHM Gateway operations and credentials the agent may use. The Gateway carries the HIU id, purpose, and consent ids in the request body rather than the URL, so you can scope the agent to only the operations it needs, such as POST /v0.5/consent-requests/init to start a consent request. Care-context discovery (POST /v0.5/care-contexts/discover) and consent-fetch (POST /v0.5/consents/fetch) calls are not included unless you explicitly add them.
GET STARTED