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

ndhm.gov.in

Version: 0.5


Use this API in your project

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

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

Other APIs in the same category

CROssBAR Data API

ebi.ac.uk
About CROssBAR & data
CROssBAR: Comprehensive Resource of Biomedical Relations with Deep Learning Applications and Knowledge Graph Representations
CROssBAR is a comprehensive system that integrates large-scale biomedical data from various resources e.g UniProt, ChEMBL, Drugbank, EFO, HPO, InterPro & PubChem and stores them in a new NoSQL database, enrich these data with deep learning based prediction of relations between numerous biomedical entities, rigorously analyse the enriched data to obtain biologically meaningful modules and display them to the user via easy to interpret, interactive and heterogeneous knowledge graphs.
CROssBAR platform exposes a set of 12 endpoints to query data stored in the CROssBAR database. These endpoints help the user to find data of interest using different parameters provided by the API endpoint.
For example,
https://www.ebi.ac.uk/tools/crossbar/proteins?accession=A0A023GRW5 -> will provide protein information about accession 'A0A023GRW5' including its interactions, functions, cross-references, variations and more.
https://www.ebi.ac.uk/tools/crossbar/activities?moleculeChemblId=CHEMBL465983 -> will provide ChEMBL bio-interactions related information including targets and bio-activity measurements associated with molecule chembl id 'CHEMBL465983'
Knowledge graphs
Another use case of CROssBAR's API endpoints is in building knowledge graphs. These endpoints can be weaved together (output from one API endpoint fed as input to another API endpoint) programmatically to link nodes like protein, disease, drugs etc. as nodes of the graph. The endpoints are designed to be independent from each other which allows users the flexibility to drive biological networks from any facet e.g drug-centric, disease-centric, gene-centric etc. Our service for knowledge graph construction is available at https://crossbar.kansil.org.
An example for the part of the background queries on the CROssBAR API during the construction of a knowledge graph,
(with the aim of keeping the example simple, we have only included the processes related to pathways, genes/proteins and drugs/compounds)
In this example, we would like to find bio-active compounds (with a pChEMBL value threshold of at least 6.0) & drugs targeting all proteins belonging to "WNT ligand biogenesis and trafficking" pathway (based on Reactome pathway annotations).
This can be achieved by using endpoints listed on this swagger documentation as illustrated in following steps-
Find bio-active compounds (with a pChEMBL value threshold of at least 6.0) & drugs targeting all proteins belonging to "WNT ligand biogenesis and trafficking" pathway (based on Reactome annotations)
This can be achieved by using endpoints listed on this swagger documentation as illustrated in following steps-
Get all proteins from “/proteins” API endpoint which have a reactome pathway name equal to "WNT ligand biogenesis and trafficking".
From the collection of uniprot protein accessions collected from step 1 above, we query “/targets” API endpoint to obtain the ‘targetchemblid’s of these proteins.
From the collection of targetchemblids collected from step 2 above, we query “/activities” API endpoint with pChEMBL value >=6, to obtain the ’moleculechemblid’s of the molecules that we need.
From the collection of uniprot protein accessions collected from step 1 above, we find out Drug names and ids from the “/drugs” API endpoint that targets our proteins.
From the collection of ’moleculechemblid’s obtained in step3, we query “/molecules” endpoint to get the compounds that are interacting with the genes/proteins belonging to the “WNT ligand biogenesis and trafficking” pathway.

OpenFIGI API

A free & open API for FIGI discovery.

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

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.

Chhattisgarh State Board of Secondary Education, Chhattisgarh

apisetu.gov.in
CBBSE (http://cgbse.nic.in) is issuing marksheets through DigiLocker. These can be pulled by students into their DigiLocker accounts. Currently available -2001,2003 - 2017 Class X and 2001 - 2017 Class XII .

Transport Department, Tripura

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.

Space Radiation API

amentum.space
Space has a hostile radiation environment that increases the risk of cancers in humans and malfunctions in spacecraft electronics. The types of space radiation of primary concern are:
Galactic Cosmic Rays from outside our solar system generated by
supernovae and other phenomena;
Solar Energetic Particles produced by the Sun during intense and
sporadic bursts of activity; and
Trapped Radiation: energetic particles confined by Earth's magnetic
field, usually comprising an inner belt of mostly high energy protons
and an outer belt dominated by lower energy electrons and plasma.
Understanding the space radiation environment for a particular mission profile is becoming increasingly important. Commercial off-the-shelf electronic components that aren't resilient to space radiation are now prevalent. Longer duration missions to cislunar space, Mars, and beyond are placing astronauts at greater risk of radiation exposure.
API requests must contain a key "API-Key" in the header (see code samples). Obtain a key from here.
Help us improve the quality of our web APIs by completing our 2 minute survey 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.

Transport Department, Meghalaya

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.

NCERT

apisetu.gov.in
Certificates for Class X National Talent Search Examination as Issued by NCERT can be downloaded in citizen's DigiLocker account.

Motor Vehicle Department, Kerala

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.

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.

National Skill Development Corporation (NSDC)

apisetu.gov.in
NSDC (https://www.nsdcindia.org) promotes skill development by catalyzing creation of large, quality and for-profit vocational institutions. Skill certificates provided under various NSDC programmes are made available to citizens in their DigiLocker accounts.