# Health Repository Provider Specifications for HIP API

> Health Repository Provider Specifications for HIP API on Apizie: 30 endpoints (Get openid configuration, Discover patient's accounts, Response to patient's account discovery request, Get certs for JWT verification, …) returned as clean JSON through one API key. 30 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/{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-hip`
- Category: Open Data
- Status: live
- Source: https://ndhm.gov.in/
- Page: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-hip
- OpenAPI: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-hip/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 HIP. The specs are essentially duplicates from the Gateway and Health…

## Endpoints

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

### Discover patient's accounts
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-care-contexts-discover`

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

### Response to patient's account discovery request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-care-contexts-on-discover`

| 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 certs for JWT verification
`GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/get-v0-5-certs`

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider 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-hip/post-v0-5-consents-hip-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 |

### Health information data request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-health-information-hip-on-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-hip/post-v0-5-health-information-hip-request`

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-HIP-ID | string | yes | Identifier of the health information provider 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-hip/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-hip/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-hip/get-v0-5-heartbeat`

### API for HIP initiated care-context linking for patient
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-add-contexts`

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

### Token submission by Consent Manager for link confirmation
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-confirm`

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

### Link patient's care contexts
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-init`

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

### callback API for HIP initiated patient linking /link/add-context
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-on-add-contexts`

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

### Token authenticated by HIP, indicating completion of linkage of care-contexts
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-on-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 |

### Response to patient's care context link request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-links-link-on-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 patient's share profile request
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-patients-profile-on-share`

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

### Share patient profile details
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-patients-profile-share`

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

### API for HIP to send SMS notifications to patients
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-patients-sms-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 |

### Acknowledgment response for SMS notification sent to patient by HIP
`POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/post-v0-5-patients-sms-on-notify`

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-hip/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-hip/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-hip/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-hip/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-hip/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-hip/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-hip/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-hip/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-hip/get-v0-5-well-known-openid-configuration" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Health Repository Provider Specifications for HIP API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-hip/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 HIP 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 HIP 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-hip.

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