Health Data Consent Manager
Entity which provides health information aggregation services to customers of health care services. It enables customers to fetch their health information…
Government & public#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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, Diagnostic Labs, Medical Device Companies), based on their explicit Consent and to share such
aggregated information with Health Information Users i.e. entities in need of such data (e.g., Insurers,
Doctors, Medical Researchers).
Specifications
- This document maintains only the Health Information Gateway relevant APIs.
Endpoints 22
user auth
- POSTConfirmation request sending token, otp or other authentication details from HIP/HIU for confirmation
/v0.5/users/auth/confirmThis API is called by HIP/HIUs to confirm authentication of users. The transactionId returned by the previous callback API /users/auth/on-init must be sent.… - POSTGet a patient's authentication modes relevant to specified purpose
/v0.5/users/auth/fetch-modesThis API is meant for identify supported authentication modes for a patient given a specific purpose - POSTInitialize authentication from HIP
/v0.5/users/auth/initThis API is called by HIPs to initiate authentication of users. A transactionId is retuned by the corresponding callback API for confirmation of user auth. - POSTcallback API from HIU/HIPs as acknowledgement of auth notification (in case of DIRECT auth)
/v0.5/users/auth/on-notifyThis API is called by HIU/HIPs to confirm acknowledgement for receipt of auth notification is case of DIRECT authentication.
identification
- POSTIdentify a patient by her consent-manager user-id
/v0.5/patients/findThis API is meant for identify to patient given her consent-manager-user-id. CM subsequently makes the /on-find Gateway API call with results.
profile
- POSTResponse to patient's share profile request
/v0.5/patients/profile/on-shareResult of patient share profile request at HIP end.
discovery
- POSTResponse to patient's account discovery request
/v0.5/care-contexts/on-discoverResult of patient care-context discovery request at HIP end. If a matching patient found with zero or more care contexts associated, it is specified as result…
link
- POSTAPI for HIP initiated care-context linking for patient
/v0.5/links/link/add-contextsAPI to submit care-context to CM for HIP initiated linking. The API must accompany the "accessToken" fetched in the users/auth process. 1. subsequent usage… - POSTToken authenticated by HIP, indicating completion of linkage of care-contexts
/v0.5/links/link/on-confirmReturns a list of linked care contexts with patient reference number. 1. Validated and linked account reference number 2. Validated that the token sent from… - POSTResponse to patient's care context link request
/v0.5/links/link/on-initResult of patient care-context link request from HIP end. This happens in context of previous discovery of patient found at HIP end, therefore the link…
consent
- POSTCreate consent request
/v0.5/consent-requests/initCreates a consent request to get data about a patient by HIU user. CM should call Gateway - */v0.5/consent-requests/on-init* API with the consent-request-id - POSTGet consent request status
/v0.5/consent-requests/statusGet status of consent request done previously. CM responds by calling Gateway API - */v0.5/consent-requests/on-status* - POSTGet consent artefact
/v0.5/consents/fetchThis API is called when a HIU makes a request to get a consent artefact. For response please refer to the Gateway */v0.5/consents/on-fetch* - POSTConsent notification
/v0.5/consents/hip/on-notifyThis API is called by HIP as acknowledgement to notification of consents, in cases of consent revocation and expiration, notified by CM earlier via Gateway… - POSTConsent notification
/v0.5/consents/hiu/on-notifyThis API is called by HIU as acknowledgement to consent notifications, specifically for cases when consent is REVOKED or EXPIRED, notified by CM earlier via…
data flow
- POSTNotifications corresponding to events during data flow
/v0.5/health-information/notifyAPI called by HIU and HIP during data-transfer. 1. HIP on transfer of data would send sessionStatus - one of [TRANSFERRED, FAILED] 2. HIP would also send… - POSTHealth information data request acknowledgement from HIP
/v0.5/health-information/on-requestThis API is called by HIP to acknowledge Health information request receipt. When HIU requests health information, CM generates a transactionId and makes a… - POSTHealth information data request from HIU
/v0.5/health-information/requestHIU request for Health information against a consent id. CM would generate a transactionId against each consent and pass it as trnasaction context /…
subscriptions
- POSTRequest for subscription
/v0.5/subscription-requests/cm/initcreates a request for subscription. The subscription categories can be for care-contexts linkages or availability of data against existing care-contexts. Note… - POSTCallback API for /subscription-requests/hiu/notify to acknowledge receipt of notification.
/v0.5/subscription-requests/hiu/on-notifyThis API is called by HIU as acknowledgement to subscription request relevant notifications. - POSTCallback API for /subscriptions/hiu/notify to acknowledge receipt of notification.
/v0.5/subscriptions/hiu/on-notifyThis API is called by HIU as acknowledgement to consent notifications, specifically for cases when consent is REVOKED or EXPIRED.
monitoring
- GETGet consent request status
/v0.5/heartbeat
API details
- Base URL
https://dev.ndhm.gov.in/cm- Authentication
- None declared in the description
- Operations
- 22 operations on 22 pathsPOST 21GET 1
- Main resources
- consent 5user auth 4data flow 3link 3subscriptions 3hip facing 2hiu facing 2discovery 1identification 1monitoring 1
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.0, API version
0.5 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Health Data Consent Manager in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Health Data Consent Manager collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation” (POST /v0.5/users/auth/confirm), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Health Data Consent Manager?
Entity which provides health information aggregation services to customers of health care services. It enables customers to fetch their health information… It is listed under Government & public and has 22 endpoints.
Who publishes the Health Data Consent Manager?
It is listed from Ndhm's public API description (an OpenAPI document), not published by Ndhm on Swastik Codes. Anyone who controls ndhm.gov.in can claim the profile by adding a DNS TXT record.
What is the base URL of the Health Data Consent Manager?
Requests go to https://dev.ndhm.gov.in/cm. Endpoint paths are added to this base URL.
How do I authenticate with the Health Data Consent Manager?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Health Data Consent Manager have?
22 operations on 22 paths (21 POST, 1 GET). The largest groups are consent, user auth, data flow, link.
Is forking the Health Data Consent Manager free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.