It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are issued to the right individual or accessed by a Health Information User through appropriate consent. In order to issue a Health ID to an individu
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://healthidsbx.ndhm.gov.in/api https://dev.ndhm.gov.in/gateway https://dev.ndhm.gov.in/cm
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are issued to the right individual or accessed by a Health Information User through appropriate consent. In order to issue a Health ID to an individual, one only needs basic demographic details like Name, Year of Birth, Gender. In addition, citizens
| method | path | what the vendor says it does |
|---|---|---|
POST | /v1/account/aadhaar/generateOTP | Generate Aadhaar OTP on registrered for link account with aadhar number Generate Aadhaar OTP on registrered fo |
POST | /v1/account/aadhaar/verifyOTP | Verify Aadhaar OTP to complete KYC/re-KYC verification. Verify Aadhaar OTP to complete KYC/re-KYC verification |
GET | /v1/account/benefits | Get List of Benefits associated with HealthID. Profile |
POST | /v1/account/change/passwd/byAadhaar | Change password via Aadhar for heath id. Change password via Aadhar for heath id. Profile |
POST | /v1/account/change/passwd/byMobile | Change password via mobile for heath id. Change password via mobile for heath id. Profile |
GET | /v1/account/change/passwd/generateAadhaarOTP | Generate Aadhaar OTP on registrered mobile number. Generate Aadhaar OTP on registrered mobile number. Profile |
GET | /v1/account/change/passwd/generateMobileOTP | Generate Mobile OTP to start registration. Generate Mobile OTP to start registration. Profile |
POST | /v1/account/change/password | Change password via password for heath id. Change password via password for heath id. Profile |
GET | /v1/account/getCard | Generate Health ID card in PDF format Profile |
GET | /v1/account/getPngCard | Generate Health ID card PNG Profile |
GET | /v1/account/getSvgCard | Generate Health ID card SVG Profile |
GET | /v1/account/profile | Get account information. Profile |
POST | /v1/account/profile | Update account information Profile |
DELETE | /v1/account/profile | Delete account Profile |
GET | /v1/account/qrCode | Get Quick Response code in PNG format for this account. Profile |
POST | /v1/account/token | Validate auth token Profile |
POST | /v1/auth/authPassword | Authenticate using Health ID number / Health ID and password Authentication |
POST | /v1/auth/authWithMobile | Authenticate request to generate Mobile OTP using Health ID number / Health ID Authentication |
POST | /v1/auth/authWithMobileToken | Authenticate using verified Mobile Number and user data Authentication |
GET | /v1/auth/cert | Auth token public key. Authentication |
POST | /v1/auth/confirmWithAadhaarBio | Authentication with Aadhaar Biometric based auth transaction. Authentication |
POST | /v1/auth/confirmWithAadhaarOtp | Authentication with Aadhaar OTP based auth transaction. Authentication |
POST | /v1/auth/confirmWithDemographics | Authenticate using demographic data of user. Authentication |
POST | /v1/auth/confirmWithMobileOTP | Authentication with Mobile OTP based auth transaction. Authentication |
POST | /v1/auth/confirmWithPassword | Authentication with PASSWORD based auth transaction. Authentication |
POST | /v1/auth/init | Initiate authentication process for given Health ID Authentication |
POST | /v1/auth/resendAuthOTP | Resend Aadhaar/Mobile OTP for Authentication Transaction. Authentication |
POST | /v1/forgot/healthId/aadhaar | Verify aadhar OTP sent as part of forgetHealth id. Verify aadhar OTP sent as part of forgetHealth id. Forgot h |
POST | /v1/forgot/healthId/aadhaar/generateOtp | Generate Aadhaar OTP on registrered mobile number Generate Aadhaar OTP on registrered mobile number Forgot hea |
POST | /v1/forgot/healthId/mobile | Verify Mobile OTP sent as part of forgetHealth id. Verify Mobile OTP sent as part of forgetHealth id. Forgot |
POST | /v1/forgot/healthId/mobile/generateOtp | Generate Mobile OTP to start registration Generate Mobile OTP to start registration transaction. Forgot health |
GET | /v1/ha/lgd/districts | Get a list of districts in a given State as per LGD. Utility |
GET | /v1/ha/lgd/states | Get a list of states as per LGD. Utility |
GET | /v1/ha/tags | Get list of Tags against HealthID. Tags |
POST | /v1/ha/tags | Add tag against HealthId. Tags |
DELETE | /v1/ha/tags | Delete tag against HealthId. Tags |
POST | /v1/health/facility/authenticate | Generate token for heath facility id. Generate token for heath facility id. Health Facility |
POST | /v1/health/facility/change/password | Change password for heath facility id. Change password for heath facility id. Health Facility |
POST | /v1/health/facility/createHealthIdWithPreVerified | Generate Health ID card SVG Health Facility |
POST | /v1/health/facility/generate/password | Generates password for heath facility id. Generates password for heath facility id. Health Facility |
and 33 more operation(s) in this specification, all searchable.
specification origin: https://apisetu.gov.in/api_specification_v8/ndhm-healthid.yaml
Gateway is the hub that routes/orchestrates the interaction between consent managers and API bridges. There are 5 categories of APIs; discovery, link, consent flow, data flow and monitoring. To reflect the consumers of APIs, the above apis are also categorized under cm facing, hiu facing and hip facing
| method | path | what the vendor says it does |
|---|---|---|
GET | /v0.5/.well-known/openid-configuration | Get openid configuration sessions |
POST | /v0.5/care-contexts/discover | Discover patient's accounts Request for patient care context discover, made by CM for a specific HIP. It is ex |
POST | /v0.5/care-contexts/on-discover | Response to patient's account discovery request Result of patient care-context discovery request at HIP end. I |
GET | /v0.5/certs | Get certs for JWT verification sessions |
POST | /v0.5/consent-requests/init | Create consent request Creates a consent request to get data about a patient by HIU user. consent flow hiu fac |
POST | /v0.5/consent-requests/on-init | Response to consent request Result of consent request creation for a patient. **consentRequest.id** represents |
POST | /v0.5/consent-requests/on-status | Result of consent request status Result of consent request done previously. Status of request can be GRANTED, |
POST | /v0.5/consent-requests/status | Get consent request status Get status of consent request done previously consent flow hiu facing |
POST | /v0.5/consents/fetch | Get consent artefact consent flow hiu facing |
POST | /v0.5/consents/hip/notify | Consent notification Notification of consents to health information providers consent request granted, consent |
POST | /v0.5/consents/hip/on-notify | Consent notification This API is called by HIP as acknowledgement to notification of consents, in cases of con |
POST | /v0.5/consents/hiu/notify | Consent notification Health information user will get notified about the consent request granted or denied, co |
POST | /v0.5/consents/hiu/on-notify | Consent notification This API is called by HIU as acknowledgement to consent notifications, specifically for c |
POST | /v0.5/consents/on-fetch | Result of fetch request for a consent artefact Must contain either consentDetail or error. Possible reason of |
POST | /v0.5/health-information/cm/on-request | Health information data request Callback API for acknowledgement of Health information request of HIU. CM call |
POST | /v0.5/health-information/cm/request | Health information data request Request for Health information against a consent id. CM would generate a trans |
POST | /v0.5/health-information/hip/on-request | Health information data request API called by HIP to acknowledge Health information request receipt. Either th |
POST | /v0.5/health-information/hip/request | Health information data request API called by CM to request Health information from HIP against a validated co |
POST | /v0.5/health-information/notify | Notifications corresponding to events during data flow API called by HIU and HIP during data-transfer. 1. HIP |
GET | /v0.5/heartbeat | Get consent request status monitoring |
GET | /v0.5/hi-services/{service-id} | Get bridge service details/profile by the serviceId provided. This API is meant for displaying the bridge serv |
POST | /v0.5/links/link/add-contexts | API for HIP initiated care-context linking for patient API to submit care-context to CM for HIP initiated link |
POST | /v0.5/links/link/confirm | Token submission by Consent Manager for link confirmation API to submit the token that was sent by HIP during |
POST | /v0.5/links/link/init | Link patient's care contexts Request from CM to links care contexts associated with only one patient 1. **Va |
POST | /v0.5/links/link/on-add-contexts | callback API for HIP initiated patient linking /link/add-context If the accessToken is valid for purpose of li |
POST | /v0.5/links/link/on-confirm | Token authenticated by HIP, indicating completion of linkage of care-contexts Returns a list of linked care co |
POST | /v0.5/links/link/on-init | Response to patient's care context link request Result of patient care-context link request from HIP end. This |
POST | /v0.5/patients/find | Identify a patient by her consent-manager user-id This API is meant for identify to patient given her consent- |
POST | /v0.5/patients/on-find | Identification result for a consent-manager user-id If a patient is found then patient.name contains the patie |
POST | /v0.5/patients/profile/on-share | Response to patient's share profile request Result of patient share profile request at HIP end. profile |
POST | /v0.5/patients/profile/share | Share patient profile details Request for sharing patient's profile details to HIP profile cm facing |
POST | /v0.5/patients/sms/notify | API for HIP to send SMS notifications to patients API to send SMS notifications to patient with custom deeplin |
POST | /v0.5/patients/sms/on-notify | Acknowledgment response for SMS notification sent to patient by HIP If the SMS notification is successfully se |
POST | /v0.5/sessions | Get access token sessions |
POST | /v0.5/subscription-requests/cm/init | Request for subscription creates a request for subscription. The subscription categories can be for care-conte |
POST | /v0.5/subscription-requests/cm/on-init | callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the reque |
POST | /v0.5/subscription-requests/hiu/notify | Notification for subscription grant/deny/revoke This API is used by CM to notify a HIU to grant or deny a requ |
POST | /v0.5/subscription-requests/hiu/on-notify | Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification. This API is called |
POST | /v0.5/subscriptions/hiu/notify | Notification to HIU on basis of a granted subscription This API is used by CM to notify a HIU for notification |
POST | /v0.5/subscriptions/hiu/on-notify | Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification. This API is called by HIU a |
and 8 more operation(s) in this specification, all searchable.
specification origin: https://apisetu.gov.in/api_specification_v8/ndhm-gateway.yaml
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 together so as to make it clear to *HIUs* which set of APIs they should implement to participate in the network. 1. The APIs are organized by the flows - **identification**, **c
| method | path | what the vendor says it does |
|---|---|---|
GET | /v0.5/.well-known/openid-configuration | Get openid configuration Gateway |
GET | /v0.5/certs | Get certs for JWT verification Gateway |
POST | /v0.5/consent-requests/init | Create consent request Creates a consent request to get data about a patient by HIU user. Gateway |
POST | /v0.5/consent-requests/on-init | Response to consent request Result of consent request creation for a patient. **id** represents the consentreq |
POST | /v0.5/consent-requests/on-status | Result of consent request status Result of consent request done previously. Status of request can be GRANTED, |
POST | /v0.5/consent-requests/status | Get consent request status Get status of consent request done previously Gateway |
POST | /v0.5/consents/fetch | Get consent artefact Gateway |
POST | /v0.5/consents/hiu/notify | Consent notification Health information user will get notified about the consent request granted or denied, co |
POST | /v0.5/consents/hiu/on-notify | Consent notification This API is called by HIU as acknowledgement to consent notifications, specifically for c |
POST | /v0.5/consents/on-fetch | Result of fetch request for a consent artefact Must contain either consent or error. Possible reason of errors |
POST | /v0.5/health-information/cm/request | Health information data request Request for Health information against a consent id. CM would generate a trans |
POST | /v0.5/health-information/hiu/on-request | Health information data request Callback API for acknowledgement of Health information request made by HIU. Ga |
POST | /v0.5/health-information/notify | Notifications corresponding to events during data flow API called by HIU and HIP during data-transfer. 1. HIP |
POST | /v0.5/health-information/transfer | health information transfer API **NOTE**: This API is actually the callback URL that is passed as **dataPushUr |
GET | /v0.5/heartbeat | Get consent request status monitoring |
POST | /v0.5/patients/find | Identify a patient by her consent-manager user-id This API is meant for identify to patient given her consent- |
POST | /v0.5/patients/on-find | Identification result for a consent-manager user-id If a patient is found then patient.name contains the patie |
POST | /v0.5/sessions | Get access token Gateway |
POST | /v0.5/subscription-requests/cm/init | Request for subscription creates a request for subscription. The subscription categories can be for care-conte |
POST | /v0.5/subscription-requests/hiu/notify | Notification for subscription grant/deny/revoke This API is used by CM to notify a HIU to grant or deny a requ |
POST | /v0.5/subscription-requests/hiu/on-init | callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the reque |
POST | /v0.5/subscription-requests/hiu/on-notify | Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification. This API is called |
POST | /v0.5/subscriptions/hiu/notify | Notification to HIU on basis of a granted subscription This API is used by CM to notify a HIU for notification |
POST | /v0.5/subscriptions/hiu/on-notify | Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification. This API is called by HIU a |
POST | /v0.5/users/auth/confirm | Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation This API |
POST | /v0.5/users/auth/fetch-modes | Get a patient's authentication modes relevant to specified purpose This API is meant for identify supported au |
POST | /v0.5/users/auth/init | Initialize authentication from HIP This API is called by HIPs to initiate authentication of users. A transacti |
POST | /v0.5/users/auth/notify | notification API in case of DIRECT mode of authentication by the CM This API is called by CM to confirm authen |
POST | /v0.5/users/auth/on-confirm | callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not This API is ca |
POST | /v0.5/users/auth/on-fetch-modes | Identification result for a consent-manager user-id If a patient is found then **auth** attribute contains the |
POST | /v0.5/users/auth/on-init | Response to user authentication initialization from HIP If the patient's id is valid, CM will return a transac |
POST | /v0.5/users/auth/on-notify | callback API by HIU/HIPs as acknowledgement of auth notification This API is called by HIU/HIPs to confirm ack |
specification origin: https://apisetu.gov.in/api_specification_v8/ndhm-hiu.yaml
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 Repository, but put together so as to make it clear to *HIPs* which set of APIs they should implement to participate in the network.
| method | path | what the vendor says it does |
|---|---|---|
GET | /v0.5/.well-known/openid-configuration | Get openid configuration Gateway |
POST | /v0.5/care-contexts/discover | Discover patient's accounts Request for patient care context discover, made by Gateway intended for a specific |
POST | /v0.5/care-contexts/on-discover | Response to patient's account discovery request Result of patient care-context discovery request at HIP end. I |
GET | /v0.5/certs | Get certs for JWT verification Gateway |
POST | /v0.5/consents/hip/notify | Consent notification Notification of consents to health information providers consent request granted, consent |
POST | /v0.5/consents/hip/on-notify | Consent notification This API is called by HIP as acknowledgement to notification of consents, in cases of con |
POST | /v0.5/health-information/hip/on-request | Health information data request API called by HIP to acknowledge Health information request receipt. Either th |
POST | /v0.5/health-information/hip/request | Health information data request API called by CM to request Health information from HIP against a validated co |
POST | /v0.5/health-information/notify | Notifications corresponding to events during data flow API called by HIU and HIP during data-transfer. 1. HIP |
POST | /v0.5/health-information/transfer | health information transfer API **NOTE**: This API is actually the callback URL that is passed as **dataPushUr |
GET | /v0.5/heartbeat | Get consent request status monitoring |
POST | /v0.5/links/link/add-contexts | API for HIP initiated care-context linking for patient API to submit care-context to CM for HIP initiated link |
POST | /v0.5/links/link/confirm | Token submission by Consent Manager for link confirmation API to submit the token that was sent by HIP during |
POST | /v0.5/links/link/init | Link patient's care contexts Request from Gateway to links care contexts associated with only one patient 1. |
POST | /v0.5/links/link/on-add-contexts | callback API for HIP initiated patient linking /link/add-context If the accessToken is valid for purpose of li |
POST | /v0.5/links/link/on-confirm | Token authenticated by HIP, indicating completion of linkage of care-contexts Returns a list of linked care co |
POST | /v0.5/links/link/on-init | Response to patient's care context link request Result of patient care-context link request from HIP end. This |
POST | /v0.5/patients/profile/on-share | Response to patient's share profile request Result of patient share profile request at HIP end. Gateway |
POST | /v0.5/patients/profile/share | Share patient profile details Request for sharing patient's profile details to HIP profile |
POST | /v0.5/patients/sms/notify | API for HIP to send SMS notifications to patients API to send SMS notifications to patient with custom deeplin |
POST | /v0.5/patients/sms/on-notify | Acknowledgment response for SMS notification sent to patient by HIP If the SMS notification is successfully se |
POST | /v0.5/sessions | Get access token Gateway |
POST | /v0.5/users/auth/confirm | Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation This API |
POST | /v0.5/users/auth/fetch-modes | Get a patient's authentication modes relevant to specified purpose This API is meant for identify supported au |
POST | /v0.5/users/auth/init | Initialize authentication from HIP This API is called by HIPs to initiate authentication of users. A transacti |
POST | /v0.5/users/auth/notify | notification API in case of DIRECT mode of authentication by the CM This API is called by CM to confirm authen |
POST | /v0.5/users/auth/on-confirm | callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not This API is ca |
POST | /v0.5/users/auth/on-fetch-modes | Identification result for a consent-manager user-id If a patient is found then **auth** attribute contains the |
POST | /v0.5/users/auth/on-init | Response to user authentication initialization from HIP If the patient's id is valid, CM will return a transac |
POST | /v0.5/users/auth/on-notify | callback API by HIU/HIPs as acknowledgement of auth notification This API is called by HIU/HIPs to confirm ack |
specification origin: https://apisetu.gov.in/api_specification_v8/ndhm-hip.yaml
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
| method | path | what the vendor says it does |
|---|---|---|
POST | /v0.5/care-contexts/on-discover | Response to patient's account discovery request Result of patient care-context discovery request at HIP end. I |
POST | /v0.5/consent-requests/init | Create consent request Creates a consent request to get data about a patient by HIU user. CM should call Gatew |
POST | /v0.5/consent-requests/status | Get consent request status Get status of consent request done previously. CM responds by calling Gateway API - |
POST | /v0.5/consents/fetch | Get consent artefact This API is called when a HIU makes a request to get a consent artefact. For response ple |
POST | /v0.5/consents/hip/on-notify | Consent notification This API is called by HIP as acknowledgement to notification of consents, in cases of con |
POST | /v0.5/consents/hiu/on-notify | Consent notification This API is called by HIU as acknowledgement to consent notifications, specifically for c |
POST | /v0.5/health-information/notify | Notifications corresponding to events during data flow API called by HIU and HIP during data-transfer. 1. HIP |
POST | /v0.5/health-information/on-request | Health information data request acknowledgement from HIP This API is called by HIP to acknowledge Health infor |
POST | /v0.5/health-information/request | Health information data request from HIU HIU request for Health information against a consent id. CM would gen |
GET | /v0.5/heartbeat | Get consent request status monitoring |
POST | /v0.5/links/link/add-contexts | API for HIP initiated care-context linking for patient API to submit care-context to CM for HIP initiated link |
POST | /v0.5/links/link/on-confirm | Token authenticated by HIP, indicating completion of linkage of care-contexts Returns a list of linked care co |
POST | /v0.5/links/link/on-init | Response to patient's care context link request Result of patient care-context link request from HIP end. This |
POST | /v0.5/patients/find | Identify a patient by her consent-manager user-id This API is meant for identify to patient given her consent- |
POST | /v0.5/patients/profile/on-share | Response to patient's share profile request Result of patient share profile request at HIP end. profile |
POST | /v0.5/subscription-requests/cm/init | Request for subscription creates a request for subscription. The subscription categories can be for care-conte |
POST | /v0.5/subscription-requests/hiu/on-notify | Callback API for /subscription-requests/hiu/notify to acknowledge receipt of notification. This API is called |
POST | /v0.5/subscriptions/hiu/on-notify | Callback API for /subscriptions/hiu/notify to acknowledge receipt of notification. This API is called by HIU a |
POST | /v0.5/users/auth/confirm | Confirmation request sending token, otp or other authentication details from HIP/HIU for confirmation This API |
POST | /v0.5/users/auth/fetch-modes | Get a patient's authentication modes relevant to specified purpose This API is meant for identify supported au |
POST | /v0.5/users/auth/init | Initialize authentication from HIP This API is called by HIPs to initiate authentication of users. A transacti |
POST | /v0.5/users/auth/on-notify | callback API from HIU/HIPs as acknowledgement of auth notification (in case of DIRECT auth) This API is called |
specification origin: https://apisetu.gov.in/api_specification_v8/ndhm-cm.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.