Health Repository Provider Specifications for HIP

Name: Health Repository Provider Specifications for HIP API
Brand: Health Repository Provider Specifications for HIP
Availability: InStock

★ 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.

Respond to patient discovery via /v0.5/care-contexts/on-discover with matching encounters

Link patient care contexts using /v0.5/links/link/init and /v0.5/links/link/confirm

Receive consent grant and revoke notifications at /v0.5/consents/hip/on-notify

Acknowledge HIU health information requests via /v0.5/health-information/hip/on-request

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 specification covers the endpoints a Health Information Provider must implement and call to participate in India's NDHM network as a record-holding party — typically a hospital, lab, or clinic. The 30 endpoints cover discovery callbacks, care-context linking, consent notification, encrypted health information transfer, and Gateway-facing helpers such as the certs and OpenID configuration. It is the producer side of the NDHM data flow.

Use Cases

Patterns agents use Health Repository Provider Specifications for HIP API for, with concrete tasks.

★ Hospital HIP Onboarding

A hospital implementing HIP responsibilities under NDHM exposes the discovery, link, consent, and data-transfer callbacks defined in this specification. When the Gateway broadcasts a discovery for a patient, the hospital responds with matching encounters, then handles the consent notification and serves the encrypted FHIR bundle on transfer. End-to-end onboarding takes 4-8 weeks of integration plus NHA certification.

POST /v0.5/care-contexts/on-discover with matching encounters for the patient identifiers received in the discovery callback.

Care Context Linking After Discharge

After a patient is discharged, the hospital initiates HIP-side care-context linking so future consent flows can target the encounter. The HIP calls /v0.5/links/link/add-contexts on the Consent Manager and handles the on-confirm callback locally. Once linked, the encounter becomes discoverable and shareable under the patient's ABHA id.

POST /v0.5/links/link/add-contexts with the patient ABHA id, the new encounter references, and the HIP's identifier.

Consent-Bound Record Transfer

When an HIU presents a granted consent artefact, the Gateway forwards a /v0.5/health-information/hip/request to the HIP. The HIP validates the consent artefact, packages the requested records as an encrypted FHIR bundle, acknowledges via /v0.5/health-information/hip/on-request, and transfers the bundle to the HIU via /v0.5/health-information/transfer. The whole flow is async and bound to the consent's validity window.

Validate the incoming consent artefact, then POST /v0.5/health-information/transfer with the encrypted FHIR bundle, key material reference, and the transaction id.

Agent-Driven HIP Operations

An AI agent embedded in a hospital information system uses Jentic to handle NDHM HIP callbacks without rebuilding the request signing and routing scaffolding. The agent searches for the right operation, loads the schema, and submits responses to discovery, link, and transfer events while Jentic manages the participant credentials.

Search Jentic for 'transfer encrypted health information from HIP', load the schema for /v0.5/health-information/transfer, and execute it with the encrypted bundle.

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/on-discover

Respond to patient care-context discovery

POST

/v0.5/links/link/init

Initiate care-context linking

POST

/v0.5/links/link/confirm

Confirm care-context linking

POST

/v0.5/links/link/add-contexts

Add new care contexts for a patient

POST

/v0.5/consents/hip/on-notify

Receive consent notification on HIP side

POST

/v0.5/health-information/hip/on-request

Acknowledge HIU health information request

POST

/v0.5/health-information/transfer

Transfer encrypted health records

POST

/v0.5/care-contexts/on-discover

Respond to patient care-context discovery

POST

/v0.5/links/link/init

Initiate care-context linking

POST

/v0.5/links/link/confirm

Confirm care-context linking

POST

/v0.5/links/link/add-contexts

Add new care contexts for a patient

POST

/v0.5/consents/hip/on-notify

Receive consent notification on HIP side

Why though Jentic?

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

Credential isolation

HIP signing keys, X-HIP-ID, and Gateway client secrets 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 'transfer encrypted health information from HIP' and Jentic returns the matching HIP operation with its input schema, removing the need to read the NDHM specifications.

Time to first call

Direct NDHM HIP integration: 4-8 weeks plus NHA certification. Through Jentic: under a day to call individual HIP operations with managed credentials, certification still required to operate as a participant.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

NDHM Gateway

Routes discovery, consent, and data calls to and from the HIP

Use when the agent must initiate cross-participant flows that the HIP responds to.

Complementary

NDHM HIU Specifications

Counterpart that consumes the records the HIP transfers

Use when the agent represents the requesting Health Information User rather than the record-holding HIP.

Complementary

Health Data Consent Manager

Issues the consent artefacts the HIP must validate before transferring records

Use when the agent must verify or fetch the consent artefact behind a HIP data request.

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?

The National Health Authority publishes HIP responsibilities as written specifications and reference Postman collections rather than an OpenAPI document. 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 NDHM 0.5 specification and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the NDHM HIP API use?

The OpenAPI spec does not declare a top-level security scheme because HIP endpoints validate Gateway-issued JWTs against the certificates published at /v0.5/certs and require the X-HIP-ID header. Through Jentic the HIP signing keys and id are stored encrypted in the vault and applied at execution time, so the agent context never sees the long-lived secret.

Can I transfer encrypted health records with the HIP API?

Yes. After validating an inbound consent artefact, POST /v0.5/health-information/transfer with the encrypted FHIR bundle, the key material reference, and the transaction id matching the HIU's original /v0.5/health-information/hip/request.

What are the rate limits for the HIP API?

The NDHM 0.5 specification does not publish per-endpoint rate limits in the OpenAPI document; throughput is governed by the participant onboarding agreement with the National Health Authority. Treat the dev.ndhm.gov.in/gateway sandbox as low-throughput and back off on 429 or 503 responses.

How do I link a care context through Jentic?

Run pip install jentic, then search for 'link a care context for a patient', load the schema for POST /v0.5/links/link/add-contexts, and execute it with the patient ABHA id and the new encounter references. Jentic returns the on-confirm acknowledgement payload.

Does the HIP API issue consent artefacts?

No. The HIP only consumes consent artefacts and serves records under their scope. Issuing artefacts is the responsibility of the Consent Manager, called via /v0.5/consent-requests/init on the Gateway.