Ndhm

Health Repository Provider Specifications for HIP

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…

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

Endpoints 30

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 nothttps://your-hrp-server.com/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 HIPhttps://your-hrp-server.com/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…

profile

  • POSTShare patient profile detailshttps://your-hrp-server.com/v0.5/patients/profile/shareRequest for sharing patient's profile details to HIP

discovery

  • POSTDiscover patient's accountshttps://your-hrp-server.com/v0.5/care-contexts/discoverRequest for patient care context discover, made by Gateway intended for a specific HIP. It is expected that HIP will subsequently return either zero or one…

link

  • POSTToken submission by Consent Manager for link confirmationhttps://your-hrp-server.com/v0.5/links/link/confirmAPI to submit the token that was sent by HIP during the link request.
  • POSTLink patient's care contextshttps://your-hrp-server.com/v0.5/links/link/initRequest from Gateway to links care contexts associated with only one patient 1. Validate account reference number and care context reference number 2.…
  • POSTcallback API for HIP initiated patient linking /link/add-contexthttps://your-hrp-server.com/v0.5/links/link/on-add-contextsIf the accessToken is valid for purpose of linking, and specified details provided, CM will send "acknoweldgement.status" as SUCCESS. If any error occcurred,…

consent flow

  • POSTConsent notificationhttps://your-hrp-server.com/v0.5/consents/hip/notifyNotification of consents to health information providers consent request granted, consent revoked, consent expired. Only the GRANTED and REVOKED status…

data flow

  • POSTHealth information data requesthttps://your-hrp-server.com/v0.5/health-information/hip/requestAPI called by CM to request Health information from HIP against a validated consent artefact. The transactionId is the correlation id that HIP should use use…

data transfer

  • POSThealth information transfer APIhttps://dev.ndhm.gov.in/patient-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…

monitoring

  • GETGet consent request statushttps://your-hrp-server.com/v0.5/heartbeat

Gateway

  • GETGet openid configuration/v0.5/.well-known/openid-configuration
  • 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…
  • GETGet certs for JWT verification/v0.5/certs
  • 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.
  • POSTHealth information data request/v0.5/health-information/hip/on-requestAPI called by HIP to acknowledge Health information request receipt. Either the hiRequest or error must be specified. hiRequest element returns the same…
  • 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…
  • 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…
  • POSTResponse to patient's share profile request/v0.5/patients/profile/on-shareResult of patient share profile request at HIP end.
  • POSTAPI for HIP to send SMS notifications to patients/v0.5/patients/sms/notifyAPI to send SMS notifications to patient with custom deeplink.
  • POSTGet access token/v0.5/sessions
  • 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 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.

patient notification

  • POSTAcknowledgment response for SMS notification sent to patient by HIP/v0.5/patients/sms/on-notifyIf the SMS notification is successfully sent to patient then "status" will be "ACKNOWLEDGED" with no error. If the SMS notification is failed then "status"…

API details

Base URL
https://dev.ndhm.gov.in/gateway
Authentication
None declared in the description
Operations
30 operations on 30 pathsPOST 27GET 3
Main resources
Gateway 16user auth 4link 3consent flow 1data flow 1data transfer 1discovery 1monitoring 1patient notification 1profile 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 HIP 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 HIP 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 HIP?

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

Who publishes the Health Repository Provider Specifications for HIP?

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

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

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 HIP have?

30 operations on 30 paths (27 POST, 3 GET). The largest groups are Gateway, user auth, link, consent flow.

Is forking the Health Repository Provider Specifications for HIP 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.