Mock sample for your project: Health Repository Provider Specifications for HIP API
Integrate with "Health Repository Provider Specifications for HIP API" from ndhm.gov.in in no time with Mockoon's ready to use mock sample
Health Repository Provider Specifications for HIP
Version: 0.5
Start working with "Health Repository Provider Specifications for HIP API" right away by using this ready-to-use mock sample. API mocking can greatly speed up your application development by removing all the tedious tasks or issues: API key provisioning, account creation, unplanned downtime, etc.
It also helps reduce your dependency on third-party APIs and 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 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.
Other APIs by ndhm.gov.in
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.
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 ID Service
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.
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.
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
Other APIs in the same category
City Context
citycontext.com
City Context provides a straightforward API to access UK Open Data: crime statistics, schools, demographics and more.
Department of Legal Metrology, Uttar Pradesh
apisetu.gov.in
Licenses issued by Department of Legal Metrology, Uttar Pradesh can be pulled by citizens into their DigiLocker accounts.
National Insurance Company Ltd.
apisetu.gov.in
APIs provided by National Insurance Company Ltd..
Krishna Kanta Handique State Open University (KKHSOU), Assam
apisetu.gov.in
Krishna Kanta Handiqui State Open University (http://www.kkhsou.in//) has made available their Results of MA (Education,Assamese,Political Sc,Sociology,English) & MBA programmes, for the year 2018, in DigiLocker, which can be pulled by students into their accounts.
Mizoram State Board of School education
apisetu.gov.in
Mizoram Board of School Education, Mizoram (http://www.mbse.edu.in) has made available 2018 Class X and class XII marksheets and passing certificates in DigiLocker, which can be pulled by students into their accounts.
Meark Enterprise Pvt. Ltd.
apisetu.gov.in
A single consolidated system of MEARK has been integrated with DigiLocker to produce Co-curricular activity Awards for Universities and Academic Institutions of India. Initially starting with all the Universities of Maharashtra.
Directorate of Municipal Administration, Karnataka
apisetu.gov.in
APIs provided by Directorate of Municipal Administration, Karnataka.
Karnataka Secondary Education Examination Board, Karnataka
apisetu.gov.in
Karnataka Secondary Education Examination Board (http://kseeb.kar.nic.in) is providing passing certificates of SSLC(10th Std) of April and June-2018 Examinations.
Maharashtra Council of Indian Medicine
apisetu.gov.in
APIs provided by Maharashtra Council of Indian Medicine.
Employees' Provident Fund Organization
apisetu.gov.in
Pension Payment Order and UAN, as provided by EPFO (https://www.epfindia.gov.in), can be downloaded in citizen's DigiLocker account.
eDistrict Odisha ServicePlus, Odisha
apisetu.gov.in
APIs provided by eDistrict Odisha ServicePlus, Odisha.
Gravity API
amentum.space
The gravitational field of the earth is non-uniform. The geoid is the shape the
ocean surface would take if only gravity and the rotation of the Earth
were considered. The geoid is the surface that defines zero elevation.
The geoid height is the difference between an ideal reference ellipsoid and the geoid.
The gravity anomaly is the difference between the acceleration due to gravity on the Earth's surface and the value calculated assuming the reference ellipsoid.
The official Earth Gravitational Model EGM2008 was developed and released to the public by the National Geospatial-Intelligence Agency (NGA).
Our EGM2008 API provides on-demand access to the EGM2008 model, as implemented by the open-source GeographicLib Gravity library.
API requests must contain a key "API-Key" in the header (see code samples). Obtain a key from here.
Amentum Pty Ltd is not responsible nor liable for any loss or damage of any sort incurred as a result of using the API.
Copyright Amentum Pty Ltd 2021.
ocean surface would take if only gravity and the rotation of the Earth
were considered. The geoid is the surface that defines zero elevation.
The geoid height is the difference between an ideal reference ellipsoid and the geoid.
The gravity anomaly is the difference between the acceleration due to gravity on the Earth's surface and the value calculated assuming the reference ellipsoid.
The official Earth Gravitational Model EGM2008 was developed and released to the public by the National Geospatial-Intelligence Agency (NGA).
Our EGM2008 API provides on-demand access to the EGM2008 model, as implemented by the open-source GeographicLib Gravity library.
API requests must contain a key "API-Key" in the header (see code samples). Obtain a key from here.
Amentum Pty Ltd is not responsible nor liable for any loss or damage of any sort incurred as a result of using the API.
Copyright Amentum Pty Ltd 2021.