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
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.
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
Mtaa API Documentation
Mtaa A simple REST API to access Tanzania's location information,With mtaa API you can easily query and integrate all the location in tanzania from region level to streets from your programming language of your your choice
BC Route Planner REST API
Finds shortest/fastest route between a start point and one or more stop points on British Columbia's public road network. The BC Route planner webpage provides additional information. Here are some geocoded addresses to play with: 18 Douglas St,Victoria -123.36962,48.40892 1002 Johnson St, Victoria -123.355745,48.426206 543 Johnson St, Victoria, BC -123.36907,48.42770 14 Centennial Sq, Victoria, BC -123.36564,48.42863 1105 Royal Ave,New Westminster -122.92009,49.20063 808 Jackson Cres, New Westminster -122.90762,49.22558 10810 McDonald Rd, Chilliwack -121.93808,49.19859 3950 June Springs Rd, Kelowna -119.40751,49.83960 1201 Riondel Rd, Kootenay Bay -116.85402,49.74448 1201 Riondel Rd, Kootenay Bay -116.832759,49.730500 (parcelPoint) 2499 Walbran Pl, Courtenay -124.97295,49.71518 2013 Smoke Bluff Rd, Squamish -123.13946,49.70401 235 Kelvin Grove Way, Lions Bay -123.23524,49.45035 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.
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.
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.
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.
U.S. EPA Enforcement and Compliance History Online (ECHO) - Effluent Charting and Reporting
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.
EFF Rest Services provides the data for ECHO's Effluent Charts, a set of dynamic charts and tables of permitted effluent limits, releases, and violations over time for Clean Water Act (CWA) wastewater discharge permits issued under the National Pollutant Discharge Elimination System (NPDES).
See Effluent Charts Help (https://echo.epa.gov/help/reports/effluent-charts-help) for additional information.
\
The are 3 service end points for Effluent Charts: getsummarychart, geteffluentchart, and downloadeffluentchart.
\
1) Use getsummarychart to retrieve a summary matrix of effluent parameters by effluent outfall and an overall violation status for a provided NPDES Permit and date range.
2) Use geteffluentchart to retrieve detailed Discharge Limit, DMR and NPDES Violation information for a provided NPDES Permit, date range, effluent parameter, or outfall.
3) Use downloadeffluentchart to generate a Comma Separated Value (CSV) file of the detailed data provided with get_effluent chart, for a provided NPDES Permit, date range, effluent parameter, or outfall.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
ECHO provides integrated compliance and enforcement information for over 1 million regulated facilities nationwide.
EFF Rest Services provides the data for ECHO's Effluent Charts, a set of dynamic charts and tables of permitted effluent limits, releases, and violations over time for Clean Water Act (CWA) wastewater discharge permits issued under the National Pollutant Discharge Elimination System (NPDES).
See Effluent Charts Help (https://echo.epa.gov/help/reports/effluent-charts-help) for additional information.
\
The are 3 service end points for Effluent Charts: getsummarychart, geteffluentchart, and downloadeffluentchart.
\
1) Use getsummarychart to retrieve a summary matrix of effluent parameters by effluent outfall and an overall violation status for a provided NPDES Permit and date range.
2) Use geteffluentchart to retrieve detailed Discharge Limit, DMR and NPDES Violation information for a provided NPDES Permit, date range, effluent parameter, or outfall.
3) Use downloadeffluentchart to generate a Comma Separated Value (CSV) file of the detailed data provided with get_effluent chart, for a provided NPDES Permit, date range, effluent parameter, or outfall.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
rv API
Introduction
This API returns information about all of the verses in Rig Veda. The results are JSON objects that contain the name of the god, poet, and meter of the verses in Rig Veda, the category of the god and the poet, and the mandal and sukta number.
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch the data for a category being sung to.
The remaining resources work a similar fashion. For details, see the reference documentation.
This API returns information about all of the verses in Rig Veda. The results are JSON objects that contain the name of the god, poet, and meter of the verses in Rig Veda, the category of the god and the poet, and the mandal and sukta number.
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch the data for a category being sung to.
The remaining resources work a similar fashion. For details, see the reference documentation.
Stationsdatenbereitstellung
deutschebahn.com
An API providing master data for German railway stations by DB Station&Service AG.