Difference between revisions of "OpenEMR 7.0.1 API"

From OpenEMR Project Wiki
(Created page with "= Overview = :OpenEMR API documentation for both FHIR API and Standard API. <br> = FHIR API = :*[https://github.com/openemr/openemr/blob/master/FHIR_README.md FHIR API Docume...")
 
 
(6 intermediate revisions by the same user not shown)
Line 4: Line 4:


= FHIR API =
= FHIR API =
:*[https://github.com/openemr/openemr/blob/master/FHIR_README.md FHIR API Documentation for 7.0.0]
:*[https://github.com/openemr/openemr/blob/rel-701/FHIR_README.md FHIR API Documentation for 7.0.1]
:*[https://github.com/openemr/openemr/blob/master/FHIR_README.md#fhir-api-documentation Click Here] for instructions on using Swagger, which is included in OpenEMR, to see full documentation of endpoints and testing support.
:*[https://github.com/openemr/openemr/blob/rel-701/FHIR_README.md#fhir-api-documentation 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 [[Development_Demo|7.0.0 Demo]].
:*Online links to Swagger based documentation can be found at [[Development 7.0.1 Demo|7.0.1 Demo]].
:*Videos that overview OpenEMR's FHIR API:
:*Videos that overview OpenEMR's FHIR API:
::*[https://youtu.be/LQHNRBgg6Q8 OpenEMR FHIR Lecture Series: Lecture 1 - Overview and Use of FHIR in OpenEMR]
::*[https://youtu.be/LQHNRBgg6Q8 OpenEMR FHIR Lecture Series: Lecture 1 - Overview and Use of FHIR in OpenEMR]
::*[https://youtu.be/2qr0IV9Kulg OpenEMR FHIR Lecture Series: Lecture 2 - FHIR Bulk Data in OpenEMR]
::*[https://youtu.be/2qr0IV9Kulg OpenEMR FHIR Lecture Series: Lecture 2 - FHIR Bulk Data in OpenEMR]
:*Specific instructions for a Clinical Summary of Care Document (CCD) request:
:*Specific instructions for a Clinical Summary of Care Document (CCD) request:
::*[https://github.com/openemr/openemr/blob/master/FHIR_README.md#carecoordination-summary-of-care-docref-operation Instructions in API Documentation]
::*[https://github.com/openemr/openemr/blob/rel-701/FHIR_README.md#carecoordination-summary-of-care-docref-operation Instructions in API Documentation]
::*[https://github.com/openemr/openemr/issues/5284#issuecomment-1155678620 Tutorial to Generate CCDA (With Screenshots)]
::*[https://github.com/openemr/openemr/issues/5284#issuecomment-1155678620 Tutorial to Generate CCDA (With Screenshots)]
<br>
<br>


= Standard API =
= Standard API =
:*[https://github.com/openemr/openemr/blob/master/API_README.md Standard API Documentation for 7.0.0]
:*[https://github.com/openemr/openemr/blob/rel-701/API_README.md Standard API Documentation for 7.0.1]
:*[https://github.com/openemr/openemr/blob/master/API_README.md#standard-api-documentation Click Here] for instructions on using Swagger, which is included in OpenEMR, to see full documentation of endpoints and testing support.
:*[https://github.com/openemr/openemr/blob/rel-701/API_README.md#standard-api-documentation 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 [[Development_Demo|7.0.0 Demo]].
:*Online links to Swagger based documentation can be found at [[Development_7.0.1_Demo|7.0.1 Demo]].
<br>
<br>


= 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 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>
= Service Base URLs =
= Service Base URLs =
{{ServiceBaseURLs}}
{{ServiceBaseURLs}}

Latest revision as of 06:19, 23 March 2024

Overview

OpenEMR API documentation for both FHIR API and Standard API.


FHIR API

  • FHIR API Documentation for 7.0.1
  • 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.1 Demo.
  • Videos that overview OpenEMR's FHIR API:
  • Specific instructions for a Clinical Summary of Care Document (CCD) request:


Standard API


Terms of use


Service Base URLs

Overview

This section is required for ONC certification. The 'Production Endpoints lists the FHIR Base URLs (ie. service base URLs) of the OpenEMR installations that are utilizing the ONC certification.

Production Endpoints

Organization Name FHIR Base URL
Desired Help Providers https://emzone.xyz/portal/apis/default/fhir
Synergy Infoconnect https://openemr.synergyinfoconnect.com/portal/apis/default/fhir

Testing Endpoints

Organization Name FHIR Base URL
OpenEMR Foundation (testing endpoint 1) https://ten.openemr.io/a/openemr/apis/default/fhir
OpenEMR Foundation (testing endpoint 2) https://six.openemr.io/a/openemr/apis/default/fhir
OpenEMR Foundation (testing endpoint 3) https://eleven.openemr.io/a/openemr/apis/default/fhir