Health Repository Provider Specifications for HIP

★ Only Publicly Available OpenAPI DocumentHealthcareEhr Emrnone30 EndpointsREST

For Agents

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.

Install Jentic One Beta (Self-Hosted)

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 | sh

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 instance

Jentic 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

GET STARTED

Start building with Health Repository Provider Specifications for HIP API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Health Repository Provider Specifications for HIP, keeping it validated and agent-ready.

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.

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 the Jentic vault.

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

JWT signing keys and HIP client credentials are stored encrypted in the Jentic vault. Agents receive scoped execution tokens — private keys and raw bearer tokens never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'transfer NDHM health-information bundle') and Jentic returns POST /v0.5/health-information/transfer with its schema, so the agent supplies the encrypted bundle without browsing 30 paths.

Time to first call

Direct HIP integration: 3-6 weeks including JWT setup, encryption-key handling, and NHA certification. Through Jentic: under a week for the discovery, link, and data-flow scaffolding.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

NDHM Gateway

The Gateway routes discovery, consent, and data requests to the HIP and aggregates responses.

Use the Gateway as the orchestrator; use the HIP spec when implementing the provider side of the network.

Complementary

NDHM HIU Specifications

Defines the consumer-side counterpart that requests and receives health information from the HIP.

Use the HIP spec when serving records; use the HIU spec when consuming them.

Complementary

NDHM Health ID Service

HIPs identify patients by the ABHA Health ID issued by this service.

Use the Health ID Service to resolve or issue ABHA; use the HIP spec to link those patients' care contexts.

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 at https://app.jentic.com/sign-up.

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.