Health Repository Provider Specifications for HIU

★ Only Publicly Available OpenAPI DocumentHealthcareEhr Emrnone32 EndpointsREST

For Agents

Connect the Health Repository Provider Specifications for HIU 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 HIU, 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 HIU API.

Initiate consent requests for patient health information by ABHA identifier

Receive consent grant, denial, expiry, and revocation notifications from the Gateway

Request encrypted health-information bundles from the Consent Manager and HIPs

Acknowledge data-transfer events and report delivery success or failure

GET STARTED

Start building with Health Repository Provider Specifications for HIU API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for Health Repository Provider Specifications for HIU, keeping it validated and agent-ready. This spec bundles the 32 endpoints that an entity acting as a Health Information User (HIU) must implement and consume to participate in India's NDHM network. It draws operations from the Gateway and Bridge specs and groups them under identification, consent flow, data flow, subscriptions, and monitoring — making it clear which calls an HIU originates against the Gateway and which callbacks the Gateway invokes against the HIU.

Use Cases

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

★ Insurance Claim Document Pulls

An insurance HIU integrates with NDHM to pull discharge summaries and lab reports from hospitals when a claim is filed. The HIU initiates a consent request via /v0.5/consent-requests/init on the Gateway, the patient grants approval through their CM, and the HIU then requests the data bundle. Replaces fax and email document collection with a signed consent flow.

Call POST /v0.5/consent-requests/init via the Gateway; on /consents/hiu/notify, call POST /v0.5/health-information/cm/request

Telemedicine HIU for Cross-Hospital History

A telemedicine app needs longitudinal patient history before a consultation. As an HIU, it initiates a consent request scoped to the past two years, receives consent artefacts, and pulls bundles from each HIP that holds matching records. The HIU spec defines the callbacks the Gateway invokes during this flow.

Initiate a consent request with HI types DiagnosticReport and DischargeSummary; on data-flow notify, decrypt and store the bundle

Research-Use HIU for De-Identified Data

A clinical research platform acts as an HIU to gather de-identified patient histories for cohort studies. The platform asks patients to consent to research-purpose access, then pulls bundles strictly within the consented scope and time window. Audit notifications back to the Gateway create the trail required for ethics review.

Issue a consent request with purpose=PUBHLTH for the cohort and listen for /consents/hiu/on-notify to enumerate granted artefacts

Agent-Driven HIU Operations

An AI agent inside an HIU app handles the consent-request lifecycle on behalf of an end user — issuing the request, polling status, and receiving bundles. Jentic resolves the natural-language request to the right /consent-requests, /consents, and /health-information endpoints and signs payloads from the encrypted vault.

Search Jentic for 'NDHM HIU initiate consent request', execute POST /v0.5/consent-requests/init with HIU id and purpose

Key Endpoints

32 endpoints — jentic publishes the only available openapi specification for health repository provider specifications for hiu, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v0.5/consent-requests/init

Initiate a consent request as an HIU

POST

/v0.5/consent-requests/on-init

Receive consent-request acknowledgement

POST

/v0.5/consents/fetch

Fetch a consent artefact

POST

/v0.5/consents/hiu/notify

Receive consent decision notification

POST

/v0.5/health-information/cm/request

Request a health-information bundle

POST

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

Receive data-request acknowledgement

POST

/v0.5/consent-requests/init

Initiate a consent request as an HIU

POST

/v0.5/consent-requests/on-init

Receive consent-request acknowledgement

POST

/v0.5/consents/fetch

Fetch a consent artefact

POST

/v0.5/consents/hiu/notify

Receive consent decision notification

POST

/v0.5/health-information/cm/request

Request a health-information bundle

Why though Jentic?

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

Credential isolation

JWT signing keys and HIU 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., 'NDHM HIU initiate consent request') and Jentic returns POST /v0.5/consent-requests/init with its schema, so the agent supplies HIU id and purpose without browsing 32 paths across initiator and callback roles.

Time to first call

Direct HIU integration: 3-6 weeks including JWT setup, callback handling, decryption, and NHA certification. Through Jentic: under a week for the consent and data-flow scaffolding.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

NDHM Gateway

The Gateway routes the HIU's consent and data requests to the CM and HIPs.

Use the Gateway as the orchestrator; use the HIU spec when implementing the data-consumer side of the network.

Complementary

NDHM HIP Specifications

Defines the provider-side counterpart that supplies records to the HIU.

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

Complementary

NDHM Health Data Consent Manager

The CM mediates consent grants and forwards data requests on behalf of the HIU.

Use the CM for the patient-facing consent UI; use the HIU spec for the relying app that requests records.

FAQs

Specific to using Health Repository Provider Specifications for HIU API through Jentic.

Why is there no official OpenAPI spec for Health Repository Provider Specifications for HIU?

NDHM does not publish a maintained OpenAPI specification for the HIU 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 HIU 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 HIU specification require?

HIU 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 initiate a consent request as an HIU through this spec?

Yes. POST /v0.5/consent-requests/init starts the flow on the Gateway with the HIU id, purpose, HIP scope, and time range. The CM then prompts the patient and your /v0.5/consents/hiu/notify endpoint receives the consent artefact reference.

What are the rate limits for the HIU endpoints?

Rate limits are not declared in the OpenAPI spec. The sandbox at dev.ndhm.gov.in applies fair-use throttling for development; production rate limits depend on the HIU's onboarding tier with the National Health Authority and the volume of consents in flight.

How do I request a health-information bundle through Jentic?

Search Jentic for 'request NDHM health-information bundle as HIU', load the schema for POST /v0.5/health-information/cm/request, and execute with the granted consent artefact reference. The CM forwards the request to the HIP, which transfers the encrypted bundle to your /on-request endpoint.