Ndhm

Health Repository Provider Specifications for HIU

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…

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

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, consent flow, data flow and monitoring. They represent the APIs that are expected to be available at the HIU end by the Gateway.
  2. For majority of the APIs, if Gateway has initiated a call, there are corresponding callback APIs on the Gateway. e.g for /consents/hiu/notify API on HIU end, its expected that a corresponding callback API /consents/hiu/on-notify on Gateway is called. Such APIs are organized under the Gateway label.
  3. Gateway relevant APIs for HIUs are grouped under Gateway label. These include the APIs that HIPs are required to call on the Gateway. For example, to request a CM for consent, HIU would call /consent-requests/init API on gateway.
  4. NOTE, in some of the API documentations below, X-HIP-ID is mentioned in header (for example in /auth/on-init). These are the cases, when a particular API is applicable for both HIU and HIP (e.g an entity is playing the role of HRP representing both HIU and HIP). If you are only playing the role of HIP, then only X-HIU-ID header will be sent

Endpoints 32

user auth

  • POSTnotification API in case of DIRECT mode of authentication by the CM/v0.5/users/auth/notifyThis API is called by CM to confirm authentication of users. The transactionId returned is same as that passed in /auth/on-init. The "auth.status" conveys…
  • POSTcallback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not/v0.5/users/auth/on-confirmThis API is called by CM to confirm authentication of users. 1. auth.accessToken - is specific to the purpose mentioned in the /auth/init. This token needs to…
  • POSTIdentification result for a consent-manager user-id/v0.5/users/auth/on-fetch-modesIf a patient is found then auth attribute contains the supported modes for the specified purpose. Otherwise, error is raised for invalid requests or for…
  • POSTResponse to user authentication initialization from HIP/v0.5/users/auth/on-initIf the patient's id is valid, CM will return a transactionId as initialization of user auth. If the request is valid, then 'auth.mode' will convey how the…

identification

  • POSTIdentification result for a consent-manager user-idhttps://dev.ndhm.gov.in/hiu/v0.5/patients/on-findIf a patient is found then patient.name contains the patients name. Otherwise, patient is not provided, and possibly error is raised for invalid requests Note…

consent flow

  • POSTResponse to consent requesthttps://dev.ndhm.gov.in/hiu/v0.5/consent-requests/on-initResult of consent request creation for a patient. id represents the consentrequest id created by CM. The result must contain either id or the error caused.…
  • POSTResult of consent request statushttps://dev.ndhm.gov.in/hiu/v0.5/consent-requests/on-statusResult of consent request done previously. Status of request can be GRANTED, DENIED, EXPIRED. If the request was GRANTED, then
  • POSTConsent notificationhttps://dev.ndhm.gov.in/hiu/v0.5/consents/hiu/notifyHealth information user will get notified about the consent request granted or denied, consent revoked, consent expired. 1. For consent request grant,…
  • POSTResult of fetch request for a consent artefacthttps://dev.ndhm.gov.in/hiu/v0.5/consents/on-fetchMust contain either consent or error. Possible reason of errors are 1. consentId passed through /fetch is invalid

data flow

  • POSTHealth information data requesthttps://dev.ndhm.gov.in/hiu/v0.5/health-information/hiu/on-requestCallback API for acknowledgement of Health information request made by HIU. Gateway calls this API when request has validated for the specified consent id.…
  • POSThealth information transfer APIhttps://dev.ndhm.gov.in/hiu/v0.5/health-information/transferNOTE: This API is actually the callback URL that is passed as dataPushUrl in the data request API - /v0.5/health-information/hip/request. This API is directly…

subscriptions

  • POSTNotification for subscription grant/deny/revoke/v0.5/subscription-requests/hiu/notifyThis API is used by CM to notify a HIU to grant or deny a request for subscription, and also to notify that in case an existing subscription is revoked or…
  • POSTcallback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the request for subscription./v0.5/subscription-requests/hiu/on-initThis callback API acknowledges the request for subscription from a HIU, and sends back a "id" that will be used when the patient/user approves or denies the…
  • POSTNotification to HIU on basis of a granted subscription/v0.5/subscriptions/hiu/notifyThis API is used by CM to notify a HIU for notification relevant to subscription. Notifications are sent to subscribed HIUs whenever a new care-context is…

monitoring

  • GETGet consent request statushttps://dev.ndhm.gov.in/hiu/v0.5/heartbeat

Gateway

  • GETGet openid configuration/v0.5/.well-known/openid-configuration
  • GETGet certs for JWT verification/v0.5/certs
  • POSTCreate consent request/v0.5/consent-requests/initCreates a consent request to get data about a patient by HIU user.
  • POSTGet consent request status/v0.5/consent-requests/statusGet status of consent request done previously
  • POSTGet consent artefact/v0.5/consents/fetch
  • 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.
  • POSTHealth information data request/v0.5/health-information/cm/requestRequest for Health information against a consent id. CM would generate a transactionId against each consent and pass it as trnasaction context / correlation…
  • 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…
  • 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
  • POSTGet access token/v0.5/sessions
  • 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.
  • 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. 1.…
  • POSTcallback API by HIU/HIPs as acknowledgement of auth notification/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.

API details

Base URL
https://dev.ndhm.gov.in/gateway
Authentication
None declared in the description
Operations
32 operations on 32 pathsPOST 29GET 3
Main resources
Gateway 17consent flow 4user auth 4subscriptions 3data flow 2identification 1monitoring 1
Response formats
application/json application/xml
Description format
OpenAPI 3.0.0, API version 0.5
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Health Repository Provider Specifications for HIU in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Health Repository Provider Specifications for HIU collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “notification API in case of DIRECT mode of authentication by the CM” (POST /v0.5/users/auth/notify), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Health Repository Provider Specifications for HIU?

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… It is listed under Government & public and has 32 endpoints.

Who publishes the Health Repository Provider Specifications for HIU?

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 Repository Provider Specifications for HIU?

Requests go to https://dev.ndhm.gov.in/gateway. Endpoint paths are added to this base URL.

How do I authenticate with the Health Repository Provider Specifications for HIU?

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 Repository Provider Specifications for HIU have?

32 operations on 32 paths (29 POST, 3 GET). The largest groups are Gateway, consent flow, user auth, subscriptions.

Is forking the Health Repository Provider Specifications for HIU free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.