Ndhm Health Data Consent Manager
Browse all Ndhm APIs52
AI ReadinessFoundational (C-)52/100
Agent-ready OpenAPI document · curated by JenticHealthcareEhr Emrnone22 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Build a patient-facing Consent Manager that aggregates Indian health data across HIPs and shares it with HIUs based on explicit consent.
Use for: I need to receive a care-context discovery response from a HIP, Initiate a consent request on behalf of an HIU, Fetch a consent artefact and forward it to the requesting HIU, Notify an HIP that consent was revoked
Not supported: Does not store HIP-side patient records, issue ABHA Health IDs, or perform clinical workflows - use for the patient-facing consent and care-context aggregation role only.
Jentic publishes the only available OpenAPI specification for Health Data Consent Manager, keeping it validated and agent-ready. The Health Data Consent Manager (CM) is the patient-facing component of India's NDHM that aggregates health information across Health Information Providers and shares it with Health Information Users based on the patient's explicit consent. The 22-endpoint surface covers care-context discovery responses, consent request initiation and fetching, health-information request handling, link confirmation, and heartbeat monitoring.
Install Jentic One Beta
Connect the Health Data Consent Manager to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Health Data Consent Manager, 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-health-data-consent-manager" | 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-health-data-consent-manager" | 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 Health Data Consent Manager API.
Receive care-context discovery responses from registered HIPs and present them to the patient
Initiate consent requests on behalf of an HIU and capture the patient's grant or denial
Fetch consent artefacts and forward them to the requesting HIU
Notify HIPs and HIUs of consent grants, revocations, and expiry events
Coordinate health-information requests so that the HIP delivers the encrypted bundle to the HIU
Confirm patient-initiated linking of HIP care contexts to the patient's ABHA account
Use Cases
Patterns agents use Health Data Consent Manager API for, with concrete tasks.
★ Patient Consent Manager App Backend
A health-tech company builds a patient-facing CM app where users can see which hospitals hold their records, grant consent to share with insurers or telehealth apps, and revoke access at any time. The CM endpoints handle the discovery responses, consent request lifecycle, and health-information requests that the patient authorises through the app.
Receive POST /v0.5/care-contexts/on-discover events, persist them, and present the linkable care contexts to the patient
HIU-Triggered Consent Requests
When an HIU (e.g., insurer or telehealth platform) needs patient records, it asks the patient's CM to issue a consent request. POST /v0.5/consent-requests/init records the request, the patient approves through the CM UI, and POST /v0.5/consents/fetch delivers the signed artefact back to the requesting HIU.
Call POST /v0.5/consent-requests/init with the HIU id, purpose, and HIP scope; on patient approval, call POST /v0.5/consents/fetch and forward the artefact
Health-Information Data Request Coordination
After consent is granted, the CM mediates the actual data transfer by forwarding HIU requests to the HIP, receiving acknowledgements, and emitting status notifications. Endpoints like POST /v0.5/health-information/request, /on-request, and /notify capture each step of the encrypted data exchange.
Call POST /v0.5/health-information/request with the consent artefact reference and listen for the corresponding /notify event when delivery completes
Agent-Driven CM Operations
An AI agent operating inside a CM platform handles routine tasks like fetching consent artefacts, posting acknowledgements, and reconciling expiry events. Jentic resolves natural-language requests to the correct CM endpoint and signs the JWT-based payloads from the encrypted vault.
Search Jentic for 'fetch ndhm consent artefact', execute POST /v0.5/consents/fetch with the consent ID and forward the result
Key Endpoints
22 endpoints — jentic publishes the only available openapi specification for health data consent manager, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v0.5/consent-requests/init
Create a consent request
POST
/v0.5/consents/fetch
Fetch a consent artefact
POST
/v0.5/health-information/request
Request health information from an HIP
POST
/v0.5/health-information/notify
Notify on data flow events
POST
/v0.5/links/link/add-contexts
Confirm HIP-initiated care-context linking
GET
/v0.5/heartbeat
Get service heartbeat
POST
/v0.5/consent-requests/init
Create a consent request
POST
/v0.5/consents/fetch
Fetch a consent artefact
POST
/v0.5/health-information/request
Request health information from an HIP
POST
/v0.5/health-information/notify
Notify on data flow events
POST
/v0.5/links/link/add-contexts
Confirm HIP-initiated care-context linking
GET
/v0.5/heartbeat
Get service heartbeat
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.
H
Health Data Consent Manager
- Foundational (C-)52/100
99
Foundational Compliance70
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
97%
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.
70
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
14%
Example Density
How richly the API is illustrated with examples.
92%
Example Validity
Percentage of examples that conform to their schemas.
73%
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
39%
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 Consent Manager by hand means signing JWTs, managing CM client credentials on the dev.ndhm.gov.in host, and handling the asynchronous consent and health-information callbacks yourself. Through Jentic you install once, import the Health Data Consent Manager from the API Directory, store the client credentials once, and your agent calls it.
Permission scoping
The Consent Manager carries consent ids and care-context links in the request body rather than in the URL path, so scope the agent to the operations it needs, such as fetching a consent artefact. You choose the operations it may call, so health-information requests or link-context writes are not included unless you add them.
Credential isolation
Your NDHM JWT signing keys and CM 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 'fetch an NDHM consent artefact', and Jentic returns POST /v0.5/consents/fetch with its input schema so the agent supplies the consentId without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Health Data Consent Manager API through Jentic.
Why is there no official OpenAPI spec for Health Data Consent Manager?
NDHM does not publish a maintained OpenAPI specification for the CM role - only Markdown reference docs and a deprecated apis.guru import. Jentic generates and maintains this spec so that AI agents and developers can call Health Data Consent Manager 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 Health Data Consent Manager use?
The CM endpoints rely on signed JWTs issued through the NDHM Gateway and validated against certificates fetched from the Gateway's /v0.5/certs endpoint. The OpenAPI spec leaves `securitySchemes` empty because authorisation is enforced at the JWT layer rather than via a standard HTTP scheme.
Can I fetch a consent artefact through this API?
Yes. POST /v0.5/consents/fetch retrieves a signed consent artefact by its consentId. The CM forwards the artefact to the requesting HIU after the patient grants approval through the CM application.
What are the rate limits for the Health Data Consent Manager?
Rate limits are not declared in the OpenAPI spec. The sandbox at dev.ndhm.gov.in/cm applies fair-use throttling for development; production limits depend on the CM operator's onboarding tier with the National Health Authority.
How do I initiate a consent request through Jentic?
Search Jentic for 'initiate NDHM consent request', load the schema for POST /v0.5/consent-requests/init, and execute with the HIU id, purpose, and date-range. The CM then prompts the patient and your callback handler receives the consent artefact.
How does this differ from the NDHM Gateway?
The Gateway is the central router across all roles. The Consent Manager is the patient-facing aggregator that holds consent records and presents the patient UI for grant or revocation. Most CM endpoints have a Gateway counterpart that forwards messages between roles.
Can I limit what my agent is allowed to do with the NDHM Health Data Consent Manager API?
Yes. Because you run Jentic One yourself, you decide which Consent Manager operations the agent may call and which credentials it may use. You can scope it to a single read operation such as fetching a consent artefact with POST /v0.5/consents/fetch, so heavier operations like POST /v0.5/health-information/request or the link-context writes at POST /v0.5/links/link/add-contexts are not available unless you add them. Since consent ids and care-context links travel in the request body rather than the URL, that operation-level allowlist is what controls the agent's reach.
GET STARTED