# Health Repository Provider Specifications for HIU API

> Health Repository Provider Specifications for HIU API on Apizie: 32 endpoints (Get openid configuration, Get certs for JWT verification, Create consent request, Response to consent request, …) returned as clean JSON through one API key. 32 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:ndhm-gov-in-ndhm-hiu`
- Category: Open Data
- Status: live
- Source: https://ndhm.gov.in/
- Page: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-hiu
- OpenAPI: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-hiu/openapi.json

The following are the specifications for the APIs to be implemented at the Health Repository end if an entity is only serving the role of a HIU. The specs are essentially duplicates from the Gateway and Bridge, but put…

## Endpoints

### Get openid configuration
`GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-well-known-openid-configuration`

### Get certs for JWT verification
`GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-certs`

### Create consent request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Response to consent request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-on-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Result of consent request status
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-on-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Get consent request status
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consent-requests-status`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Get consent artefact
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-fetch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Consent notification
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-hiu-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Consent notification
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-hiu-on-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Result of fetch request for a consent artefact
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-consents-on-fetch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Health information data request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-cm-request`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Health information data request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-hiu-on-request`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Notifications corresponding to events during data flow
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### health information transfer API
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-health-information-transfer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get consent request status
`GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-heartbeat`

### Identify a patient by her consent-manager user-id
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-patients-find`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Identification result for a consent-manager user-id
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-patients-on-find`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get access token
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-sessions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Request for subscription
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-cm-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Notification for subscription grant/deny/revoke
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the…
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-on-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscription-requests-hiu-on-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Notification to HIU on basis of a granted subscription
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscriptions-hiu-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification.
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-subscriptions-hiu-on-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-confirm`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Get a patient's authentication modes relevant to specified purpose
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-fetch-modes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### Initialize authentication from HIP
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

### notification API in case of DIRECT mode of authentication by the CM
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider to which the request was intended. |
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-confirm`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider to which the request was intended. |
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Identification result for a consent-manager user-id
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-fetch-modes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider to which the request was intended. |
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### Response to user authentication initialization from HIP
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider to which the request was intended. |
| X-HIU-ID | string | yes | Identifier of the health information user to which the request was intended. |
| body | object | yes | JSON request body |

### callback API by HIU/HIPs as acknowledgement of auth notification
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/post-v0-5-users-auth-on-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-CM-ID | string | yes | Suffix of the consent manager to which the request was intended. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-well-known-openid-configuration" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Health Repository Provider Specifications for HIU API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hiu/get-v0-5-well-known-openid-configuration with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Health Repository Provider Specifications for HIU API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Health Repository Provider Specifications for HIU API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:ndhm-gov-in-ndhm-hiu.

### What is the status of the Health Repository Provider Specifications for HIU API?
Live: works with just an Apizie key