Ndhm Health Repository Provider Specifications for HIP

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.

Can I limit what my agent is allowed to do with the NDHM HIP API?

Yes. Because you run Jentic One yourself, your own rules decide which of the HIP operations and which signing credentials the agent can use, and it can call only the ones you select. For example, you can allow the agent to confirm a care-context link through /v0.5/links/link/confirm and transfer an encrypted FHIR bundle through /v0.5/health-information/transfer while keeping consent-notification handling at /v0.5/consents/hip/on-notify out of scope until you add it. The link, care-context, and transfer targets travel inside the signed request body rather than the URL path, so scoping is enforced at the operation level rather than by parsing paths.