Skip to content

OpenAPI 3 compliant documentation for EHR.Network APIs

This documentation describes service endpoints, resources, headers, parameters and operations as well as examples of requests and responses for the APIs supported by EHR.Network. They are designed to help developers understand how to use these APIs to build robust clinical applications easily.

The APIs are grouped for easy navigation. Detailed explanations are available where required for the developer to understand things such as mandatory fields, data types and allowed values.

The documentation complies with the latest OpenAPI specification for ease of understanding and also for automating many development tasks.

List of APIs

SAAS APIs

These are the APIs supported by EHR.Network SAAS platform. This documentation is aimed at developers working on the SAAS platform.

Box APIs

These are the APIs supported by standalone EHR.Network instances. It is aimed at supporting developers working on these independent instances of the platform.

Terminology APIs

This documents the APIs exposed by EHR.Network terminology service.

Doing more

Since this is OpenAPI 3.0 compliant, it can be used in conjunction with other Openapi tools to assist you in your application development. Some of the things that you are do with such tools are * Try out the EHR.Network APIs to assess its suitability for your requirements * Generate code snippets and languange SDKs to interact with EHR.Network APIs * Understand the data models better and use them effectively in your applications * Automate the creation test scripts for test driven development

Please see details below on using some such tools.

Using Postman

  • Clone the EHR.Network API specs repository
  • Install Postman
  • Open Postman and click on import button
  • In the pop up box choose Folder to import a folder.
  • Select the appropriate folder in the cloned repository and select Import in the next window. A Postman collection that includes APIs, parameters, sample body, response examples and Postman environment are created automatically.
  • Try the APIs, generate code snippets etc.

Using Stoplight studio

  • Clone the EHR.Network API specs repository
  • Install Stoplight studio
  • Run Stoplight studio, open the cloned repository and click on the openapi.v1.yaml file in the appropriate folder
  • Go to preview, try the APIs, generate code snippets etc.

Last update: 2021-01-18

Comments