Mock sample for your project: Health Repository Provider Specifications for HIU API
Integrate with "Health Repository Provider Specifications for HIU API" from ndhm.gov.in in no time with Mockoon's ready to use mock sample
Health Repository Provider Specifications for HIU
Version: 0.5
Speed up your application development by using "Health Repository Provider Specifications for HIU API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
It also improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
Description
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.
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.
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.
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.
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
Other APIs by ndhm.gov.in
Health Data Consent Manager
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.
Gateway
Health Repository Provider Specifications for HIP
Health ID Service
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 should be able to update contact information easily.
Other APIs in the same category
Directorate of Information Technology, Government of Tripura, Tripura
Veteran Confirmation
The API will only return “Confirmed” or “Not Confirmed”.
Quickstart Guide
1. Get Access Credentials
Get started by filling out the form on the Apply for VA Lighthouse Developer Access page.
After submitting a request, you will receive your credentials for using the API in the Development environment, which allows you to try it out with mock data before moving to the Production environment.
2. Test the API
In the endpoint documentation below, we've provided a curl command builder for trying out the API before implementation with your app.
Use Test User attributes to populate the request body.
3. Build your app
The base URI for the Veteran Confirmation API in the Sandbox environment is:
https://sandbox-api.va.gov/services/veteran_confirmation/v0
In this environment, use attributes from the list of Test Users. Only Test Users can return a "confirmed" response.
Check out some of our sample apps. Please visit our VA Lighthouse Support portal should you need further assistance.
4. Show us a demo and get access to the Production environment
After building your app, we ask that you give us a demo before we set you up with production credentials. Please see the Path to Production page for more details.
Authorization
This API requires an API key in combination with identifiable information for the person being confirmed listed below. API requests are authorized through a symmetric API token provided in an HTTP header with name apikey. Including more information has a better chance of making a match and returning a Confirmed status.
Required information:
First Name
Last Name
Date of Birth
Social Security Number
Optional information:
Middle Name
Gender
Reference
Sandbox vs. Production Data
APIs accessed via the Sandbox environment are using the same underlying logic as VA’s production APIs; only the underlying data store is different.
Master Veteran Index (MVI)
The Master Veteran Index confirms a user's identity. In Production, several factors are considered to confirm identity. These include: a user’s first name, last name, date of birth and Social Security number. The MVI is mocked in the Sandbox environment. In this environment, the only factor used to confirm identity is the Social Security number.
Rate Limiting
We implemented basic rate limiting of 60 requests per minute. If you exceed this quota, your request will return a 429 status code. You may petition for increased rate limits by emailing and requests will be decided on a case by case basis.
Raw Open API Spec
https://api.va.gov/services/veteran_confirmation/docs/v0/api