Ndhm Health Repository Provider Specifications for HIP
Browse all Ndhm APIs52
AI ReadinessFoundational (C-)52/100
Agent-ready OpenAPI document · curated by JenticHealthcareEhr Emrnone30 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Implement the HIP role in the NDHM network - handling care-context discovery, link confirmations, consent notifications, and encrypted health-information transfers.
Use for: I need to respond to a care-context discovery request, Confirm a patient-initiated link with the patient's OTP, Acknowledge a consent grant notification, Transfer a health-information bundle to the HIU
Not supported: Does not run the patient-facing consent UI, issue ABHA Health IDs, or consume records as an HIU - use for the provider-side discovery, linking, consent, and data-transfer role only.
Jentic publishes the only available OpenAPI specification for Health Repository Provider Specifications for HIP, keeping it validated and agent-ready. This spec bundles the 30 endpoints that an entity acting as a Health Information Provider (HIP) must implement to participate in India's NDHM network. It draws operations from the Gateway and Health Repository specs and groups them so HIPs can implement only what is required of them - covering care-context discovery, account linking, consent-grant notifications, health-information data requests, encrypted transfers, and heartbeat monitoring.
Install Jentic One Beta
Connect the Health Repository Provider Specifications for HIP to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Health Repository Provider Specifications for HIP, 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-hip-specifications" | 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-hip-specifications" | 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 Repository Provider Specifications for HIP API.
Receive and respond to care-context discovery requests for a patient by ABHA identifier
Confirm patient-initiated and HIP-initiated care-context linkages with token verification
Process consent notifications and acknowledge consent grants and revocations
Handle health-information data requests by encrypting and transferring the bundle to the HIU
Notify the Gateway of data-flow events including delivery success or failure
Expose JWT verification certificates and a heartbeat endpoint for monitoring
Use Cases
Patterns agents use Health Repository Provider Specifications for HIP API for, with concrete tasks.
★ Hospital HIP Onboarding to NDHM
A hospital integrates its EHR system as a Health Information Provider on the NDHM network. The HIP spec defines the 30 endpoints the hospital must expose so the Gateway can discover patient records, request data on behalf of HIUs, and notify the hospital of consent events. Following this contract is the path to NDHM certification.
Implement POST /v0.5/care-contexts/discover and reply via POST /v0.5/care-contexts/on-discover with the patient's care contexts
Consent-Authorised Data Delivery
When a patient grants consent and an HIU requests their data, the HIP receives a request, encrypts the bundle with the consent-supplied keys, transfers it to the HIU, and notifies the Gateway. POST /v0.5/health-information/hip/request, /transfer, and /notify together implement the encrypted exchange. Replaces ad-hoc fax or PDF sharing.
On receiving POST /v0.5/health-information/hip/request, fetch the records, encrypt them with the keyMaterial, and POST /v0.5/health-information/transfer
Care-Context Linking Confirmation
A patient links their account in the CM to their record at the hospital. The hospital's HIP service confirms the link by validating an OTP or token, then exposes the patient's care contexts to future discovery requests. POST /v0.5/links/link/add-contexts and /on-confirm implement this flow.
Receive POST /v0.5/links/link/on-confirm with the link token and persist the linkage in the HIP database
Agent-Driven HIP Test Harness
A QA agent in a hospital integration project simulates Gateway events against the HIP server during certification testing. The agent uses Jentic to look up the right operation, send a sample request, and assert the response. JWT signing keys remain in your Jentic One instance.
Search Jentic for 'send NDHM care-context discovery to a HIP', execute POST /v0.5/care-contexts/discover and assert the on-discover callback
Key Endpoints
30 endpoints — jentic publishes the only available openapi specification for health repository provider specifications for hip, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v0.5/care-contexts/discover
Receive a care-context discovery request
POST
/v0.5/care-contexts/on-discover
Reply with the patient's care contexts
POST
/v0.5/links/link/on-confirm
Confirm linkage with token
POST
/v0.5/health-information/hip/request
Receive a health-information data request
POST
/v0.5/health-information/transfer
Transfer encrypted health-information bundle
POST
/v0.5/consents/hip/notify
Receive consent notification
POST
/v0.5/care-contexts/discover
Receive a care-context discovery request
POST
/v0.5/care-contexts/on-discover
Reply with the patient's care contexts
POST
/v0.5/links/link/on-confirm
Confirm linkage with token
POST
/v0.5/health-information/hip/request
Receive a health-information data request
POST
/v0.5/health-information/transfer
Transfer encrypted health-information bundle
POST
/v0.5/consents/hip/notify
Receive consent notification
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 Repository Provider Specifications for HIP
- Foundational (C-)52/100
99
Foundational Compliance70
Developer Experience & Jentic Compatibility23
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.
70
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.
94%
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.
23
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 HIP provider specification by hand means implementing the signed request/callback exchange, generating and rotating JWT signing keys, and matching each care-context, link, and health-information message to the gateway host yourself. Through Jentic you install once, import the HIP specification from the API Directory, store the signing credentials once, and your agent calls it.
Permission scoping
The HIP callbacks carry the care-context, link, and transfer targets inside the signed request body rather than in the URL path, so you limit the agent to the operations it needs, such as care-contexts on-discover or health-information transfer. Because you pick that operation set, the agent cannot invoke a callback you did not include.
Credential isolation
Your HIP signing keys and client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'transfer an NDHM health-information bundle' or 'respond to a care-context discovery', and Jentic returns the matching HIP operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Health Repository Provider Specifications for HIP API through Jentic.
Why is there no official OpenAPI spec for Health Repository Provider Specifications for HIP?
NDHM does not publish a maintained OpenAPI specification for the HIP 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 Repository Provider Specifications for HIP 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 HIP specification require?
HIP endpoints are secured with signed JWTs issued through the NDHM Gateway and validated against certificates fetched from /v0.5/certs. The OpenAPI spec leaves `securitySchemes` empty because authorisation is enforced at the JWT layer rather than via a standard HTTP scheme.
Can I respond to care-context discovery requests through this spec?
Yes. Implement POST /v0.5/care-contexts/discover to receive the request and POST /v0.5/care-contexts/on-discover to reply with matching care contexts. The Gateway broadcasts discovery requests to all registered HIPs and aggregates the responses.
What are the rate limits for the HIP endpoints?
Rate limits are not declared in the OpenAPI spec. The sandbox at dev.ndhm.gov.in applies fair-use throttling for development; production is governed by the HIP's onboarding tier with the National Health Authority and the volume of patients linked to the HIP.
How do I transfer a health-information bundle through Jentic?
Search Jentic for 'transfer NDHM health-information bundle', load the schema for POST /v0.5/health-information/transfer, and execute with the encrypted FHIR bundle and key material from the original request. Notify the Gateway of delivery via POST /v0.5/health-information/notify.
Can I limit what my agent is allowed to do with the NDHM HIP Specifications API?
Yes. Because you run Jentic One yourself, your own rules decide which HIP operations and signing credentials the agent may use, so you can grant it only the callbacks it needs, such as care-contexts on-discover or health-information transfer, and withhold the rest. The HIP messages carry the care-context, link, and transfer targets inside the signed request body rather than the URL, so scoping happens at the operation level you choose. If you do not include a callback in that set, the agent cannot invoke it.
GET STARTED