- Overview
- Prerequisite
- Using API Internally
- Multisite Support
- Authorization
- Standard API Documentation
- Patient Portal API Documentation
- FHIR API Documentation (in FHIR_README.md)
- For Developers
Easy-to-use JSON-based REST API for OpenEMR. FHIR is also supported, see FHIR API documentation here,
Enable the Standard API service (/api/ endpoints) in OpenEMR menu: Administration->Globals->Connectors->"Enable OpenEMR Standard REST API"
There are several ways to make API calls from an authorized session and maintain security:
- See the script at tests/api/InternalApiTest.php for examples of internal API use cases.
Multisite is supported by including the site in the endpoint. When not using multisite or using the default multisite site, then a typical path would look like apis/default/api/patient. If you are using multisite and using a site called alternate, then the path would look like apis/alternate/api/patient.
OpenEMR uses OIDC compliant authorization for API. SSL is required and setting baseurl at Administration->Globals->Connectors->'Site Address (required for OAuth2 and FHIR)' is required. The listing of scopes can be found in below Scopes section.
This is a listing of scopes:
openid(Generic mandatory scope)fhirUseronline_accessoffline_access(Will signal server to provide a refresh token)launchlaunch/patientapi:fhir(fhir which are the /fhir/ endpoints)patient/AllergyIntolerance.readpatient/CarePlan.readpatient/CareTeam.readpatient/Condition.readpatient/Device.readpatient/DiagnosticReport.readpatient/DocumentReference.readpatient/Encounter.readpatient/Goal.readpatient/Immunization.readpatient/Location.readpatient/Medication.readpatient/MedicationRequest.readpatient/Observation.readpatient/Organization.readpatient/Patient.readpatient/Person.readpatient/Practitioner.readpatient/Procedure.readpatient/Provenance.readsystem/AllergyIntolerance.readsystem/CarePlan.readsystem/CareTeam.readsystem/Condition.readsystem/Coverage.readsystem/Device.readsystem/DiagnosticReport.readsystem/Document.read(used for Bulk FHIR export downloads)system/DocumentReference.readsystem/Encounter.readsystem/Goal.readsystem/Group.readsystem/Group.$export(???)system/Immunization.readsystem/Location.readsystem/Medication.readsystem/MedicationRequest.readsystem/Observation.readsystem/Organization.readsystem/Patient.readsystem/Patient.$export(???)system/Person.readsystem/Practitioner.readsystem/PractitionerRole.readsystem/Procedure.readsystem/Provenance.readsystem/*.$bulkdata-status(???)system/*.$export(???)user/AllergyIntolerance.readuser/CarePlan.readuser/CareTeam.readuser/Condition.readuser/Coverage.readuser/Device.readuser/DiagnosticReport.readuser/DocumentReference.readuser/Encounter.readuser/Goal.readuser/Immunization.readuser/Location.readuser/Medication.readuser/MedicationRequest.readuser/Observation.readuser/Organization.readuser/Organization.writeuser/Patient.readuser/Patient.writeuser/Person.readuser/Practitioner.readuser/Practitioner.writeuser/PractitionerRole.readuser/Procedure.readuser/Provenance.read
api:oemr(user api which are the /api/ endpoints)user/allergy.readuser/allergy.writeuser/appointment.readuser/appointment.writeuser/dental_issue.readuser/dental_issue.writeuser/document.readuser/document.writeuser/drug.readuser/encounter.readuser/encounter.writeuser/facility.readuser/facility.writeuser/immunization.readuser/insurance.readuser/insurance.writeuser/insurance_company.readuser/insurance_company.writeuser/insurance_type.readuser/list.readuser/medical_problem.readuser/medical_problem.writeuser/medication.readuser/medication.writeuser/message.writeuser/patient.readuser/patient.writeuser/practitioner.readuser/practitioner.writeuser/prescription.readuser/procedure.readuser/soap_note.readuser/soap_note.writeuser/surgery.readuser/surgery.writeuser/vital.readuser/vital.write
api:port(patient api which are the /portal/ endpoints) (EXPERIMENTAL)patient/encounter.readpatient/patient.read
Here is an example for registering a client. A client needs to be registered before applying for grant to obtain access/refresh tokens. Note: "post_logout_redirect_uris" is optional and only used if client wants a redirect to its own confirmation workflow.
Note that all scopes are included in this example for demonstration purposes. For production purposes, should only include the necessary scopes.
curl -X POST -k -H 'Content-Type: application/json' -i https://localhost:9300/oauth2/default/registration --data '{
"application_type": "private",
"redirect_uris":
["https://client.example.org/callback"],
"post_logout_redirect_uris":
["https://client.example.org/logout/callback"],
"client_name": "A Private App",
"token_endpoint_auth_method": "client_secret_post",
"contacts": ["me@example.org", "them@example.org"],
"scope": "openid offline_access api:oemr api:fhir api:port user/allergy.read user/allergy.write user/appointment.read user/appointment.write user/dental_issue.read user/dental_issue.write user/document.read user/document.write user/drug.read user/encounter.read user/encounter.write user/facility.read user/facility.write user/immunization.read user/insurance.read user/insurance.write user/insurance_company.read user/insurance_company.write user/insurance_type.read user/list.read user/medical_problem.read user/medical_problem.write user/medication.read user/medication.write user/message.write user/patient.read user/patient.write user/practitioner.read user/practitioner.write user/prescription.read user/procedure.read user/soap_note.read user/soap_note.write user/surgery.read user/surgery.write user/vital.read user/vital.write user/AllergyIntolerance.read user/CareTeam.read user/Condition.read user/Coverage.read user/Encounter.read user/Immunization.read user/Location.read user/Medication.read user/MedicationRequest.read user/Observation.read user/Organization.read user/Organization.write user/Patient.read user/Patient.write user/Practitioner.read user/Practitioner.write user/PractitionerRole.read user/Procedure.read patient/encounter.read patient/patient.read patient/AllergyIntolerance.read patient/CareTeam.read patient/Condition.read patient/Encounter.read patient/Immunization.read patient/MedicationRequest.read patient/Observation.read patient/Patient.read patient/Procedure.read"
}'Response:
{
"client_id": "LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA",
"client_secret": "j21ecvLmFi9HPc_Hv0t7Ptmf1pVcZQLtHjIdU7U9tkS9WAjFJwVMav0G8ogTJ62q4BATovC7BQ19Qagc4x9BBg",
"registration_access_token": "uiDSXx2GNSvYy5n8eW50aGrJz0HjaGpUdrGf07Agv_Q",
"registration_client_uri": "https:\/\/localhost:9300\/oauth2\/default\/client\/6eUVG0-qK2dYiwfYdECKIw",
"client_id_issued_at": 1604767861,
"client_secret_expires_at": 0,
"contacts": ["me@example.org", "them@example.org"],
"application_type": "private",
"client_name": "A Private App",
"redirect_uris": ["https:\/\/client.example.org\/callback"],
"token_endpoint_auth_method": "client_secret_post",
"scope": "openid offline_access api:oemr api:fhir api:port user/allergy.read user/allergy.write user/appointment.read user/appointment.write user/dental_issue.read user/dental_issue.write user/document.read user/document.write user/drug.read user/encounter.read user/encounter.write user/facility.read user/facility.write user/immunization.read user/insurance.read user/insurance.write user/insurance_company.read user/insurance_company.write user/insurance_type.read user/list.read user/medical_problem.read user/medical_problem.write user/medication.read user/medication.write user/message.write user/patient.read user/patient.write user/practitioner.read user/practitioner.write user/prescription.read user/procedure.read user/soap_note.read user/soap_note.write user/surgery.read user/surgery.write user/vital.read user/vital.write user/AllergyIntolerance.read user/CareTeam.read user/Condition.read user/Coverage.read user/Encounter.read user/Immunization.read user/Location.read user/Medication.read user/MedicationRequest.read user/Observation.read user/Organization.read user/Organization.write user/Patient.read user/Patient.write user/Practitioner.read user/Practitioner.write user/PractitionerRole.read user/Procedure.read patient/encounter.read patient/patient.read patient/AllergyIntolerance.read patient/CareTeam.read patient/Condition.read patient/Encounter.read patient/Immunization.read patient/MedicationRequest.read patient/Observation.read patient/Patient.read patient/Procedure.read"
}SMART Enabled Apps are supported.
SMART client can be registered at /interface/smart/register-app.php. For example https://localhost:9300/interface/smart/register-app.php
After registering the SMART client, can then Enable it in OpenEMR at Administration->System->API Clients
After it is enabled, the SMART App will then be available to use in the Patient Summary screen (SMART Enabled Apps widget).
See this github issue for an example of a Smart App installation: openemr#4148
This is the recommended standard mechanism to obtain access/refresh tokens. This is done by using an OAuth2 client with provider url of oauth2/<site>; an example full path would be https://localhost:9300/oauth2/default.
Note that a refresh token is only supplied if the offline_access scope is provided when requesting authorization grant.
Note that a refresh token is only supplied if the offline_access scope is provided when requesting authorization or password grant.
Example:
curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
-i 'https://localhost:9300/oauth2/default/token'
--data 'grant_type=refresh_token
&client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
&refresh_token=def5020089a766d16...'Response:
{
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYn...",
"token_type": "Bearer",
"expires_in": 3599,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYnl1RkRp...",
"refresh_token": "def5020017b484b0add020bf3491a8a537fa04eda12..."
}Recommend not using this mechanism unless you know what you are doing. It is considered far less secure than the standard authorization code method. Because of security implications, it is not turned on by default. It can be turned on at Administration->Globals->Connectors->'Enable OAuth2 Password Grant (Not considered secure)'.
Note that all scopes are included in these examples for demonstration purposes. For production purposes, should only include the necessary scopes.
Note that a refresh token is only supplied if the offline_access scope is provided when requesting password grant.
Example for users role:
curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
-i 'https://localhost:9300/oauth2/default/token'
--data 'grant_type=password
&client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
&scope=openid%20offline_access%20api%3Aoemr%20api%3Afhir%20user%2Fallergy.read%20user%2Fallergy.write%20user%2Fappointment.read%20user%2Fappointment.write%20user%2Fdental_issue.read%20user%2Fdental_issue.write%20user%2Fdocument.read%20user%2Fdocument.write%20user%2Fdrug.read%20user%2Fencounter.read%20user%2Fencounter.write%20user%2Ffacility.read%20user%2Ffacility.write%20user%2Fimmunization.read%20user%2Finsurance.read%20user%2Finsurance.write%20user%2Finsurance_company.read%20user%2Finsurance_company.write%20user%2Finsurance_type.read%20user%2Flist.read%20user%2Fmedical_problem.read%20user%2Fmedical_problem.write%20user%2Fmedication.read%20user%2Fmedication.write%20user%2Fmessage.write%20user%2Fpatient.read%20user%2Fpatient.write%20user%2Fpractitioner.read%20user%2Fpractitioner.write%20user%2Fprescription.read%20user%2Fprocedure.read%20user%2Fsoap_note.read%20user%2Fsoap_note.write%20user%2Fsurgery.read%20user%2Fsurgery.write%20user%2Fvital.read%20user%2Fvital.write%20user%2FAllergyIntolerance.read%20user%2FCareTeam.read%20user%2FCondition.read%20user%2FCoverage.read%20user%2FEncounter.read%20user%2FImmunization.read%20user%2FLocation.read%20user%2FMedication.read%20user%2FMedicationRequest.read%20user%2FObservation.read%20user%2FOrganization.read%20user%2FOrganization.write%20user%2FPatient.read%20user%2FPatient.write%20user%2FPractitioner.read%20user%2FPractitioner.write%20user%2FPractitionerRole.read%20user%2FProcedure.read
&user_role=users
&username=admin
&password=pass'Example for patient role:
curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
-i 'https://localhost:9300/oauth2/default/token'
--data 'grant_type=password
&client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
&scope=openid%20offline_access%20api%3Aport%20api%3Afhir%20patient%2Fencounter.read%20patient%2Fpatient.read%20patient%2FAllergyIntolerance.read%20patient%2FCareTeam.read%20patient%2FCondition.read%20patient%2FEncounter.read%20patient%2FImmunization.read%20patient%2FMedicationRequest.read%20patient%2FObservation.read%20patient%2FPatient.read%20patient%2FProcedure.read
&user_role=patient
&username=Phil1
&password=phil
&email=heya@invalid.email.com'Response:
{
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYn...",
"token_type": "Bearer",
"expires_in": 3599,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYnl1RkRp...",
"refresh_token": "def5020017b484b0add020bf3491a8a537fa04eda12..."
}This is an advanced grant that uses JSON Web Key Sets(JWKS) to authenticate and identify the client. This credential grant is
required to be used for access to any system/*.$export scopes. API clients must register either web accessible JWKS URI that hosts
a RSA384 compatible key, or provide their JWKS as part of the registration. Client Credentials Grant access tokens are short
lived and valid for only 1 minute and no refresh token is issued. Tokens are requested at /oauth2/default/token
To walk you through how to do this process you can follow this guide created by HL7.
A grant (both Authorization Code and Password grants) can be logged out (ie. removed) by url of oauth2/<site>/logout?id_token_hint=<id_token>; an example full path would be https://localhost:9300/oauth2/default/logout?id_token_hint=<id_token>. Optional: post_logout_redirect_uri and state parameters can also be sent; note that post_logout_redirect_uris also needs to be set during registration for it to work.
The forum thread that detailed development of Authorization and where questions and issues are addressed is here: https://community.open-emr.org/t/v6-authorization-and-api-changes-afoot/15450
More specific development api topics are discussed and described on the above forum thread (such as introspection).
The Standard API is documented via Swagger. Can see this documentation (and can test it) by going to the swagger directory in your OpenEMR installation. The Standard API is documented there in the standard section. Can also see (and test) this in the online demos at https://www.open-emr.org/wiki/index.php/Development_Demo#Daily_Build_Development_Demos (clicking on the API (Swagger) User Interface link for the demo will take you there).
OpenEMR standard endpoints Use https://localhost:9300/apis/default/api as base URI.
Note that the default component can be changed to the name of the site when using OpenEMR's multisite feature.
Example: https://localhost:9300/apis/default/api/patient returns a resource of all Patients.
The Bearer token is required for each OpenEMR API request, and is conveyed using an Authorization header. Note that the Bearer token is the access_token that is obtained in the above Authorization section.
Request:
curl -X GET 'https://localhost:9300/apis/default/api/patient/1/medical_problem' \
-H 'Authorization: Bearer eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ=='The Patient Portal API is documented via Swagger. Can see this documentation (and can test it) by going to the swagger directory in your OpenEMR installation. The Patient Portal API is documented there in the standard-patient section. Can also see (and test) this in the online demos at https://www.open-emr.org/wiki/index.php/Development_Demo#Daily_Build_Development_Demos (clicking on the API (Swagger) User Interface link for the demo will take you there).
This is under development and is considered EXPERIMENTAL.
Enable the Patient Portal API service (/portal/ endpoints) in OpenEMR menu: Administration->Globals->Connectors->"Enable OpenEMR Patient Portal REST API (EXPERIMENTAL)"
OpenEMR patient portal endpoints Use https://localhost:9300/apis/default/portal as base URI.
Note that the default component can be changed to the name of the site when using OpenEMR's multisite feature.
Example: https://localhost:9300/apis/default/portal/patient returns a resource of the patient.
The Bearer token is required for each OpenEMR API request, and is conveyed using an Authorization header. Note that the Bearer token is the access_token that is obtained in the above Authorization section.
Request:
curl -X GET 'https://localhost:9300/apis/default/portal/patient' \
-H 'Authorization: Bearer eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ=='- For business logic, make or use the services here
- For controller logic, make or use the classes here
- For routing declarations, use the class here.
REST API endpoints are defined in the primary routes file. The routes file maps an external, addressable endpoint to the OpenEMR controller which handles the request, and also handles the JSON data conversions.
"POST /api/patient" => function () {
RestConfig::authorization_check("patients", "demo");
$data = (array) (json_decode(file_get_contents("php://input")));
$return = (new PatientRestController())->post($data);
RestConfig::apiLog($return, $data);
return $return;
}At a high level, the request processing flow consists of the following steps:
JSON Request -> Controller Component -> Validation -> Service Component -> Database
The logical response flow begins with the database result:
Database Result -> Service Component -> Controller Component -> RequestControllerHelper -> JSON Response
The RequestControllerHelper class evaluates the Service Component's
result and maps it to a http response code and response payload. Existing APIs should be updated to utilize the
handleProcessingResult method as it supports the Validator components.
The PatientRestController may be used as a reference to see how APIs are
integrated with RequestControllerHelper::handleProcessingResult and the Validator components.
Finally, APIs which are integrated with the new handleProcessingResult method utilize a common response format.
{
"validationErrors": [],
"internalErrors": [],
"data": < data payload >
}validationErrorscontain "client based" data validation errorsinternalErrorscontain server related errorsdatais the response payload, represented as an object/{}for single results or an array/[]for multiple results