Ndhm Health Data Consent Manager
Browse all Ndhm APIs★ Only Publicly Available OpenAPI DocumentHealthcareEhr Emrnone22 EndpointsREST
For Agents
Raise patient consent requests, fetch signed consent artefacts, and coordinate health record exchange between Indian Health Information Providers and Users under NDHM rules.
Use for: I need to raise a consent request for a patient's lab reports, Fetch the signed consent artefact for an approved request, Check the status of a pending consent request, Notify a Health Information Provider that consent was granted
Not supported: Does not store clinical records, issue ABHA identifiers, or process payments — use for orchestrating NDHM patient consent only.
Jentic publishes the only available OpenAPI specification for Health Data Consent Manager, keeping it validated and agent-ready. The Health Data Consent Manager API implements India's National Digital Health Mission (NDHM) Consent Manager role, allowing patients to authorise the aggregation and sharing of medical records across hospitals, diagnostic labs, insurers, and researchers. It exposes endpoints for raising consent requests, fetching signed consent artefacts, notifying Health Information Providers and Users about consent state changes, and orchestrating the resulting data flow. The 22 endpoints cover discovery, linking, consent lifecycle, and health information transfer flows defined in the NDHM 0.5 specification.
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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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.
Initiate patient consent requests for sharing medical records between Health Information Providers and Users
Fetch signed consent artefacts via /v0.5/consents/fetch for downstream verification
Notify HIPs and HIUs of consent grant, revoke, or expiry events through the on-notify callbacks
Discover patient care contexts across hospitals using /v0.5/care-contexts/on-discover
Link patient care contexts across providers via /v0.5/links/link/add-contexts
Coordinate health information requests and acknowledgements between HIU and HIP roles
Use Cases
Patterns agents use Health Data Consent Manager API for, with concrete tasks.
★ Patient-Initiated Health Record Sharing
Allow a patient to authorise an insurer or doctor to access their lab reports and discharge summaries held at multiple hospitals. The Consent Manager raises the consent request, collects the patient approval, and issues a signed consent artefact that the Health Information User presents to providers when fetching records. Integration follows the NDHM 0.5 flow with discovery, link, consent, and data transfer phases.
POST /v0.5/consent-requests/init with the HIU id, patient ABHA id, requested HI types, and validity window, then poll /v0.5/consent-requests/status until the artefact is granted.
Insurer Claims Verification
Health insurers verify treatment claims by requesting consented access to specific encounters at hospitals. The Consent Manager scopes the consent to the relevant care contexts and date range, and notifies the HIP via /v0.5/consents/hip/on-notify when access is granted. The insurer's HIU then issues /v0.5/health-information/request to retrieve the encrypted records covered by the artefact.
Create a consent request scoped to encounters between two dates for a given hospital, fetch the artefact, then call /v0.5/health-information/request with the consent id.
Care Context Linking After Hospital Admission
After a patient is admitted, the hospital can initiate care-context linking so that the encounter becomes discoverable under the patient's ABHA id. The Consent Manager processes /v0.5/links/link/add-contexts, validates the patient identifier, and confirms linkage via /v0.5/links/link/on-confirm. Once linked, the encounter is available for future consent-based retrieval.
POST /v0.5/links/link/add-contexts with the patient ABHA id and the new care-context references for an admission encounter.
Agent-Driven Health Record Aggregation
An AI agent acting on behalf of a patient can use Jentic to discover NDHM consent operations, raise consent for specified Health Information types, and orchestrate the artefact fetch and downstream data request without hard-coding NDHM endpoint paths. The agent retrieves operation schemas at runtime, so it can adapt as the NDHM spec evolves.
Search Jentic for 'raise patient consent request', load the schema for /v0.5/consent-requests/init, and execute the call with patient and HIU parameters.
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/consent-requests/status
Get consent request status
POST
/v0.5/consents/fetch
Get a signed consent artefact
POST
/v0.5/consents/hip/on-notify
Notify HIP of consent state change
POST
/v0.5/consents/hiu/on-notify
Notify HIU of consent state change
POST
/v0.5/care-contexts/on-discover
Respond to patient care-context discovery
POST
/v0.5/links/link/add-contexts
Link new care contexts for a patient
POST
/v0.5/health-information/request
HIU request for health information
POST
/v0.5/consent-requests/init
Create a consent request
POST
/v0.5/consent-requests/status
Get consent request status
POST
/v0.5/consents/fetch
Get a signed consent artefact
POST
/v0.5/consents/hip/on-notify
Notify HIP of consent state change
POST
/v0.5/consents/hiu/on-notify
Notify HIU of consent state change
POST
/v0.5/care-contexts/on-discover
Respond to patient care-context discovery
POST
/v0.5/links/link/add-contexts
Link new care contexts for a patient
POST
/v0.5/health-information/request
HIU request for health information
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
NDHM participant JWT signing keys and X-HIU-ID/X-HIP-ID headers are stored encrypted in the Jentic vault. Agents receive scoped tokens at execution time so raw signing material never enters agent context.
Intent-based discovery
Agents search by intent such as 'raise a patient consent request' and Jentic returns the matching NDHM CM operation with its input schema, removing the need to read the NDHM specification PDFs.
Time to first call
Direct NDHM CM integration: 2-4 weeks to build participant onboarding, JWT signing, and async callback handling. Through Jentic: under a day to call the consent flow with managed credentials.
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?
The National Health Authority publishes the NDHM specifications as documentation rather than a machine-readable OpenAPI file. 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 published NDHM 0.5 specification and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Health Data Consent Manager use?
The OpenAPI spec does not declare a security scheme because NDHM authentication is handled out-of-band via the Gateway-issued JWT and X-HIU-ID/X-HIP-ID headers configured per participant. Through Jentic the participant credentials are stored encrypted in the Jentic vault and injected at execution time, so the agent context never sees the raw JWT signing keys.
Can I raise a patient consent request with the Health Data Consent Manager API?
Yes. POST to /v0.5/consent-requests/init with the requesting HIU id, the patient's consent-manager user id, the requested Health Information types and date range. The request is acknowledged synchronously and the resulting artefact is delivered asynchronously via /v0.5/consent-requests/on-init.
What are the rate limits for the Health Data Consent Manager?
The NDHM 0.5 specification does not publish per-endpoint rate limits in the spec; limits are negotiated per participant agreement with the National Health Authority. Treat the sandbox at dev.ndhm.gov.in/cm as low-throughput and back off on 429 or 503 responses.
How do I fetch a consent artefact through Jentic?
Run pip install jentic, then search for 'fetch consent artefact', load the schema for POST /v0.5/consents/fetch, and execute with the consent id from the on-init callback. Jentic returns the signed artefact JSON ready to be presented to a HIP.
Does the Health Data Consent Manager handle clinical record storage?
No. The Consent Manager only orchestrates consent and routing. The actual encrypted health records are exchanged via the HIP /v0.5/health-information/request and /v0.5/health-information/transfer endpoints between the HIP and HIU.
GET STARTED