Difference between revisions of "OpenEMR 7.0.0 API"

From OpenEMR Project Wiki
Tag: Manual revert
Tag: Reverted
Line 17: Line 17:
:*Online links to Swagger based documentation can be found at [[Development_Demo|7.0.0 Demo]].
:*Online links to Swagger based documentation can be found at [[Development_Demo|7.0.0 Demo]].
<br>
<br>
= Native Applications =
:*Native applications wishing to use the OpenEMR FHIR API with refresh tokens MUST be capable of storing the refresh token in a secure manner similar to the requirements of storing a secret for confidential apps.  Native applications must register their application as a confidential app and request the offline_scope in their initial API request in order to receive a refresh token.  Refresh tokens are valid for 3 months before they must be renewed.  Native applications can only communicate with OpenEMR over a TLS secured channel in order to ensure the safe transmission of the refresh token.  Native applications must use the Authorization Code grant flow in order to receive a refresh token.  It is recommended that native applications follow best practices for native client applications as outlined in RFC 8252 OAuth 2.0 for Native Apps.


= Terms of use =
= Terms of use =
:*This section is required for ONC 2015 certification. OpenEMR and the API is open source and licensed under the [https://www.gnu.org/licenses/gpl-3.0.en.html GNU General Public License 3].
:*This section is required for ONC 2015 certification. OpenEMR and the API is open source and licensed under the [https://www.gnu.org/licenses/gpl-3.0.en.html GNU General Public License 3].
<br>
<br>

Revision as of 01:30, 21 April 2022

Overview

OpenEMR API documentation for both FHIR API and Standard API.


FHIR API

  • FHIR API Documentation for 7.0.0
  • Click Here for instructions on using Swagger, which is included in OpenEMR, to see full documentation of endpoints and testing support.
  • Online links to Swagger based documentation can be found at 7.0.0 Demo.
  • Videos that overview OpenEMR's FHIR API:


Standard API


Native Applications

  • Native applications wishing to use the OpenEMR FHIR API with refresh tokens MUST be capable of storing the refresh token in a secure manner similar to the requirements of storing a secret for confidential apps. Native applications must register their application as a confidential app and request the offline_scope in their initial API request in order to receive a refresh token. Refresh tokens are valid for 3 months before they must be renewed. Native applications can only communicate with OpenEMR over a TLS secured channel in order to ensure the safe transmission of the refresh token. Native applications must use the Authorization Code grant flow in order to receive a refresh token. It is recommended that native applications follow best practices for native client applications as outlined in RFC 8252 OAuth 2.0 for Native Apps.

Terms of use

  • This section is required for ONC 2015 certification. OpenEMR and the API is open source and licensed under the GNU General Public License 3.