# Health Data Consent Manager API

> Health Data Consent Manager API on Apizie: 22 endpoints (Response to patient's account discovery request, Create consent request, Get consent request status, Get consent artefact, …) returned as clean JSON through one API key. 22 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-cm/{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-cm`
- Category: Open Data
- Status: live
- Source: https://ndhm.gov.in/
- Page: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-cm
- OpenAPI: https://zieapi.vercel.app/api/open-data/ndhm-gov-in-ndhm-cm/openapi.json

Entity which provides health information aggregation services to customers of health care services. It enables customers to fetch their health information from one or more Health Information Providers (e.g., Hospitals,…

## Endpoints

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

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

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

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

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

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

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

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

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

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-health-information-notify`

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

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

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

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

| 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-cm/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-cm/post-v0-5-links-link-add-contexts`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-links-link-on-confirm`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-links-link-on-init`

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-patients-profile-on-share`

| 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-cm/post-v0-5-subscription-requests-cm-init`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-subscription-requests-hiu-on-notify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-subscriptions-hiu-on-notify`

| 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-cm/post-v0-5-users-auth-confirm`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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-cm/post-v0-5-users-auth-fetch-modes`

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

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

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

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

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

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-cm/post-v0-5-care-contexts-on-discover" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Health Data Consent Manager API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/open-data:ndhm-gov-in-ndhm-cm/post-v0-5-care-contexts-on-discover with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Health Data Consent Manager 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 Data Consent Manager 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-cm.

### What is the status of the Health Data Consent Manager API?
Live: works with just an Apizie key
