API_README.md

   1 # OpenEMR REST API Documentation
   2
   3 ## REST API Table of Contents
   4 - [Overview](API_README.md#overview)
   5 - [Prerequisite](API_README.md#prerequisite)
   6 - [Using API Internally](API_README.md#using-api-internally)
   7 - [Multisite Support](API_README.md#multisite-support)
   8 - [Authorization](API_README.md#authorization)
   9     - [Scopes](API_README.md#scopes)
  10     - [Registration](API_README.md#registration)
  11         - [SMART on FHIR Registration](API_README.md#smart-on-fhir-registration)
  12     - [Authorization Code Grant](API_README.md#authorization-code-grant)
  13     - [Refresh Token Grant](API_README.md#refresh-token-grant)
  14     - [Password Grant](API_README.md#password-grant)
  15     - [Client Credentials Grant](API_README#client-credentials-grant)
  16     - [Logout](API_README.md#logout)
  17     - [More Details](API_README.md#more-details)
  18 - [Standard API Documentation](API_README.md#standard-api-documentation)
  19 - [Patient Portal API Documentation](API_README.md#patient-portal-api-documentation)
  20 - [FHIR API Documentation (in FHIR_README.md)](FHIR_README.md#fhir-api-documentation)
  21     - [Capability Statement (in FHIR_README.md)](FHIR_README.md#capability-statement)
  22     - [Provenance (in FHIR_README.md)](FHIR_README.md#Provenance-resources)
  23     - [BULK FHIR Exports (in FHIR_README.md)](FHIR_README.md#bulk-fhir-exports)
  24         - [System Export (in FHIR_README.md)](FHIR_README.md#bulk-fhir-exports)
  25         - [Patient Export (in FHIR_README.md)](FHIR_README.md#bulk-fhir-exports)
  26         - [Group Export (in FHIR_README.md)](FHIR_README.md#bulk-fhir-exports)
  27 - [For Developers](API_README.md#for-developers)
  28
  29 ## Overview
  30
  31 Easy-to-use JSON-based REST API for OpenEMR. FHIR is also supported, see FHIR API documentation [here](FHIR_README.md),
  32
  33 ## Prerequisite
  34
  35 Enable the Standard API service (/api/ endpoints) in OpenEMR menu: Administration->Globals->Connectors->"Enable OpenEMR Standard REST API"
  36
  37 ## Using API Internally
  38
  39 There are several ways to make API calls from an authorized session and maintain security:
  40
  41 -   See the script at tests/api/InternalApiTest.php for examples of internal API use cases.
  42
  43 ## Multisite Support
  44
  45 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`.
  46
  47 ## Authorization
  48
  49 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.
  50
  51 ### Scopes
  52
  53 This is a listing of scopes:
  54 - `openid` (Generic mandatory scope)
  55 - `fhirUser`
  56 - `online_access`
  57 - `offline_access` (Will signal server to provide a refresh token)
  58 - `launch`
  59 - `launch/patient`
  60 - `api:fhir` (fhir which are the /fhir/ endpoints)
  61   - `patient/AllergyIntolerance.read`
  62   - `patient/CarePlan.read`
  63   - `patient/CareTeam.read`
  64   - `patient/Condition.read`
  65   - `patient/Coverage.read`
  66   - `patient/Device.read`
  67   - `patient/DiagnosticReport.read`
  68   - `patient/DocumentReference.read`
  69   - `patient/Encounter.read`
  70   - `patient/Goal.read`
  71   - `patient/Immunization.read`
  72   - `patient/Location.read`
  73   - `patient/MedicationRequest.read`
  74   - `patient/Observation.read`
  75   - `patient/Organization.read`
  76   - `patient/Patient.read`
  77   - `patient/Person.read`
  78   - `patient/Practitioner.read`
  79   - `patient/Procedure.read`
  80   - `patient/Provenance.read`
  81   - `system/AllergyIntolerance.read`
  82   - `system/CarePlan.read`
  83   - `system/CareTeam.read`
  84   - `system/Condition.read`
  85   - `system/Coverage.read`
  86   - `system/Device.read`
  87   - `system/DiagnosticReport.read`
  88   - `system/Document.read` (used for Bulk FHIR export downloads)
  89   - `system/DocumentReference.read`
  90   - `system/Encounter.read`
  91   - `system/Goal.read`
  92   - `system/Group.read`
  93   - `system/Group.$export` (???)
  94   - `system/Immunization.read`
  95   - `system/Location.read`
  96   - `system/MedicationRequest.read`
  97   - `system/Observation.read`
  98   - `system/Organization.read`
  99   - `system/Patient.read`
 100   - `system/Patient.$export` (???)
 101   - `system/Person.read`
 102   - `system/Practitioner.read`
 103   - `system/PractitionerRole.read`
 104   - `system/Procedure.read`
 105   - `system/Provenance.read`
 106   - `system/*.$bulkdata-status` (???)
 107   - `system/*.$export` (???)
 108   - `user/AllergyIntolerance.read`
 109   - `user/CarePlan.read`
 110   - `user/CareTeam.read`
 111   - `user/Condition.read`
 112   - `user/Coverage.read`
 113   - `user/Device.read`
 114   - `user/DiagnosticReport.read`
 115   - `user/DocumentReference.read`
 116   - `user/Encounter.read`
 117   - `user/Goal.read`
 118   - `user/Immunization.read`
 119   - `user/Location.read`
 120   - `user/MedicationRequest.read`
 121   - `user/Observation.read`
 122   - `user/Organization.read`
 123   - `user/Organization.write`
 124   - `user/Patient.read`
 125   - `user/Patient.write`
 126   - `user/Person.read`
 127   - `user/Practitioner.read`
 128   - `user/Practitioner.write`
 129   - `user/PractitionerRole.read`
 130   - `user/Procedure.read`
 131   - `user/Provenance.read`
 132 - `api:oemr` (user api which are the /api/ endpoints)
 133   - `user/allergy.read`
 134   - `user/allergy.write`
 135   - `user/appointment.read`
 136   - `user/appointment.write`
 137   - `user/dental_issue.read`
 138   - `user/dental_issue.write`
 139   - `user/document.read`
 140   - `user/document.write`
 141   - `user/drug.read`
 142   - `user/encounter.read`
 143   - `user/encounter.write`
 144   - `user/facility.read`
 145   - `user/facility.write`
 146   - `user/immunization.read`
 147   - `user/insurance.read`
 148   - `user/insurance.write`
 149   - `user/insurance_company.read`
 150   - `user/insurance_company.write`
 151   - `user/insurance_type.read`
 152   - `user/list.read`
 153   - `user/medical_problem.read`
 154   - `user/medical_problem.write`
 155   - `user/medication.read`
 156   - `user/medication.write`
 157   - `user/message.write`
 158   - `user/patient.read`
 159   - `user/patient.write`
 160   - `user/practitioner.read`
 161   - `user/practitioner.write`
 162   - `user/prescription.read`
 163   - `user/procedure.read`
 164   - `user/soap_note.read`
 165   - `user/soap_note.write`
 166   - `user/surgery.read`
 167   - `user/surgery.write`
 168   - `user/transaction.read`
 169   - `user/transaction.write`
 170   - `user/vital.read`
 171   - `user/vital.write`
 172 - `api:port` (patient api which are the /portal/ endpoints) (EXPERIMENTAL)
 173   - `patient/encounter.read`
 174   - `patient/patient.read`
 175
 176 ### Registration
 177
 178 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.
 179
 180 Note that all scopes are included in this example for demonstration purposes. For production purposes, should only include the necessary scopes.
 181
 182 ```sh
 183 curl -X POST -k -H 'Content-Type: application/json' -i https://localhost:9300/oauth2/default/registration --data '{
 184    "application_type": "private",
 185    "redirect_uris":
 186      ["https://client.example.org/callback"],
 187    "post_logout_redirect_uris":
 188      ["https://client.example.org/logout/callback"],
 189    "client_name": "A Private App",
 190    "token_endpoint_auth_method": "client_secret_post",
 191    "contacts": ["me@example.org", "them@example.org"],
 192    "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/transaction.read user/transaction.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/Coverage.read patient/Encounter.read patient/Immunization.read patient/MedicationRequest.read patient/Observation.read patient/Patient.read patient/Procedure.read"
 193   }'
 194 ```
 195
 196 Response:
 197 ```sh
 198 {
 199     "client_id": "LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA",
 200     "client_secret": "j21ecvLmFi9HPc_Hv0t7Ptmf1pVcZQLtHjIdU7U9tkS9WAjFJwVMav0G8ogTJ62q4BATovC7BQ19Qagc4x9BBg",
 201     "registration_access_token": "uiDSXx2GNSvYy5n8eW50aGrJz0HjaGpUdrGf07Agv_Q",
 202     "registration_client_uri": "https:\/\/localhost:9300\/oauth2\/default\/client\/6eUVG0-qK2dYiwfYdECKIw",
 203     "client_id_issued_at": 1604767861,
 204     "client_secret_expires_at": 0,
 205     "contacts": ["me@example.org", "them@example.org"],
 206     "application_type": "private",
 207     "client_name": "A Private App",
 208     "redirect_uris": ["https:\/\/client.example.org\/callback"],
 209     "token_endpoint_auth_method": "client_secret_post",
 210     "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/transaction.read user/transaction.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/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/Coverage.read patient/Encounter.read patient/Immunization.read patient/MedicationRequest.read patient/Observation.read patient/Patient.read patient/Procedure.read"
 211 }
 212 ```
 213
 214 #### SMART on FHIR Registration
 215
 216 SMART Enabled Apps are supported.
 217
 218 SMART client can be registered at <website>/interface/smart/register-app.php. For example https://localhost:9300/interface/smart/register-app.php
 219
 220 After registering the SMART client, can then Enable it in OpenEMR at Administration->System->API Clients
 221
 222 After it is enabled, the SMART App will then be available to use in the Patient Summary screen (SMART Enabled Apps widget).
 223
 224 See this github issue for an example of a Smart App installation: https://github.com/openemr/openemr/issues/4148
 225
 226 ### Authorization Code Grant
 227
 228 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`.  Standard OAUTH2 clients will retrieve the authorize URL from the FHIR /metadata endpoint, but if you are building your own client you can access the metadata or go directly to the https://localhost:9300/oauth2/default/authorize endpoint.
 229
 230 Note that a refresh token is only supplied if the `offline_access` scope is provided when requesting authorization grant.
 231
 232 You will need to pass the scopes you are requesting, the redirect_uri (must be one that was registered at the time of your client registration), and a state parameter which can be any value.  Once authorization has finished the browser will be redirected to the URL specified in redirect_uri with an encrypted code value and the state value sent in the initial authorize request.
 233
 234 Example GET (this must be done in a browser):
 235 ```
 236 GET /oauth2/default/authorize?client_id=yi4mnmVadpnqnJiOigkcGshuG-Kayiq6kmLqCJsYrk4&response_type=code&scope=launch%2Fpatient%20openid%20fhirUser%20offline_access%20patient%2FAllergyIntolerance.read%20patient%2FCarePlan.read%20patient%2FCareTeam.read%20patient%2FCondition.read%20patient%2FDevice.read%20patient%2FDiagnosticReport.read%20patient%2FDocumentReference.read%20patient%2FEncounter.read%20patient%2FGoal.read%20patient%2FImmunization.read%20patient%2FLocation.read%20patient%2FMedication.read%20patient%2FMedicationRequest.read%20patient%2FObservation.read%20patient%2FOrganization.read%20patient%2FPatient.read%20patient%2FPractitioner.read%20patient%2FProcedure.read%20patient%2FProvenance.read&redirect_uri=https%3A%2F%2Fclient.example.org%2Fcallback&state=9512151b-e5ca-cb4b-1ddc-aaf4cd8c6ecc
 237 ```
 238
 239 The client application must then make a request for an access token by hitting the /token endpoint.  Note the redirect_uri MUST match what what was sent in /authorize endpoint.
 240
 241 Example POST
 242 ```
 243 curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
 244 'https://localhost:9300/oauth2/default/token'
 245 --data 'grant_type=authorization_code&redirect_uri=https%3A%2F%2Fclient.example.org%2Fcallback&code=def50...'
 246 ```
 247 ### Refresh Token Grant
 248
 249 Note that a refresh token is only supplied if the `offline_access` scope is provided when requesting authorization or password grant.
 250
 251 Example:
 252
 253 ```sh
 254 curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
 255 -i 'https://localhost:9300/oauth2/default/token'
 256 --data 'grant_type=refresh_token
 257 &client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
 258 &refresh_token=def5020089a766d16...'
 259 ```
 260
 261 Response:
 262
 263 ```json
 264 {
 265   "id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYn...",
 266   "token_type": "Bearer",
 267   "expires_in": 3599,
 268   "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYnl1RkRp...",
 269   "refresh_token": "def5020017b484b0add020bf3491a8a537fa04eda12..."
 270 }
 271 ```
 272
 273 ### Password Grant
 274
 275 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)'.
 276
 277 Note that all scopes are included in these examples for demonstration purposes. For production purposes, should only include the necessary scopes.
 278
 279 Note that a refresh token is only supplied if the `offline_access` scope is provided when requesting password grant.
 280
 281 Example for `users` role:
 282 ```sh
 283 curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
 284 -i 'https://localhost:9300/oauth2/default/token'
 285 --data 'grant_type=password
 286 &client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
 287 &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%2Ftransaction.read%20user%2Ftransaction.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%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
 288 &user_role=users
 289 &username=admin
 290 &password=pass'
 291 ```
 292
 293 Example for `patient` role:
 294 ```sh
 295 curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded'
 296 -i 'https://localhost:9300/oauth2/default/token'
 297 --data 'grant_type=password
 298 &client_id=LnjqojEEjFYe5j2Jp9m9UnmuxOnMg4VodEJj3yE8_OA
 299 &scope=openid%20offline_access%20api%3Aport%20api%3Afhir%20patient%2Fencounter.read%20patient%2Fpatient.read%20patient%2FAllergyIntolerance.read%20patient%2FCareTeam.read%20patient%2FCondition.read%20patient%2FCoverage.read%20patient%2FEncounter.read%20patient%2FImmunization.read%20patient%2FMedication%20patient%2FMedicationRequest.read%20patient%2FObservation.read%20patient%2FPatient.read%20patient%2FProcedure.read
 300 &user_role=patient
 301 &username=Phil1
 302 &password=phil
 303 &email=heya@invalid.email.com'
 304 ```
 305
 306 Response:
 307
 308 ```json
 309 {
 310   "id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYn...",
 311   "token_type": "Bearer",
 312   "expires_in": 3599,
 313   "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrYnl1RkRp...",
 314   "refresh_token": "def5020017b484b0add020bf3491a8a537fa04eda12..."
 315 }
 316 ```
 317
 318 ### Client Credentials Grant
 319
 320 This is an advanced grant that uses JSON Web Key Sets(JWKS) to authenticate and identify the client.  This credential grant is
 321 required to be used for access to any **system/\*.$export** scopes.  API clients must register either web accessible JWKS URI that hosts
 322 a RSA384 compatible key, or provide their JWKS as part of the registration. Client Credentials Grant access tokens are short
 323 lived and valid for only 1 minute and no refresh token is issued.  Tokens are requested at `/oauth2/default/token`
 324 To walk you through how to do this process you can follow [this guide created by HL7](https://hl7.org/fhir/uv/bulkdata/authorization/index.html).
 325
 326 ### Logout
 327
 328 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.
 329
 330 ### More Details
 331
 332 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
 333
 334 More specific development api topics are discussed and described on the above forum thread (such as introspection).
 335
 336 ## Standard API Documentation
 337
 338 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).  Make sure to set your client api registration's redirect_uris to be `<OpenEMR base URI>/swagger/oauth2-redirect.html`.
 339
 340 OpenEMR standard endpoints Use `https://localhost:9300/apis/default/api as base URI.`
 341
 342 Note that the `default` component can be changed to the name of the site when using OpenEMR's multisite feature.
 343
 344 _Example:_ `https://localhost:9300/apis/default/api/patient` returns a resource of all Patients.
 345
 346 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](API_README.md#authorization) section.
 347
 348 Request:
 349
 350 ```sh
 351 curl -X GET 'https://localhost:9300/apis/default/api/patient/1/medical_problem' \
 352   -H 'Authorization: Bearer eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ=='
 353 ```
 354
 355 ## Patient Portal API Documentation
 356
 357 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). Make sure to set your client api registration's redirect_uris to be `<OpenEMR base URI>/swagger/oauth2-redirect.html`.
 358
 359 This is under development and is considered EXPERIMENTAL.
 360
 361 Enable the Patient Portal API service (/portal/ endpoints) in OpenEMR menu: Administration->Globals->Connectors->"Enable OpenEMR Patient Portal REST API (EXPERIMENTAL)"
 362
 363 OpenEMR patient portal endpoints Use `https://localhost:9300/apis/default/portal as base URI.`
 364
 365 Note that the `default` component can be changed to the name of the site when using OpenEMR's multisite feature.
 366
 367 _Example:_ `https://localhost:9300/apis/default/portal/patient` returns a resource of the patient.
 368
 369 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](API_README.md#authorization) section.
 370
 371 Request:
 372
 373 ```sh
 374 curl -X GET 'https://localhost:9300/apis/default/portal/patient' \
 375   -H 'Authorization: Bearer eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ=='
 376 ```
 377
 378 ## For Developers
 379
 380 -   For business logic, make or use the services [here](src/Services)
 381 -   For controller logic, make or use the classes [here](src/RestControllers)
 382 -   For routing declarations, use the class [here](_rest_routes.inc.php).
 383
 384 REST API endpoints are defined in the [primary routes file](_rest_routes.inc.php). The routes file maps an external, addressable
 385 endpoint to the OpenEMR controller which handles the request, and also handles the JSON data conversions.
 386
 387 ```php
 388 "POST /api/patient" => function () {
 389     RestConfig::authorization_check("patients", "demo");
 390     $data = (array) (json_decode(file_get_contents("php://input")));
 391     $return = (new PatientRestController())->post($data);
 392     RestConfig::apiLog($return, $data);
 393     return $return;
 394 }
 395 ```
 396
 397 At a high level, the request processing flow consists of the following steps:
 398
 399 ```
 400 JSON Request -> Controller Component -> Validation -> Service Component -> Database
 401 ```
 402
 403 The logical response flow begins with the database result:
 404
 405 ```
 406 Database Result -> Service Component -> Controller Component -> RequestControllerHelper -> JSON Response
 407 ```
 408
 409 The [RequestControllerHelper class](./src/RestControllers/RestControllerHelper.php) evaluates the Service Component's
 410 result and maps it to a http response code and response payload. Existing APIs should be updated to utilize the
 411 `handleProcessingResult` method as it supports the [Validator](./src/Validators/BaseValidator.php) components.
 412
 413 The [PatientRestController](./src/RestControllers/PatientRestController.php) may be used as a reference to see how APIs are
 414 integrated with `RequestControllerHelper::handleProcessingResult` and the `Validator` components.
 415
 416 Finally, APIs which are integrated with the new `handleProcessingResult` method utilize a common response format.
 417
 418 ```json
 419 {
 420     "validationErrors": [],
 421     "internalErrors": [],
 422     "data": < data payload >
 423 }
 424 ```
 425
 426 -   `validationErrors` contain "client based" data validation errors
 427 -   `internalErrors` contain server related errors
 428 -   `data` is the response payload, represented as an object/`{}` for single results or an array/`[]` for multiple results