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 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 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 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
Other APIs in the same category
WorkBC Job Posting API
gov.bc.ca
This API allows you to receive a feed of jobs from WorkBC's Job Board. Please see our data collection notice. Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Healthcare
Transport Department, Uttarakhand
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.
Fahrplan-Free
A RESTful webservice to request a railway journey - FREE plan with restricted access (max. 10 requests per minute). Please ignore the message in the API Console about the access token.
Register to use an less restricted version, which requires an access token.
Register to use an less restricted version, which requires an access token.
U.S. EPA Enforcement and Compliance History Online (ECHO) - Resource Conservation and Recovery Act
Enforcement and Compliance History Online (ECHO) is a tool developed and maintained by EPA's Office of Enforcement and Compliance Assurance for public use. ECHO provides integrated compliance and enforcement information for over 1 million regulated facilities nationwide.
RCRA Rest Services provides multiple service endpoints, each with specific capabilities, to search and retrieve data on hazardous waste handlers/facilities regulated under the Resource Conservation and Recovery Act (RCRA). The returned results reflect data drawn from EPA's RCRAInfo database.
\
The getfacilities, getmap, getqid, and getdownload end points are meant to be used together, while the enhanced getfacilityinfo end point is self contained.
The getfacilityinfo end point returns either an array of state, county or zip clusters with summary statistics per cluster or an array of facilities.
\
The recommended use scenario for getfacilities, getqid, getmap, and getdownoad is:
\
1) Use getfacilities to validate passed query parameters, obtain summary statistics and to obtain a queryid (QID). QIDs are time sensitive and will be valid for approximately 30 minutes.
2) Use get_qid, with the returned QID, to paginate through arrays of facility results.
3) Use get_map, with the returned QID, to zoom in/out and pan on the clustered and individual facility coordinates that meet the QID query criteria.
4) Use get_download, with the returned QID, to generate a Comma Separated Value (CSV) file of facility information that meets the QID query criteria.
\
\
Use the qcolumns parameter to customize your search results. Use the Metadata service endpoint for a list of available output objects, their Column Ids, and their definitions to help you build your customized output.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
RCRA Rest Services provides multiple service endpoints, each with specific capabilities, to search and retrieve data on hazardous waste handlers/facilities regulated under the Resource Conservation and Recovery Act (RCRA). The returned results reflect data drawn from EPA's RCRAInfo database.
\
The getfacilities, getmap, getqid, and getdownload end points are meant to be used together, while the enhanced getfacilityinfo end point is self contained.
The getfacilityinfo end point returns either an array of state, county or zip clusters with summary statistics per cluster or an array of facilities.
\
The recommended use scenario for getfacilities, getqid, getmap, and getdownoad is:
\
1) Use getfacilities to validate passed query parameters, obtain summary statistics and to obtain a queryid (QID). QIDs are time sensitive and will be valid for approximately 30 minutes.
2) Use get_qid, with the returned QID, to paginate through arrays of facility results.
3) Use get_map, with the returned QID, to zoom in/out and pan on the clustered and individual facility coordinates that meet the QID query criteria.
4) Use get_download, with the returned QID, to generate a Comma Separated Value (CSV) file of facility information that meets the QID query criteria.
\
\
Use the qcolumns parameter to customize your search results. Use the Metadata service endpoint for a list of available output objects, their Column Ids, and their definitions to help you build your customized output.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
Geocoder REST API
This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical addresses and their occupants in British Columbia. Please read our data collection notice.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC. API keys are further described in the Developer guide.
Notification: If you have applications or web pages that link to the BC Address Geocoder you must use the following URL.
https://geocoder.api.gov.bc.ca
Please note that the following URLs were deprecated in September 2018 More Details.
http://apps.gov.bc.ca/pub/geocoder
https://apps.gov.bc.ca/pub/geocoder
\
\
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC. API keys are further described in the Developer guide.
Notification: If you have applications or web pages that link to the BC Address Geocoder you must use the following URL.
https://geocoder.api.gov.bc.ca
Please note that the following URLs were deprecated in September 2018 More Details.
http://apps.gov.bc.ca/pub/geocoder
https://apps.gov.bc.ca/pub/geocoder
\
\
Climate FieldView Platform APIs
climate.com
Last Modified: Thu Oct 29 12:30:46 PDT 2020
All endpoints are only accessible via HTTPS.
All API endpoints are located at https://platform.climate.com (e.g.
https://platform.climate.com/v4/fields).
The authorization token endpoint is located at
https://api.climate.com/api/oauth/token.
Troubleshooting
X-Http-Request-Id response header will be returned on every call,
successful or not. If you experience an issue with our api and need
to contact technical support, please supply the value of the X-Http-Request-Id
header along with an approximate time of when the request was made.
Request Limits
When you’re onboarded to Climate’s API platform, your x-api-key is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes:
Throttling information
burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds
rateLimit: A steady-state rate limit
Quota information
Limit: The maximum number of requests that can be made in a given month
When the request rate threshold is exceeded, a 429 response code is returned. Optionally, the Retry-After header may be returned:
Following are examples of rate limit errors:
Rate limit exceeded:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 32
{"message":"Too Many Requests"}
Quota exhausted:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 29
{"message":"Limit Exceeded"}
Pagination
Pagination is performed via headers. Any request which returns a "results"
array may be paginated. The following figure shows how query results are laid out with
X-Limit=4 and no filter applied.
If there are no results, a response code of 304 will be returned.
If the response is the last set of results, a response code of 200 or
206 will be returned.
If there are more results, a response code of 206 will be returned.
If X-Next-Token is provided in the request headers but the token has
expired, a response code of 409 will be returned. This is only applicable
for some endpoints; see specific endpoint documentation below.
X-Limit
The page size can be controlled with the X-Limit header. Valid values are
1-100 and defaults to 100.
X-Next-Token
If the results are paginated, a response header of X-Next-Token will be
returned. Use the associated value in the subsequent request (via the X-Next-Token
request header) to retrieve the next page. The following sequence diagram shows how to
use X-Next-Token to fetch all the records.
Chunked Uploads
Uploads larger than 5MiB (5242880 bytes) must be done in 5MiB chunks
(with the exception of the final chunk). Each chunk request MUST contain a
Content-Range header specifying the portion of the upload, and a Content-Type
header specifying binary content type (application/octet-stream). Range
uploads must be contiguous. The maximum upload size is capped at 500MiB (524288000 bytes).
Chunked Downloads
Downloads larger than 5MiB (5242880 bytes) must be done in 1-5MiB
chunks (with the exception of the final chunk, which may be less than 1MiB).
Each chunk request MUST contain a Range header specifying the requested portion of the download,
and an Accept header specifying binary and json content types (application/octet-stream,application/json)
or all content types (/).
Drivers
If you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.
For asPlanted, asHarvested and asApplied data:
ADAPT Plugin
Release notes can be found here.
Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin.
Please review the EULA (last updated on June 6th, 2019) before download and use of the ADAPT plugin.
For more information, please refer to:
ADAPT Resources
ADAPT Overview
ADAPT FAQ
ADAPT Videos
Sample Test Data
Sample agronomic data:
asPlanted and asHarvested data
asApplied data set 1
asApplied data set 2
To upload the sample data to your account, please follow the instructions in this link.
Sample soil data:
Sample soil data
All endpoints are only accessible via HTTPS.
All API endpoints are located at https://platform.climate.com (e.g.
https://platform.climate.com/v4/fields).
The authorization token endpoint is located at
https://api.climate.com/api/oauth/token.
Troubleshooting
X-Http-Request-Id response header will be returned on every call,
successful or not. If you experience an issue with our api and need
to contact technical support, please supply the value of the X-Http-Request-Id
header along with an approximate time of when the request was made.
Request Limits
When you’re onboarded to Climate’s API platform, your x-api-key is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes:
Throttling information
burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds
rateLimit: A steady-state rate limit
Quota information
Limit: The maximum number of requests that can be made in a given month
When the request rate threshold is exceeded, a 429 response code is returned. Optionally, the Retry-After header may be returned:
Following are examples of rate limit errors:
Rate limit exceeded:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 32
{"message":"Too Many Requests"}
Quota exhausted:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 29
{"message":"Limit Exceeded"}
Pagination
Pagination is performed via headers. Any request which returns a "results"
array may be paginated. The following figure shows how query results are laid out with
X-Limit=4 and no filter applied.
If there are no results, a response code of 304 will be returned.
If the response is the last set of results, a response code of 200 or
206 will be returned.
If there are more results, a response code of 206 will be returned.
If X-Next-Token is provided in the request headers but the token has
expired, a response code of 409 will be returned. This is only applicable
for some endpoints; see specific endpoint documentation below.
X-Limit
The page size can be controlled with the X-Limit header. Valid values are
1-100 and defaults to 100.
X-Next-Token
If the results are paginated, a response header of X-Next-Token will be
returned. Use the associated value in the subsequent request (via the X-Next-Token
request header) to retrieve the next page. The following sequence diagram shows how to
use X-Next-Token to fetch all the records.
Chunked Uploads
Uploads larger than 5MiB (5242880 bytes) must be done in 5MiB chunks
(with the exception of the final chunk). Each chunk request MUST contain a
Content-Range header specifying the portion of the upload, and a Content-Type
header specifying binary content type (application/octet-stream). Range
uploads must be contiguous. The maximum upload size is capped at 500MiB (524288000 bytes).
Chunked Downloads
Downloads larger than 5MiB (5242880 bytes) must be done in 1-5MiB
chunks (with the exception of the final chunk, which may be less than 1MiB).
Each chunk request MUST contain a Range header specifying the requested portion of the download,
and an Accept header specifying binary and json content types (application/octet-stream,application/json)
or all content types (/).
Drivers
If you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.
For asPlanted, asHarvested and asApplied data:
ADAPT Plugin
Release notes can be found here.
Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin.
Please review the EULA (last updated on June 6th, 2019) before download and use of the ADAPT plugin.
For more information, please refer to:
ADAPT Resources
ADAPT Overview
ADAPT FAQ
ADAPT Videos
Sample Test Data
Sample agronomic data:
asPlanted and asHarvested data
asApplied data set 1
asApplied data set 2
To upload the sample data to your account, please follow the instructions in this link.
Sample soil data:
Sample soil data
United India Insurance Company Limited
apisetu.gov.in
United India Insurance Co. Ltd. is a Public Sector General Insurance Company incorporated in 1938, having its presence all over India providing risk cover to 1.74 Crore policyholders. General Insurance Policies such as Motor, Health, Personal Accident, Travel, e.t.c issued by United India Insurance Co. Ltd. (https://uiic.co.in/) are available to be downloaded by citizens of India to their DigiLocker account.
Available API endpoints
versioneye.com
VersionEye is a cross-platform search engine for free/libre/open source software libraries.
Geographic API
The Geographic API extends the Semantic API, using a linked data approach to enhance location concepts used in The New York Times' controlled vocabulary and data resources which combine them with the GeoNames database, an authoritative and free to use database of global geographical places, names and features.
BikeWise API v2
This is an API for accessing information about bicycling related incidents. You can find the source code on GitHub.
State Transport Department, Telangana
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.