Mock sample for your project: Health ID Service API
Integrate with "Health ID Service API" from ndhm.gov.in in no time with Mockoon's ready to use mock sample
Health ID Service
Version: 1.0
Integrate third-party APIs faster by using "Health ID Service 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.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.
Description
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 should be able to update contact information easily.
Other APIs by ndhm.gov.in
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 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.
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 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
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
Gateway
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
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 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.
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.
Other APIs in the same category
Motor Vehicle Department, Maharashtra
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
High Performance Building Database
nrel.gov
The Buildings Database is a shared resource for the building industry. The Database, developed by the U.S. Department of Energy and the National Renewable Energy Laboratory (NREL), is a unique central repository of in-depth information and data on high-performance, green building projects across the United States and abroad.
Karnataka Department of Transport, Karnataka
apisetu.gov.in
Driving License (DL) & Vehicle Registration Certificate (RC) as issued by Transport Department, Government of Karnataka (http://transport.karnataka.gov.in) can be pulled by citizens into their DigiLocker accounts.
Transport Department, Jammu & Kashmir
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Transport Department, Puducherry
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
COVID-19 data API
covid19-api.com
Kotak Mahindra General Insurance Company Ltd.
apisetu.gov.in
Insurance Policies such as Health, Car, Two Wheeler, Group, Home etc. issued by KOTAK MAHINDRA GENERAL INSURANCE are available to be pulled by citizens.
Central Board of Secondary Education
apisetu.gov.in
CBSE (http://www.cbse.nic.in/) is issuing marksheets, passing certificates, migration certificates etc. through DigiLocker. These are either pushed, or can be pulled by students into their DigiLocker accounts. Currently available - 2004 - 2020 [Class XII], 2004 - 2020 [Class X], 2017 (NEET Rank Letter & Marksheet), 2016 (NEET Rank Letter), 2018 December (CTET Eligibility Certificate & Marksheet).
Uttarakhand State Board of School Education, Uttarakhand
apisetu.gov.in
Uttarakhand Board of School Education, Ramnagar (http://ubse.uk.gov.in/) has made available Class X (2018) & Class XII (2018) mark sheet-cum-certificate and migration certificates, which can be pulled by students into their DigiLocker accounts.
Department of Agricultural Marketing, Karnataka
apisetu.gov.in
APIs provided by Department of Agricultural Marketing, Karnataka.
GlobalWineScore API Documentation
globalwinescore.com
The GlobalWineScore API is designed as a RESTful API, providing several resources and methods depending on your usage plan.
For further information please refer to our plans.
Authentication
The API uses token-based authentication.
In order to authenticate your requests, you need to include a specific header in each of your requests:
The word Token must be written. Your requests must also use the HTTPS protocol.
If you don't have a token yet, you need to apply for one here.
Your personal token can be found under the My account > API section of the GlobalWineScore website
Format
The API provides several rendering formats which you can control using the Accept header or format query parameter.
JSON (default): no header or Accept: application/json
XML: Accept: application/xml
Rate limiting
For API requests, the rate limit allows for up to 10 requests per minute.
Error handling
Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx status code indicates failure.
When a request fails, the response body is still JSON, but always contains a detail field with a description of the error, which you can inspect for debugging.
For example, trying to access the API without proper authentication will return code 403 along with the message:
{"detail": "Authentication credentials were not provided."}
Found a bug ? send us an email at [email protected]
Ordering
At the moment, GlobalWineScores may be sorted by date and score. Use "-"
to sort in descending order.
Continuous synchronization
If you need to synchronize your database with our API, you can query our API using ?ordering=-date to get the newest scores first, which means you won't have to crawl the whole catalog every time :-)
Quick search interface
If you need to search our catalog (e.g. to align it with yours), we're providing you with a handy interface accessible here: https://api.globalwinescore.com/search/
You need to be logged in (email/password) to access this page, but other than that you can share it with anyone in your team and start searching right away !
Resources
The details about available endpoints can be found below.
You can click on each endpoint to find information about their parameters.
For further information please refer to our plans.
Authentication
The API uses token-based authentication.
In order to authenticate your requests, you need to include a specific header in each of your requests:
The word Token must be written. Your requests must also use the HTTPS protocol.
If you don't have a token yet, you need to apply for one here.
Your personal token can be found under the My account > API section of the GlobalWineScore website
Format
The API provides several rendering formats which you can control using the Accept header or format query parameter.
JSON (default): no header or Accept: application/json
XML: Accept: application/xml
Rate limiting
For API requests, the rate limit allows for up to 10 requests per minute.
Error handling
Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx status code indicates failure.
When a request fails, the response body is still JSON, but always contains a detail field with a description of the error, which you can inspect for debugging.
For example, trying to access the API without proper authentication will return code 403 along with the message:
{"detail": "Authentication credentials were not provided."}
Found a bug ? send us an email at [email protected]
Ordering
At the moment, GlobalWineScores may be sorted by date and score. Use "-"
to sort in descending order.
Continuous synchronization
If you need to synchronize your database with our API, you can query our API using ?ordering=-date to get the newest scores first, which means you won't have to crawl the whole catalog every time :-)
Quick search interface
If you need to search our catalog (e.g. to align it with yours), we're providing you with a handy interface accessible here: https://api.globalwinescore.com/search/
You need to be logged in (email/password) to access this page, but other than that you can share it with anyone in your team and start searching right away !
Resources
The details about available endpoints can be found below.
You can click on each endpoint to find information about their parameters.