?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
chore(deps): bump twig/twig from 3.17.1 to 3.19.0 (#7951)
[openemr.git] / _rest_routes.inc.php
blobd3fa1ef324e461dedce76cac5249825c2bbeab2c
1 <?php
2
3 /**
4 * Routes
5 * (All REST routes)
6 *
7 * @package OpenEMR
8 * @link http://www.open-emr.org
9 * @author Matthew Vita <matthewvita48@gmail.com>
10 * @author Jerry Padgett <sjpadgett@gmail.com>
11 * @author Brady Miller <brady.g.miller@gmail.com>
12 * @author Yash Raj Bothra <yashrajbothra786@gmail.com>
13 * @author Stephen Nielson <snielson@discoverandchange.com>
14 * @copyright Copyright (c) 2018 Matthew Vita <matthewvita48@gmail.com>
15 * @copyright Copyright (c) 2018-2020 Jerry Padgett <sjpadgett@gmail.com>
16 * @copyright Copyright (c) 2019-2021 Brady Miller <brady.g.miller@gmail.com>
17 * @copyright Copyright (c) 2020 Yash Raj Bothra <yashrajbothra786@gmail.com>
18 * @copyright Copyright (c) 2024 Care Management Solutions, Inc. <stephen.waite@cmsvt.com>
19 * @license https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
20 */
21
22 /**
23 * @OA\Info(title="OpenEMR API", version="7.0.3")
24 * @OA\Server(url="/apis/default/")
25 * @OA\SecurityScheme(
26 * securityScheme="openemr_auth",
27 * type="oauth2",
28 * @OA\Flow(
29 * authorizationUrl="/oauth2/default/authorize",
30 * tokenUrl="/oauth2/default/token",
31 * refreshUrl="/oauth2/default/token",
32 * flow="authorizationCode",
33 * scopes={
34 * "openid": "Generic mandatory scope",
35 * "offline_access": "Will signal server to provide a refresh token",
36 * "launch/patient": "Will provide a patient selector when logging in as an OpenEMR user (required for testing patient/* scopes in swagger if not logging in as a patient)",
37 * "api:fhir": "FHIR R4 API",
38 * "patient/AllergyIntolerance.read": "Read allergy intolerance resources for the current patient (api:fhir)",
39 * "patient/Appointment.read": "Read appointment resources for the current patient (api:fhir)",
40 * "patient/Binary.read": "Read binary document resources for the current patient (api:fhir)",
41 * "patient/CarePlan.read": "Read care plan resources for the current patient (api:fhir)",
42 * "patient/CareTeam.read": "Read care team resources for the current patient (api:fhir)",
43 * "patient/Condition.read": "Read condition resources for the current patient (api:fhir)",
44 * "patient/Coverage.read": "Read coverage resources for the current patient (api:fhir)",
45 * "patient/Device.read": "Read device resources for the current patient (api:fhir)",
46 * "patient/DiagnosticReport.read": "Read diagnostic report resources for the current patient (api:fhir)",
47 * "patient/DocumentReference.read": "Read document reference resources for the current patient (api:fhir)",
48 * "patient/DocumentReference.$docref" : "Generate a document for the current patient or returns the most current Clinical Summary of Care Document (CCD)",
49 * "patient/Encounter.read": "Read encounter resources for the current patient (api:fhir)",
50 * "patient/Goal.read": "Read goal resources for the current patient (api:fhir)",
51 * "patient/Immunization.read": "Read immunization resources for the current patient (api:fhir)",
52 * "patient/Location.read": "Read location resources for the current patient (api:fhir)",
53 * "patient/Medication.read": "Read medication resources for the current patient (api:fhir)",
54 * "patient/MedicationRequest.read": "Read medication request resources for the current patient (api:fhir)",
55 * "patient/Observation.read": "Read observation resources for the current patient (api:fhir)",
56 * "patient/Organization.read": "Read organization resources for the current patient (api:fhir)",
57 * "patient/Patient.read": "Read patient resource for the current patient (api:fhir)",
58 * "patient/Person.read": "Read person resources for the current patient (api:fhir)",
59 * "patient/Practitioner.read": "Read practitioner resources for the current patient (api:fhir)",
60 * "patient/Procedure.read": "Read procedure resources for the current patient (api:fhir)",
61 * "patient/Provenance.read": "Read provenance resources for the current patient (api:fhir)",
62 * "system/AllergyIntolerance.read": "Read all allergy intolerance resources in the system (api:fhir)",
63 * "system/Binary.read": "Read all binary document resources in the system (api:fhir)",
64 * "system/CarePlan.read": "Read all care plan resources in the system (api:fhir)",
65 * "system/CareTeam.read": "Read all care team resources in the system (api:fhir)",
66 * "system/Condition.read": "Read all condition resources in the system (api:fhir)",
67 * "system/Coverage.read": "Read all coverage resources in the system (api:fhir)",
68 * "system/Device.read": "Read all device resources in the system (api:fhir)",
69 * "system/DiagnosticReport.read": "Read all diagnostic report resources in the system (api:fhir)",
70 * "system/DocumentReference.read": "Read all document reference resources in the system (api:fhir)",
71 * "system/DocumentReference.$docref" : "Generate a document for any patient in the system or returns the most current Clinical Summary of Care Document (CCD)",
72 * "system/Encounter.read": "Read all encounter resources in the system (api:fhir)",
73 * "system/Goal.read": "Read all goal resources in the system (api:fhir)",
74 * "system/Group.read": "Read all group resources in the system (api:fhir)",
75 * "system/Immunization.read": "Read all immunization resources in the system (api:fhir)",
76 * "system/Location.read": "Read all location resources in the system (api:fhir)",
77 * "system/Medication.read": "Read all medication resources in the system (api:fhir)",
78 * "system/MedicationRequest.read": "Read all medication request resources in the system (api:fhir)",
79 * "system/Observation.read": "Read all observation resources in the system (api:fhir)",
80 * "system/Organization.read": "Read all organization resources in the system (api:fhir)",
81 * "system/Patient.read": "Read all patient resources in the system (api:fhir)",
82 * "system/Person.read": "Read all person resources in the system (api:fhir)",
83 * "system/Practitioner.read": "Read all practitioner resources in the system (api:fhir)",
84 * "system/PractitionerRole.read": "Read all practitioner role resources in the system (api:fhir)",
85 * "system/Procedure.read": "Read all procedure resources in the system (api:fhir)",
86 * "system/Provenance.read": "Read all provenance resources in the system (api:fhir)",
87 * "system/ValueSet.read": "Read all valueSet resources in the system (api:fhir)",
88 * "user/AllergyIntolerance.read": "Read all allergy intolerance resources the user has access to (api:fhir)",
89 * "user/Binary.read" : "Read all binary documents the user has access to (api:fhir)",
90 * "user/CarePlan.read": "Read all care plan resources the user has access to (api:fhir)",
91 * "user/CareTeam.read": "Read all care team resources the user has access to (api:fhir)",
92 * "user/Condition.read": "Read all condition resources the user has access to (api:fhir)",
93 * "user/Coverage.read": "Read all coverage resources the user has access to (api:fhir)",
94 * "user/Device.read": "Read all device resources the user has access to (api:fhir)",
95 * "user/DiagnosticReport.read": "Read all diagnostic report resources the user has access to (api:fhir)",
96 * "user/DocumentReference.read": "Read all document reference resources the user has access to (api:fhir)",
97 * "user/DocumentReference.$docref" : "Generate a document for any patient the user has access to or returns the most current Clinical Summary of Care Document (CCD) (api:fhir)",
98 * "user/Encounter.read": "Read all encounter resources the user has access to (api:fhir)",
99 * "user/Goal.read": "Read all goal resources the user has access to (api:fhir)",
100 * "user/Immunization.read": "Read all immunization resources the user has access to (api:fhir)",
101 * "user/Location.read": "Read all location resources the user has access to (api:fhir)",
102 * "user/Medication.read": "Read all medication resources the user has access to (api:fhir)",
103 * "user/MedicationRequest.read": "Read all medication request resources the user has access to (api:fhir)",
104 * "user/Observation.read": "Read all observation resources the user has access to (api:fhir)",
105 * "user/Organization.read": "Read all organization resources the user has access to (api:fhir)",
106 * "user/Organization.write": "Write all organization resources the user has access to (api:fhir)",
107 * "user/Patient.read": "Read all patient resources the user has access to (api:fhir)",
108 * "user/Patient.write": "Write all patient resources the user has access to (api:fhir)",
109 * "user/Person.read": "Read all person resources the user has access to (api:fhir)",
110 * "user/Practitioner.read": "Read all practitioner resources the user has access to (api:fhir)",
111 * "user/Practitioner.write": "Write all practitioner resources the user has access to (api:fhir)",
112 * "user/PractitionerRole.read": "Read all practitioner role resources the user has access to (api:fhir)",
113 * "user/Procedure.read": "Read all procedure resources the user has access to (api:fhir)",
114 * "user/Provenance.read": "Read all provenance resources the user has access to (api:fhir)",
115 * "user/ValueSet.read": "Read all valueSet resources the user has access to (api:fhir)",
116 * "api:oemr": "Standard OpenEMR API",
117 * "user/allergy.read": "Read allergies the user has access to (api:oemr)",
118 * "user/allergy.write": "Write allergies the user has access to for (api:oemr)",
119 * "user/appointment.read": "Read appointments the user has access to (api:oemr)",
120 * "user/appointment.write": "Write appointments the user has access to for (api:oemr)",
121 * "user/dental_issue.read": "Read dental issues the user has access to (api:oemr)",
122 * "user/dental_issue.write": "Write dental issues the user has access to (api:oemr)",
123 * "user/document.read": "Read documents the user has access to (api:oemr)",
124 * "user/document.write": "Write documents the user has access to (api:oemr)",
125 * "user/drug.read": "Read drugs the user has access to (api:oemr)",
126 * "user/encounter.read": "Read encounters the user has access to (api:oemr)",
127 * "user/encounter.write": "Write encounters the user has access to (api:oemr)",
128 * "user/facility.read": "Read facilities the user has access to (api:oemr)",
129 * "user/facility.write": "Write facilities the user has access to (api:oemr)",
130 * "user/immunization.read": "Read immunizations the user has access to (api:oemr)",
131 * "user/insurance.read": "Read insurances the user has access to (api:oemr)",
132 * "user/insurance.write": "Write insurances the user has access to (api:oemr)",
133 * "user/insurance_company.read": "Read insurance companies the user has access to (api:oemr)",
134 * "user/insurance_company.write": "Write insurance companies the user has access to (api:oemr)",
135 * "user/insurance_type.read": "Read insurance types the user has access to (api:oemr)",
136 * "user/list.read": "Read lists the user has access to (api:oemr)",
137 * "user/medical_problem.read": "Read medical problems the user has access to (api:oemr)",
138 * "user/medical_problem.write": "Write medical problems the user has access to (api:oemr)",
139 * "user/medication.read": "Read medications the user has access to (api:oemr)",
140 * "user/medication.write": "Write medications the user has access to (api:oemr)",
141 * "user/message.write": "Read messages the user has access to (api:oemr)",
142 * "user/patient.read": "Read patients the user has access to (api:oemr)",
143 * "user/patient.write": "Write patients the user has access to (api:oemr)",
144 * "user/practitioner.read": "Read practitioners the user has access to (api:oemr)",
145 * "user/practitioner.write": "Write practitioners the user has access to (api:oemr)",
146 * "user/prescription.read": "Read prescriptions the user has access to (api:oemr)",
147 * "user/procedure.read": "Read procedures the user has access to (api:oemr)",
148 * "user/soap_note.read": "Read soap notes the user has access to (api:oemr)",
149 * "user/soap_note.write": "Write soap notes the user has access to (api:oemr)",
150 * "user/surgery.read": "Read surgeries the user has access to (api:oemr)",
151 * "user/surgery.write": "Write surgeries the user has access to (api:oemr)",
152 * "user/transaction.read": "Read transactions the user has access to (api:oemr)",
153 * "user/transaction.write": "Write transactions the user has access to (api:oemr)",
154 * "user/user.read": "Read users the current user has access to (api:oemr)",
155 * "user/vital.read": "Read vitals the user has access to (api:oemr)",
156 * "user/vital.write": "Write vitals the user has access to (api:oemr)",
157 * "api:port": "Standard Patient Portal OpenEMR API",
158 * "patient/encounter.read": "Read encounters the patient has access to (api:port)",
159 * "patient/patient.read": "Write encounters the patient has access to (api:port)",
160 * "patient/appointment.read": "Read appointments the patient has access to (api:port)"
161 * }
162 * )
163 * )
164 * @OA\Tag(
165 * name="fhir",
166 * description="FHIR R4 API"
167 * )
168 * @OA\Tag(
169 * name="standard",
170 * description="Standard OpenEMR API"
171 * )
172 * @OA\Tag(
173 * name="standard-patient",
174 * description="Standard Patient Portal OpenEMR API"
175 * )
176 * @OA\Parameter(
177 * name="_sort",
178 * in="query",
179 * parameter="_sort",
180 * description="The sort criteria specified in comma separated order with Descending order being specified by a dash before the search parameter name. (Example: name,-category)",
181 * required=false,
182 * @OA\Schema(
183 * type="string"
184 * )
185 * )
186 * @OA\Parameter(
187 * name="_lastUpdated",
188 * in="query",
189 * parameter="_lastUpdated",
190 * description="The date the resource was last updated.",
191 * required=false,
192 * @OA\Schema(
193 * type="string"
194 * )
195 * )
196 * @OA\Response(
197 * response="standard",
198 * description="Standard Response",
199 * @OA\MediaType(
200 * mediaType="application/json",
201 * @OA\Schema(
202 * @OA\Property(
203 * property="validationErrors",
204 * description="Validation errors.",
205 * type="array",
206 * @OA\Items(
207 * type="object",
208 * ),
209 * ),
210 * @OA\Property(
211 * property="internalErrors",
212 * description="Internal errors.",
213 * type="array",
214 * @OA\Items(
215 * type="object",
216 * ),
217 * ),
218 * @OA\Property(
219 * property="data",
220 * description="Returned data.",
221 * type="array",
222 * @OA\Items(
223 * type="object",
224 * ),
225 * ),
226 * example={
227 * "validationErrors": {},
228 * "error_description": {},
229 * "data": {}
230 * }
231 * )
232 * )
233 * )
234 * @OA\Response(
235 * response="badrequest",
236 * description="Bad Request",
237 * @OA\MediaType(
238 * mediaType="application/json",
239 * @OA\Schema(
240 * @OA\Property(
241 * property="validationErrors",
242 * description="Validation errors.",
243 * type="object"
244 * ),
245 * example={
246 * "validationErrors":
247 * {
248 * "_id": "The search field argument was invalid, improperly formatted, or could not be parsed. Inner message: UUID columns must be a valid UUID string"
249 * }
250 * }
251 * )
252 * )
253 * )
254 * @OA\Response(
255 * response="unauthorized",
256 * description="Unauthorized",
257 * @OA\MediaType(
258 * mediaType="application/json",
259 * @OA\Schema(
260 * @OA\Property(
261 * property="error",
262 * description="The error.",
263 * type="string"
264 * ),
265 * @OA\Property(
266 * property="error_description",
267 * description="The description of the error.",
268 * type="string"
269 * ),
270 * @OA\Property(
271 * property="hint",
272 * description="More specific information on the error.",
273 * type="string"
274 * ),
275 * @OA\Property(
276 * property="message",
277 * description="Message regarding the error.",
278 * type="string"
279 * ),
280 * example={
281 * "error": "access_denied",
282 * "error_description": "The resource owner or authorization server denied the request.",
283 * "hint": "Missing ""Authorization"" header",
284 * "message": "The resource owner or authorization server denied the request."
285 * }
286 * )
287 * )
288 * )
289 * @OA\Response(
290 * response="uuidnotfound",
291 * description="Not Found",
292 * @OA\MediaType(
293 * mediaType="application/json",
294 * @OA\Schema(
295 * @OA\Property(
296 * property="empty",
297 * description="empty",
298 * type="object"
299 * ),
300 * example={}
301 * )
302 * )
303 * )
304 */
305
306 // Lets keep our controller classes with the routes.
307 //
308 use OpenEMR\Common\Acl\AccessDeniedException;
309 use OpenEMR\Common\Http\HttpRestRequest;
310 use OpenEMR\RestControllers\AllergyIntoleranceRestController;
311 use OpenEMR\RestControllers\FacilityRestController;
312 use OpenEMR\RestControllers\VersionRestController;
313 use OpenEMR\RestControllers\ProductRegistrationRestController;
314 use OpenEMR\RestControllers\PatientRestController;
315 use OpenEMR\RestControllers\EncounterRestController;
316 use OpenEMR\RestControllers\PractitionerRestController;
317 use OpenEMR\RestControllers\ListRestController;
318 use OpenEMR\RestControllers\InsuranceCompanyRestController;
319 use OpenEMR\RestControllers\AppointmentRestController;
320 use OpenEMR\RestControllers\ConditionRestController;
321 use OpenEMR\RestControllers\ONoteRestController;
322 use OpenEMR\RestControllers\DocumentRestController;
323 use OpenEMR\RestControllers\DrugRestController;
324 use OpenEMR\RestControllers\EmployerRestController;
325 use OpenEMR\RestControllers\ImmunizationRestController;
326 use OpenEMR\RestControllers\InsuranceRestController;
327 use OpenEMR\RestControllers\MessageRestController;
328 use OpenEMR\RestControllers\PrescriptionRestController;
329 use OpenEMR\RestControllers\ProcedureRestController;
330 use OpenEMR\RestControllers\TransactionRestController;
331 use OpenEMR\RestControllers\UserRestController;
332 use OpenEMR\Services\Search\SearchQueryConfig;
333
334 // Note some Http clients may not send auth as json so a function
335 // is implemented to determine and parse encoding on auth route's.
336
337 // Note that the api route is only for users role
338 // (there is a mechanism in place to ensure only user role can access the api route)
339 RestConfig::$ROUTE_MAP = array(
340 /**
341 * @OA\Get(
342 * path="/api/facility",
343 * description="Returns a single facility.",
344 * tags={"standard"},
345 * @OA\Parameter(
346 * name="name",
347 * in="query",
348 * description="The name for the facility.",
349 * required=false,
350 * @OA\Schema(
351 * type="string"
352 * )
353 * ),
354 * @OA\Parameter(
355 * name="facility_npi",
356 * in="query",
357 * description="The facility_npi for the facility.",
358 * required=false,
359 * @OA\Schema(
360 * type="string"
361 * )
362 * ),
363 * @OA\Parameter(
364 * name="phone",
365 * in="query",
366 * description="The phone for the facility.",
367 * required=false,
368 * @OA\Schema(
369 * type="string"
370 * )
371 * ),
372 * @OA\Parameter(
373 * name="fax",
374 * in="query",
375 * description="The fax for the facility.",
376 * required=false,
377 * @OA\Schema(
378 * type="string"
379 * )
380 * ),
381 * @OA\Parameter(
382 * name="street",
383 * in="query",
384 * description="The street for the facility.",
385 * required=false,
386 * @OA\Schema(
387 * type="string"
388 * )
389 * ),
390 * @OA\Parameter(
391 * name="city",
392 * in="query",
393 * description="The city for the facility.",
394 * required=false,
395 * @OA\Schema(
396 * type="string"
397 * )
398 * ),
399 * @OA\Parameter(
400 * name="state",
401 * in="query",
402 * description="The state for the facility.",
403 * required=false,
404 * @OA\Schema(
405 * type="string"
406 * )
407 * ),
408 * @OA\Parameter(
409 * name="postal_code",
410 * in="query",
411 * description="The postal_code for the facility.",
412 * required=false,
413 * @OA\Schema(
414 * type="string"
415 * )
416 * ),
417 * @OA\Parameter(
418 * name="country_code",
419 * in="query",
420 * description="The country_code for the facility.",
421 * required=false,
422 * @OA\Schema(
423 * type="string"
424 * )
425 * ),
426 * @OA\Parameter(
427 * name="federal_ein",
428 * in="query",
429 * description="The federal_ein for the facility.",
430 * required=false,
431 * @OA\Schema(
432 * type="string"
433 * )
434 * ),
435 * @OA\Parameter(
436 * name="website",
437 * in="query",
438 * description="The website for the facility.",
439 * required=false,
440 * @OA\Schema(
441 * type="string"
442 * )
443 * ),
444 * @OA\Parameter(
445 * name="email",
446 * in="query",
447 * description="The email for the facility.",
448 * required=false,
449 * @OA\Schema(
450 * type="string"
451 * )
452 * ),
453 * @OA\Parameter(
454 * name="domain_identifier",
455 * in="query",
456 * description="The domain_identifier for the facility.",
457 * required=false,
458 * @OA\Schema(
459 * type="string"
460 * )
461 * ),
462 * @OA\Parameter(
463 * name="facility_taxonomy",
464 * in="query",
465 * description="The facility_taxonomy for the facility.",
466 * required=false,
467 * @OA\Schema(
468 * type="string"
469 * )
470 * ),
471 * @OA\Parameter(
472 * name="facility_code",
473 * in="query",
474 * description="The facility_code for the facility.",
475 * required=false,
476 * @OA\Schema(
477 * type="string"
478 * )
479 * ),
480 * @OA\Parameter(
481 * name="billing_location",
482 * in="query",
483 * description="The billing_location setting for the facility.",
484 * required=false,
485 * @OA\Schema(
486 * type="string"
487 * )
488 * ),
489 * @OA\Parameter(
490 * name="accepts_assignment",
491 * in="query",
492 * description="The accepts_assignment setting for the facility.",
493 * required=false,
494 * @OA\Schema(
495 * type="string"
496 * )
497 * ),
498 * @OA\Parameter(
499 * name="oid",
500 * in="query",
501 * description="The oid for the facility.",
502 * required=false,
503 * @OA\Schema(
504 * type="string"
505 * )
506 * ),
507 * @OA\Parameter(
508 * name="service_location",
509 * in="query",
510 * description="The service_location setting for the facility.",
511 * required=false,
512 * @OA\Schema(
513 * type="string"
514 * )
515 * ),
516 * @OA\Response(
517 * response="200",
518 * ref="#/components/responses/standard"
519 * ),
520 * @OA\Response(
521 * response="400",
522 * ref="#/components/responses/badrequest"
523 * ),
524 * @OA\Response(
525 * response="401",
526 * ref="#/components/responses/unauthorized"
527 * ),
528 * security={{"openemr_auth":{}}}
529 * )
530 */
531 "GET /api/facility" => function () {
532 RestConfig::authorization_check("admin", "users");
533 $return = (new FacilityRestController())->getAll($_GET);
534 RestConfig::apiLog($return);
535 return $return;
536 },
537
538 /**
539 * @OA\Get(
540 * path="/api/facility/{fuuid}",
541 * description="Returns a single facility.",
542 * tags={"standard"},
543 * @OA\Parameter(
544 * name="fuuid",
545 * in="path",
546 * description="The uuid for the facility.",
547 * required=true,
548 * @OA\Schema(
549 * type="string"
550 * )
551 * ),
552 * @OA\Response(
553 * response="200",
554 * ref="#/components/responses/standard"
555 * ),
556 * @OA\Response(
557 * response="400",
558 * ref="#/components/responses/badrequest"
559 * ),
560 * @OA\Response(
561 * response="401",
562 * ref="#/components/responses/unauthorized"
563 * ),
564 * security={{"openemr_auth":{}}}
565 * )
566 */
567 "GET /api/facility/:fuuid" => function ($fuuid) {
568 RestConfig::authorization_check("admin", "users");
569 $return = (new FacilityRestController())->getOne($fuuid);
570 RestConfig::apiLog($return);
571 return $return;
572 },
573
574 /**
575 * @OA\Post(
576 * path="/api/facility",
577 * description="Creates a facility in the system",
578 * tags={"standard"},
579 * @OA\RequestBody(
580 * required=true,
581 * @OA\MediaType(
582 * mediaType="application/json",
583 * @OA\Schema(
584 * @OA\Property(
585 * property="name",
586 * description="The name for the facility.",
587 * type="string"
588 * ),
589 * @OA\Property(
590 * property="facility_npi",
591 * description="The facility_npi for the facility.",
592 * type="string"
593 * ),
594 * @OA\Property(
595 * property="phone",
596 * description="The phone for the facility.",
597 * type="string"
598 * ),
599 * @OA\Property(
600 * property="fax",
601 * description="The fax for the facility.",
602 * type="string"
603 * ),
604 * @OA\Property(
605 * property="street",
606 * description="The street for the facility.",
607 * type="string"
608 * ),
609 * @OA\Property(
610 * property="city",
611 * description="The city for the facility.",
612 * type="string"
613 * ),
614 * @OA\Property(
615 * property="state",
616 * description="The state for the facility.",
617 * type="string"
618 * ),
619 * @OA\Property(
620 * property="postal_code",
621 * description="The postal_code for the facility.",
622 * type="string"
623 * ),
624 * @OA\Property(
625 * property="country_code",
626 * description="The country_code for the facility.",
627 * type="string"
628 * ),
629 * @OA\Property(
630 * property="federal_ein",
631 * description="The federal_ein for the facility.",
632 * type="string"
633 * ),
634 * @OA\Property(
635 * property="website",
636 * description="The website for the facility.",
637 * type="string"
638 * ),
639 * @OA\Property(
640 * property="email",
641 * description="The email for the facility.",
642 * type="string"
643 * ),
644 * @OA\Property(
645 * property="domain_identifier",
646 * description="The domain_identifier for the facility.",
647 * type="string"
648 * ),
649 * @OA\Property(
650 * property="facility_taxonomy",
651 * description="The facility_taxonomy for the facility.",
652 * type="string"
653 * ),
654 * @OA\Property(
655 * property="facility_code",
656 * description="The facility_code for the facility.",
657 * type="string"
658 * ),
659 * @OA\Property(
660 * property="billing_location",
661 * description="The billing_location setting for the facility.",
662 * type="string"
663 * ),
664 * @OA\Property(
665 * property="accepts_assignment",
666 * description="The accepts_assignment setting for the facility.",
667 * type="string"
668 * ),
669 * @OA\Property(
670 * property="oid",
671 * description="The oid for the facility.",
672 * type="string"
673 * ),
674 * @OA\Property(
675 * property="service_location",
676 * description="The service_location setting for the facility.",
677 * type="string"
678 * ),
679 * required={"name", "facility_npi"},
680 * example={
681 * "name": "Aquaria",
682 * "facility_npi": "123456789123",
683 * "phone": "808-606-3030",
684 * "fax": "808-606-3031",
685 * "street": "1337 Bit Shifter Ln",
686 * "city": "San Lorenzo",
687 * "state": "ZZ",
688 * "postal_code": "54321",
689 * "country_code": "US",
690 * "federal_ein": "4343434",
691 * "website": "https://example.com",
692 * "email": "foo@bar.com",
693 * "domain_identifier": "",
694 * "facility_taxonomy": "",
695 * "facility_code": "",
696 * "billing_location": "1",
697 * "accepts_assignment": "1",
698 * "oid": "",
699 * "service_location": "1"
700 * }
701 * )
702 * )
703 * ),
704 * @OA\Response(
705 * response="200",
706 * ref="#/components/responses/standard"
707 * ),
708 * @OA\Response(
709 * response="400",
710 * ref="#/components/responses/badrequest"
711 * ),
712 * @OA\Response(
713 * response="401",
714 * ref="#/components/responses/unauthorized"
715 * ),
716 * security={{"openemr_auth":{}}}
717 * )
718 */
719 "POST /api/facility" => function () {
720 RestConfig::authorization_check("admin", "super");
721 $data = (array) (json_decode(file_get_contents("php://input")));
722 $return = (new FacilityRestController())->post($data);
723 RestConfig::apiLog($return, $data);
724 return $return;
725 },
726
727 /**
728 * @OA\Put(
729 * path="/api/facility/{fuuid}",
730 * description="Updates a facility in the system",
731 * tags={"standard"},
732 * @OA\Parameter(
733 * name="fuuid",
734 * in="path",
735 * description="The uuid for the facility.",
736 * required=true,
737 * @OA\Schema(
738 * type="string"
739 * )
740 * ),
741 * @OA\RequestBody(
742 * required=true,
743 * @OA\MediaType(
744 * mediaType="application/json",
745 * @OA\Schema(
746 * @OA\Property(
747 * property="name",
748 * description="The name for the facility.",
749 * type="string"
750 * ),
751 * @OA\Property(
752 * property="facility_npi",
753 * description="The facility_npi for the facility.",
754 * type="string"
755 * ),
756 * @OA\Property(
757 * property="phone",
758 * description="The phone for the facility.",
759 * type="string"
760 * ),
761 * @OA\Property(
762 * property="fax",
763 * description="The fax for the facility.",
764 * type="string"
765 * ),
766 * @OA\Property(
767 * property="street",
768 * description="The street for the facility.",
769 * type="string"
770 * ),
771 * @OA\Property(
772 * property="city",
773 * description="The city for the facility.",
774 * type="string"
775 * ),
776 * @OA\Property(
777 * property="state",
778 * description="The state for the facility.",
779 * type="string"
780 * ),
781 * @OA\Property(
782 * property="postal_code",
783 * description="The postal_code for the facility.",
784 * type="string"
785 * ),
786 * @OA\Property(
787 * property="country_code",
788 * description="The country_code for the facility.",
789 * type="string"
790 * ),
791 * @OA\Property(
792 * property="federal_ein",
793 * description="The federal_ein for the facility.",
794 * type="string"
795 * ),
796 * @OA\Property(
797 * property="website",
798 * description="The website for the facility.",
799 * type="string"
800 * ),
801 * @OA\Property(
802 * property="email",
803 * description="The email for the facility.",
804 * type="string"
805 * ),
806 * @OA\Property(
807 * property="domain_identifier",
808 * description="The domain_identifier for the facility.",
809 * type="string"
810 * ),
811 * @OA\Property(
812 * property="facility_taxonomy",
813 * description="The facility_taxonomy for the facility.",
814 * type="string"
815 * ),
816 * @OA\Property(
817 * property="facility_code",
818 * description="The facility_code for the facility.",
819 * type="string"
820 * ),
821 * @OA\Property(
822 * property="billing_location",
823 * description="The billing_location setting for the facility.",
824 * type="string"
825 * ),
826 * @OA\Property(
827 * property="accepts_assignment",
828 * description="The accepts_assignment setting for the facility.",
829 * type="string"
830 * ),
831 * @OA\Property(
832 * property="oid",
833 * description="The oid for the facility.",
834 * type="string"
835 * ),
836 * @OA\Property(
837 * property="service_location",
838 * description="The service_location setting for the facility.",
839 * type="string"
840 * ),
841 * example={
842 * "name": "Aquaria",
843 * "facility_npi": "123456789123",
844 * "phone": "808-606-3030",
845 * "fax": "808-606-3031",
846 * "street": "1337 Bit Shifter Ln",
847 * "city": "San Lorenzo",
848 * "state": "ZZ",
849 * "postal_code": "54321",
850 * "country_code": "US",
851 * "federal_ein": "4343434",
852 * "website": "https://example.com",
853 * "email": "foo@bar.com",
854 * "domain_identifier": "",
855 * "facility_taxonomy": "",
856 * "facility_code": "",
857 * "billing_location": "1",
858 * "accepts_assignment": "1",
859 * "oid": "",
860 * "service_location": "1"
861 * }
862 * )
863 * )
864 * ),
865 * @OA\Response(
866 * response="200",
867 * ref="#/components/responses/standard"
868 * ),
869 * @OA\Response(
870 * response="400",
871 * ref="#/components/responses/badrequest"
872 * ),
873 * @OA\Response(
874 * response="401",
875 * ref="#/components/responses/unauthorized"
876 * ),
877 * security={{"openemr_auth":{}}}
878 * )
879 */
880 "PUT /api/facility/:fuuid" => function ($fuuid) {
881 RestConfig::authorization_check("admin", "super");
882 $data = (array) (json_decode(file_get_contents("php://input")));
883 $return = (new FacilityRestController())->patch($fuuid, $data);
884 RestConfig::apiLog($return, $data);
885 return $return;
886 },
887
888 /**
889 * @OA\Get(
890 * path="/api/patient",
891 * description="Retrieves a list of patients",
892 * tags={"standard"},
893 * @OA\Parameter(
894 * ref="#/components/parameters/_sort"
895 * ),
896 * @OA\Parameter(
897 * name="fname",
898 * in="query",
899 * description="The first name for the patient.",
900 * required=false,
901 * @OA\Schema(
902 * type="string"
903 * )
904 * ),
905 * @OA\Parameter(
906 * name="lname",
907 * in="query",
908 * description="The last name for the patient.",
909 * required=false,
910 * @OA\Schema(
911 * type="string"
912 * )
913 * ),
914 * @OA\Parameter(
915 * name="ss",
916 * in="query",
917 * description="The social security number for the patient.",
918 * required=false,
919 * @OA\Schema(
920 * type="string"
921 * )
922 * ),
923 * @OA\Parameter(
924 * name="street",
925 * in="query",
926 * description="The street for the patient.",
927 * required=false,
928 * @OA\Schema(
929 * type="string"
930 * )
931 * ),
932 * @OA\Parameter(
933 * name="postal_code",
934 * in="query",
935 * description="The postal code for the patient.",
936 * required=false,
937 * @OA\Schema(
938 * type="string"
939 * )
940 * ),
941 * @OA\Parameter(
942 * name="city",
943 * in="query",
944 * description="The city for the patient.",
945 * required=false,
946 * @OA\Schema(
947 * type="string"
948 * )
949 * ),
950 * @OA\Parameter(
951 * name="state",
952 * in="query",
953 * description="The state for the patient.",
954 * required=false,
955 * @OA\Schema(
956 * type="string"
957 * )
958 * ),
959 * @OA\Parameter(
960 * name="phone_home",
961 * in="query",
962 * description="The home phone for the patient.",
963 * required=false,
964 * @OA\Schema(
965 * type="string"
966 * )
967 * ),
968 * @OA\Parameter(
969 * name="phone_biz",
970 * in="query",
971 * description="The business phone for the patient.",
972 * required=false,
973 * @OA\Schema(
974 * type="string"
975 * )
976 * ),
977 * @OA\Parameter(
978 * name="phone_cell",
979 * in="query",
980 * description="The cell phone for the patient.",
981 * required=false,
982 * @OA\Schema(
983 * type="string"
984 * )
985 * ),
986 * @OA\Parameter(
987 * name="postal_contact",
988 * in="query",
989 * description="The postal_contact for the patient.",
990 * required=false,
991 * @OA\Schema(
992 * type="string"
993 * )
994 * ),
995 * @OA\Parameter(
996 * name="sex",
997 * in="query",
998 * description="The gender for the patient.",
999 * required=false,
1000 * @OA\Schema(
1001 * type="string"
1002 * )
1003 * ),
1004 * @OA\Parameter(
1005 * name="country_code",
1006 * in="query",
1007 * description="The country code for the patient.",
1008 * required=false,
1009 * @OA\Schema(
1010 * type="string"
1011 * )
1012 * ),
1013 * @OA\Parameter(
1014 * name="email",
1015 * in="query",
1016 * description="The email for the patient.",
1017 * required=false,
1018 * @OA\Schema(
1019 * type="string"
1020 * )
1021 * ),
1022 * @OA\Parameter(
1023 * name="DOB",
1024 * in="query",
1025 * description="The DOB for the patient.",
1026 * required=false,
1027 * @OA\Schema(
1028 * type="string"
1029 * )
1030 * ),
1031 * @OA\Parameter(
1032 * name="date",
1033 * in="query",
1034 * description="The date this patient resource was last modified.",
1035 * required=false,
1036 * @OA\Schema(
1037 * type="string"
1038 * )
1039 * ),
1040 * @OA\Parameter(
1041 * name="_offset",
1042 * in="query",
1043 * description="The number of records to offset from this index in the search result.",
1044 * required=false,
1045 * @OA\Schema(
1046 * type="integer"
1047 * )
1048 * ),
1049 * @OA\Parameter(
1050 * name="_limit",
1051 * in="query",
1052 * description="The maximum number of resources to return in the result set. 0 means unlimited.",
1053 * required=false,
1054 * @OA\Schema(
1055 * type="integer"
1056 * ,minimum=0
1057 * ,maximum=200
1058 * )
1059 * ),
1060 * @OA\Response(
1061 * response="200",
1062 * ref="#/components/responses/standard"
1063 * ),
1064 * @OA\Response(
1065 * response="400",
1066 * ref="#/components/responses/badrequest"
1067 * ),
1068 * @OA\Response(
1069 * response="401",
1070 * ref="#/components/responses/unauthorized"
1071 * ),
1072 * security={{"openemr_auth":{}}}
1073 * )
1074 */
1075 "GET /api/patient" => function () {
1076 RestConfig::authorization_check("patients", "demo");
1077 $config = SearchQueryConfig::createConfigFromQueryParams($_GET);
1078 $return = (new PatientRestController())->getAll($_GET, $config);
1079 RestConfig::apiLog($return);
1080 return $return;
1081 },
1082
1083 /**
1084 * Schema for the patient request
1085 *
1086 * @OA\Schema(
1087 * schema="api_patient_request",
1088 * @OA\Property(
1089 * property="title",
1090 * description="The title of patient.",
1091 * type="string"
1092 * ),
1093 * @OA\Property(
1094 * property="fname",
1095 * description="The fname of patient.",
1096 * type="string"
1097 * ),
1098 * @OA\Property(
1099 * property="mname",
1100 * description="The mname of patient.",
1101 * type="string"
1102 * ),
1103 * @OA\Property(
1104 * property="lname",
1105 * description="The lname of patient.",
1106 * type="string"
1107 * ),
1108 * @OA\Property(
1109 * property="street",
1110 * description="The street address of patient.",
1111 * type="string"
1112 * ),
1113 * @OA\Property(
1114 * property="postal_code",
1115 * description="The postal code of patient.",
1116 * type="string"
1117 * ),
1118 * @OA\Property(
1119 * property="city",
1120 * description="The city of patient.",
1121 * type="string"
1122 * ),
1123 * @OA\Property(
1124 * property="state",
1125 * description="The state of patient.",
1126 * type="string"
1127 * ),
1128 * @OA\Property(
1129 * property="country_code",
1130 * description="The country code of patient.",
1131 * type="string"
1132 * ),
1133 * @OA\Property(
1134 * property="phone_contact",
1135 * description="The phone contact of patient.",
1136 * type="string"
1137 * ),
1138 * @OA\Property(
1139 * property="DOB",
1140 * description="The DOB of patient.",
1141 * type="string"
1142 * ),
1143 * @OA\Property(
1144 * property="sex",
1145 * description="The lname of patient.",
1146 * type="string"
1147 * ),
1148 * @OA\Property(
1149 * property="race",
1150 * description="The race of patient.",
1151 * type="string"
1152 * ),
1153 * @OA\Property(
1154 * property="ethnicity",
1155 * description="The ethnicity of patient.",
1156 * type="string"
1157 * ),
1158 * required={"fname", "lname", "DOB", "sex"},
1159 * example={
1160 * "title": "Mr",
1161 * "fname": "Foo",
1162 * "mname": "",
1163 * "lname": "Bar",
1164 * "street": "456 Tree Lane",
1165 * "postal_code": "08642",
1166 * "city": "FooTown",
1167 * "state": "FL",
1168 * "country_code": "US",
1169 * "phone_contact": "123-456-7890",
1170 * "DOB": "1992-02-02",
1171 * "sex": "Male",
1172 * "race": "",
1173 * "ethnicity": ""
1174 * }
1175 * )
1176 */
1177 /**
1178 * @OA\Post(
1179 * path="/api/patient",
1180 * description="Creates a new patient",
1181 * tags={"standard"},
1182 * @OA\RequestBody(
1183 * required=true,
1184 * @OA\MediaType(
1185 * mediaType="application/json",
1186 * @OA\Schema(ref="#/components/schemas/api_patient_request")
1187 * )
1188 * ),
1189 * @OA\Response(
1190 * response="200",
1191 * description="Standard response",
1192 * @OA\MediaType(
1193 * mediaType="application/json",
1194 * @OA\Schema(
1195 * @OA\Property(
1196 * property="validationErrors",
1197 * description="Validation errors.",
1198 * type="array",
1199 * @OA\Items(
1200 * type="object",
1201 * ),
1202 * ),
1203 * @OA\Property(
1204 * property="internalErrors",
1205 * description="Internal errors.",
1206 * type="array",
1207 * @OA\Items(
1208 * type="object",
1209 * ),
1210 * ),
1211 * @OA\Property(
1212 * property="data",
1213 * description="Returned data.",
1214 * type="array",
1215 * @OA\Items(
1216 * @OA\Property(
1217 * property="pid",
1218 * description="patient pid",
1219 * type="integer",
1220 * )
1221 * ),
1222 * ),
1223 * example={
1224 * "validationErrors": {},
1225 * "error_description": {},
1226 * "data": {
1227 * "pid": 1
1228 * }
1229 * }
1230 * )
1231 * )
1232 * ),
1233 * @OA\Response(
1234 * response="401",
1235 * ref="#/components/responses/unauthorized"
1236 * ),
1237 * security={{"openemr_auth":{}}}
1238 * )
1239 */
1240 "POST /api/patient" => function () {
1241 RestConfig::authorization_check("patients", "demo");
1242 $data = (array) (json_decode(file_get_contents("php://input")));
1243 $return = (new PatientRestController())->post($data);
1244 RestConfig::apiLog($return, $data);
1245 return $return;
1246 },
1247
1248 /**
1249 * Schema for the patient response
1250 *
1251 * @OA\Schema(
1252 * schema="api_patient_response",
1253 * @OA\Property(
1254 * property="validationErrors",
1255 * description="Validation errors.",
1256 * type="array",
1257 * @OA\Items(
1258 * type="object",
1259 * ),
1260 * ),
1261 * @OA\Property(
1262 * property="internalErrors",
1263 * description="Internal errors.",
1264 * type="array",
1265 * @OA\Items(
1266 * type="object",
1267 * ),
1268 * ),
1269 * @OA\Property(
1270 * property="data",
1271 * description="Returned data.",
1272 * type="array",
1273 * @OA\Items(
1274 * @OA\Property(
1275 * property="id",
1276 * description="patient id",
1277 * type="string",
1278 * ),
1279 * @OA\Property(
1280 * property="pid",
1281 * description="patient pid",
1282 * type="string",
1283 * ),
1284 * @OA\Property(
1285 * property="pubpid",
1286 * description="patient public id",
1287 * type="string",
1288 * ),
1289 * @OA\Property(
1290 * property="title",
1291 * description="patient title",
1292 * type="string",
1293 * ),
1294 * @OA\Property(
1295 * property="fname",
1296 * description="patient first name",
1297 * type="string",
1298 * ),
1299 * @OA\Property(
1300 * property="mname",
1301 * description="patient middle name",
1302 * type="string",
1303 * ),
1304 * @OA\Property(
1305 * property="lname",
1306 * description="patient last name",
1307 * type="string",
1308 * ),
1309 * @OA\Property(
1310 * property="ss",
1311 * description="patient social security number",
1312 * type="string",
1313 * ),
1314 * @OA\Property(
1315 * property="street",
1316 * description="patient street address",
1317 * type="string",
1318 * ),
1319 * @OA\Property(
1320 * property="postal_code",
1321 * description="patient postal code",
1322 * type="string",
1323 * ),
1324 * @OA\Property(
1325 * property="city",
1326 * description="patient city",
1327 * type="string",
1328 * ),
1329 * @OA\Property(
1330 * property="state",
1331 * description="patient state",
1332 * type="string",
1333 * ),
1334 * @OA\Property(
1335 * property="county",
1336 * description="patient county",
1337 * type="string",
1338 * ),
1339 * @OA\Property(
1340 * property="country_code",
1341 * description="patient country code",
1342 * type="string",
1343 * ),
1344 * @OA\Property(
1345 * property="drivers_license",
1346 * description="patient drivers license id",
1347 * type="string",
1348 * ),
1349 * @OA\Property(
1350 * property="contact_relationship",
1351 * description="patient contact relationship",
1352 * type="string",
1353 * ),
1354 * @OA\Property(
1355 * property="phone_contact",
1356 * description="patient phone contact",
1357 * type="string",
1358 * ),
1359 * @OA\Property(
1360 * property="phone_home",
1361 * description="patient home phone",
1362 * type="string",
1363 * ),
1364 * @OA\Property(
1365 * property="phone_biz",
1366 * description="patient work phone",
1367 * type="string",
1368 * ),
1369 * @OA\Property(
1370 * property="phone_cell",
1371 * description="patient mobile phone",
1372 * type="string",
1373 * ),
1374 * @OA\Property(
1375 * property="email",
1376 * description="patient email",
1377 * type="string",
1378 * ),
1379 * @OA\Property(
1380 * property="DOB",
1381 * description="patient DOB",
1382 * type="string",
1383 * ),
1384 * @OA\Property(
1385 * property="sex",
1386 * description="patient sex (gender)",
1387 * type="string",
1388 * ),
1389 * @OA\Property(
1390 * property="race",
1391 * description="patient race",
1392 * type="string",
1393 * ),
1394 * @OA\Property(
1395 * property="ethnicity",
1396 * description="patient ethnicity",
1397 * type="string",
1398 * ),
1399 * @OA\Property(
1400 * property="status",
1401 * description="patient status",
1402 * type="string",
1403 * ),
1404 * ),
1405 * ),
1406 * example={
1407 * "validationErrors": {},
1408 * "error_description": {},
1409 * "data": {
1410 * "id": "193",
1411 * "pid": "1",
1412 * "pubpid": "",
1413 * "title": "Mr",
1414 * "fname": "Baz",
1415 * "mname": "",
1416 * "lname": "Bop",
1417 * "ss": "",
1418 * "street": "456 Tree Lane",
1419 * "postal_code": "08642",
1420 * "city": "FooTown",
1421 * "state": "FL",
1422 * "county": "",
1423 * "country_code": "US",
1424 * "drivers_license": "",
1425 * "contact_relationship": "",
1426 * "phone_contact": "123-456-7890",
1427 * "phone_home": "",
1428 * "phone_biz": "",
1429 * "phone_cell": "",
1430 * "email": "",
1431 * "DOB": "1992-02-03",
1432 * "sex": "Male",
1433 * "race": "",
1434 * "ethnicity": "",
1435 * "status": ""
1436 * }
1437 * }
1438 * )
1439 */
1440 /**
1441 * @OA\Put(
1442 * path="/api/patient/{puuid}",
1443 * description="Updates a patient",
1444 * tags={"standard"},
1445 * @OA\Parameter(
1446 * name="puuid",
1447 * in="path",
1448 * description="The uuid for the patient.",
1449 * required=true,
1450 * @OA\Schema(
1451 * type="string"
1452 * )
1453 * ),
1454 * @OA\RequestBody(
1455 * required=true,
1456 * @OA\MediaType(
1457 * mediaType="application/json",
1458 * @OA\Schema(ref="#/components/schemas/api_patient_request")
1459 * )
1460 * ),
1461 * @OA\Response(
1462 * response="200",
1463 * description="Standard response",
1464 * @OA\MediaType(
1465 * mediaType="application/json",
1466 * @OA\Schema(ref="#/components/schemas/api_patient_response")
1467 * )
1468 * ),
1469 * @OA\Response(
1470 * response="401",
1471 * ref="#/components/responses/unauthorized"
1472 * ),
1473 * security={{"openemr_auth":{}}}
1474 * )
1475 */
1476 "PUT /api/patient/:puuid" => function ($puuid) {
1477 RestConfig::authorization_check("patients", "demo");
1478 $data = (array) (json_decode(file_get_contents("php://input")));
1479 $return = (new PatientRestController())->put($puuid, $data);
1480 RestConfig::apiLog($return, $data);
1481 return $return;
1482 },
1483
1484 /**
1485 * @OA\Get(
1486 * path="/api/patient/{puuid}",
1487 * description="Retrieves a single patient by their uuid",
1488 * tags={"standard"},
1489 * @OA\Parameter(
1490 * name="puuid",
1491 * in="path",
1492 * description="The uuid for the patient.",
1493 * required=true,
1494 * @OA\Schema(
1495 * type="string"
1496 * )
1497 * ),
1498 * @OA\Response(
1499 * response="200",
1500 * description="Standard response",
1501 * @OA\MediaType(
1502 * mediaType="application/json",
1503 * @OA\Schema(ref="#/components/schemas/api_patient_response")
1504 * )
1505 * ),
1506 * @OA\Response(
1507 * response="401",
1508 * ref="#/components/responses/unauthorized"
1509 * ),
1510 * security={{"openemr_auth":{}}}
1511 * )
1512 */
1513 "GET /api/patient/:puuid" => function ($puuid) {
1514 RestConfig::authorization_check("patients", "demo");
1515 $return = (new PatientRestController())->getOne($puuid);
1516 RestConfig::apiLog($return);
1517 return $return;
1518 },
1519
1520 /**
1521 * @OA\Get(
1522 * path="/api/patient/{puuid}/encounter",
1523 * description="Retrieves a list of encounters for a single patient",
1524 * tags={"standard"},
1525 * @OA\Parameter(
1526 * name="puuid",
1527 * in="path",
1528 * description="The uuid for the patient.",
1529 * required=true,
1530 * @OA\Schema(
1531 * type="string"
1532 * )
1533 * ),
1534 * @OA\Response(
1535 * response="200",
1536 * ref="#/components/responses/standard"
1537 * ),
1538 * @OA\Response(
1539 * response="400",
1540 * ref="#/components/responses/badrequest"
1541 * ),
1542 * @OA\Response(
1543 * response="401",
1544 * ref="#/components/responses/unauthorized"
1545 * ),
1546 * security={{"openemr_auth":{}}}
1547 * )
1548 */
1549 "GET /api/patient/:puuid/encounter" => function ($puuid) {
1550 RestConfig::authorization_check("encounters", "auth_a");
1551 $return = (new EncounterRestController())->getAll($puuid);
1552 RestConfig::apiLog($return);
1553 return $return;
1554 },
1555
1556 /**
1557 * Schema for the encounter request
1558 *
1559 * @OA\Schema(
1560 * schema="api_encounter_request",
1561 * @OA\Property(
1562 * property="date",
1563 * description="The date of encounter.",
1564 * type="string"
1565 * ),
1566 * @OA\Property(
1567 * property="onset_date",
1568 * description="The onset date of encounter.",
1569 * type="string"
1570 * ),
1571 * @OA\Property(
1572 * property="reason",
1573 * description="The reason of encounter.",
1574 * type="string"
1575 * ),
1576 * @OA\Property(
1577 * property="facility",
1578 * description="The facility of encounter.",
1579 * type="string"
1580 * ),
1581 * @OA\Property(
1582 * property="pc_catid",
1583 * description="The pc_catid of encounter.",
1584 * type="string"
1585 * ),
1586 * @OA\Property(
1587 * property="facility_id",
1588 * description="The facility id of encounter.",
1589 * type="string"
1590 * ),
1591 * @OA\Property(
1592 * property="billing_facility",
1593 * description="The billing facility id of encounter.",
1594 * type="string"
1595 * ),
1596 * @OA\Property(
1597 * property="sensitivity",
1598 * description="The sensitivity of encounter.",
1599 * type="string"
1600 * ),
1601 * @OA\Property(
1602 * property="referral_source",
1603 * description="The referral source of encounter.",
1604 * type="string"
1605 * ),
1606 * @OA\Property(
1607 * property="pos_code",
1608 * description="The pos_code of encounter.",
1609 * type="string"
1610 * ),
1611 * @OA\Property(
1612 * property="external_id",
1613 * description="The external id of encounter.",
1614 * type="string"
1615 * ),
1616 * @OA\Property(
1617 * property="provider_id",
1618 * description="The provider id of encounter.",
1619 * type="string"
1620 * ),
1621 * @OA\Property(
1622 * property="class_code",
1623 * description="The class_code of encounter.",
1624 * type="string"
1625 * ),
1626 * required={"pc_catid", "class_code"},
1627 * example={
1628 * "date":"2020-11-10",
1629 * "onset_date": "",
1630 * "reason": "Pregnancy Test",
1631 * "facility": "Owerri General Hospital",
1632 * "pc_catid": "5",
1633 * "facility_id": "3",
1634 * "billing_facility": "3",
1635 * "sensitivity": "normal",
1636 * "referral_source": "",
1637 * "pos_code": "0",
1638 * "external_id": "",
1639 * "provider_id": "1",
1640 * "class_code" : "AMB"
1641 * }
1642 * )
1643 */
1644 /**
1645 * @OA\Post(
1646 * path="/api/patient/{puuid}/encounter",
1647 * description="Creates a new encounter",
1648 * tags={"standard"},
1649 * @OA\Parameter(
1650 * name="puuid",
1651 * in="path",
1652 * description="The uuid for the patient.",
1653 * required=true,
1654 * @OA\Schema(
1655 * type="string"
1656 * )
1657 * ),
1658 * @OA\RequestBody(
1659 * required=true,
1660 * @OA\MediaType(
1661 * mediaType="application/json",
1662 * @OA\Schema(ref="#/components/schemas/api_encounter_request")
1663 * )
1664 * ),
1665 * @OA\Response(
1666 * response="200",
1667 * description="Standard response",
1668 * @OA\MediaType(
1669 * mediaType="application/json",
1670 * @OA\Schema(
1671 * @OA\Property(
1672 * property="validationErrors",
1673 * description="Validation errors.",
1674 * type="array",
1675 * @OA\Items(
1676 * type="object",
1677 * ),
1678 * ),
1679 * @OA\Property(
1680 * property="internalErrors",
1681 * description="Internal errors.",
1682 * type="array",
1683 * @OA\Items(
1684 * type="object",
1685 * ),
1686 * ),
1687 * @OA\Property(
1688 * property="data",
1689 * description="Returned data.",
1690 * type="array",
1691 * @OA\Items(
1692 * @OA\Property(
1693 * property="encounter",
1694 * description="encounter id",
1695 * type="integer",
1696 * ),
1697 * @OA\Property(
1698 * property="uuid",
1699 * description="encounter uuid",
1700 * type="string",
1701 * )
1702 * ),
1703 * ),
1704 * example={
1705 * "validationErrors": {},
1706 * "error_description": {},
1707 * "data": {
1708 * "encounter": 1,
1709 * "uuid": "90c196f2-51cc-4655-8858-3a80aebff3ef"
1710 * }
1711 * }
1712 * )
1713 * )
1714 * ),
1715 * @OA\Response(
1716 * response="401",
1717 * ref="#/components/responses/unauthorized"
1718 * ),
1719 * security={{"openemr_auth":{}}}
1720 * )
1721 */
1722 "POST /api/patient/:puuid/encounter" => function ($puuid) {
1723 RestConfig::authorization_check("encounters", "auth_a");
1724 $data = (array) (json_decode(file_get_contents("php://input")));
1725 $return = (new EncounterRestController())->post($puuid, $data);
1726 RestConfig::apiLog($return, $data);
1727 return $return;
1728 },
1729
1730 /**
1731 * Schema for the encounter response
1732 *
1733 * @OA\Schema(
1734 * schema="api_encounter_response",
1735 * @OA\Property(
1736 * property="validationErrors",
1737 * description="Validation errors.",
1738 * type="array",
1739 * @OA\Items(
1740 * type="object",
1741 * ),
1742 * ),
1743 * @OA\Property(
1744 * property="internalErrors",
1745 * description="Internal errors.",
1746 * type="array",
1747 * @OA\Items(
1748 * type="object",
1749 * ),
1750 * ),
1751 * @OA\Property(
1752 * property="data",
1753 * description="Returned data.",
1754 * type="array",
1755 * @OA\Items(
1756 * @OA\Property(
1757 * property="id",
1758 * description="encounter id",
1759 * type="string",
1760 * ),
1761 * @OA\Property(
1762 * property="uuid",
1763 * description="encounter uuid",
1764 * type="string",
1765 * ),
1766 * @OA\Property(
1767 * property="date",
1768 * description="encounter date",
1769 * type="string",
1770 * ),
1771 * @OA\Property(
1772 * property="reason",
1773 * description="encounter reason",
1774 * type="string",
1775 * ),
1776 * @OA\Property(
1777 * property="facility",
1778 * description="encounter facility name",
1779 * type="string",
1780 * ),
1781 * @OA\Property(
1782 * property="facility_id",
1783 * description="encounter facility id name",
1784 * type="string",
1785 * ),
1786 * @OA\Property(
1787 * property="pid",
1788 * description="encounter for patient pid",
1789 * type="string",
1790 * ),
1791 * @OA\Property(
1792 * property="onset_date",
1793 * description="encounter onset date",
1794 * type="string",
1795 * ),
1796 * @OA\Property(
1797 * property="sensitivity",
1798 * description="encounter sensitivity",
1799 * type="string",
1800 * ),
1801 * @OA\Property(
1802 * property="billing_note",
1803 * description="encounter billing note",
1804 * type="string",
1805 * ),
1806 * @OA\Property(
1807 * property="pc_catid",
1808 * description="encounter pc_catid",
1809 * type="string",
1810 * ),
1811 * @OA\Property(
1812 * property="last_level_billed",
1813 * description="encounter last_level_billed",
1814 * type="string",
1815 * ),
1816 * @OA\Property(
1817 * property="last_level_closed",
1818 * description="encounter last_level_closed",
1819 * type="string",
1820 * ),
1821 * @OA\Property(
1822 * property="last_stmt_date",
1823 * description="encounter last_stmt_date",
1824 * type="string",
1825 * ),
1826 * @OA\Property(
1827 * property="stmt_count",
1828 * description="encounter stmt_count",
1829 * type="string",
1830 * ),
1831 * @OA\Property(
1832 * property="provider_id",
1833 * description="provider id",
1834 * type="string",
1835 * ),
1836 * @OA\Property(
1837 * property="supervisor_id",
1838 * description="encounter supervisor id",
1839 * type="string",
1840 * ),
1841 * @OA\Property(
1842 * property="invoice_refno",
1843 * description="encounter invoice_refno",
1844 * type="string",
1845 * ),
1846 * @OA\Property(
1847 * property="referral_source",
1848 * description="encounter referral source",
1849 * type="string",
1850 * ),
1851 * @OA\Property(
1852 * property="billing_facility",
1853 * description="encounter billing facility id",
1854 * type="string",
1855 * ),
1856 * @OA\Property(
1857 * property="external_id",
1858 * description="encounter external id",
1859 * type="string",
1860 * ),
1861 * @OA\Property(
1862 * property="pos_code",
1863 * description="encounter pos_code",
1864 * type="string",
1865 * ),
1866 * @OA\Property(
1867 * property="class_code",
1868 * description="encounter class_code",
1869 * type="string",
1870 * ),
1871 * @OA\Property(
1872 * property="class_title",
1873 * description="encounter class_title",
1874 * type="string",
1875 * ),
1876 * @OA\Property(
1877 * property="pc_catname",
1878 * description="encounter pc_catname",
1879 * type="string",
1880 * ),
1881 * @OA\Property(
1882 * property="billing_facility_name",
1883 * description="encounter billing facility name",
1884 * type="string",
1885 * ),
1886 * ),
1887 * ),
1888 * example={
1889 * "validationErrors": {},
1890 * "error_description": {},
1891 * "data": {
1892 * "id": "1",
1893 * "uuid": "90c196f2-51cc-4655-8858-3a80aebff3ef",
1894 * "date": "2019-09-14 00:00:00",
1895 * "reason": "Pregnancy Test",
1896 * "facility": "Owerri General Hospital",
1897 * "facility_id": "3",
1898 * "pid": "1",
1899 * "onset_date": "2019-04-20 00:00:00",
1900 * "sensitivity": "normal",
1901 * "billing_note": null,
1902 * "pc_catid": "5",
1903 * "last_level_billed": "0",
1904 * "last_level_closed": "0",
1905 * "last_stmt_date": null,
1906 * "stmt_count": "0",
1907 * "provider_id": "1",
1908 * "supervisor_id": "0",
1909 * "invoice_refno": "",
1910 * "referral_source": "",
1911 * "billing_facility": "3",
1912 * "external_id": "",
1913 * "pos_code": "0",
1914 * "class_code": "AMB",
1915 * "class_title": "ambulatory",
1916 * "pc_catname": "Office Visit",
1917 * "billing_facility_name": "Owerri General Hospital"
1918 * }
1919 * }
1920 * )
1921 */
1922 /**
1923 * @OA\Put(
1924 * path="/api/patient/{puuid}/encounter/{euuid}",
1925 * description="Modify a encounter",
1926 * tags={"standard"},
1927 * @OA\Parameter(
1928 * name="puuid",
1929 * in="path",
1930 * description="The uuid for the patient.",
1931 * required=true,
1932 * @OA\Schema(
1933 * type="string"
1934 * )
1935 * ),
1936 * @OA\Parameter(
1937 * name="euuid",
1938 * in="path",
1939 * description="The uuid for the encounter.",
1940 * required=true,
1941 * @OA\Schema(
1942 * type="string"
1943 * )
1944 * ),
1945 * @OA\RequestBody(
1946 * required=true,
1947 * @OA\MediaType(
1948 * mediaType="application/json",
1949 * @OA\Schema(ref="#/components/schemas/api_encounter_request")
1950 * )
1951 * ),
1952 * @OA\Response(
1953 * response="200",
1954 * description="Standard response",
1955 * @OA\MediaType(
1956 * mediaType="application/json",
1957 * @OA\Schema(ref="#/components/schemas/api_encounter_response")
1958 * )
1959 * ),
1960 * @OA\Response(
1961 * response="401",
1962 * ref="#/components/responses/unauthorized"
1963 * ),
1964 * security={{"openemr_auth":{}}}
1965 * )
1966 */
1967 "PUT /api/patient/:puuid/encounter/:euuid" => function ($puuid, $euuid) {
1968 RestConfig::authorization_check("encounters", "auth_a");
1969 $data = (array) (json_decode(file_get_contents("php://input")));
1970 $return = (new EncounterRestController())->put($puuid, $euuid, $data);
1971 RestConfig::apiLog($return, $data);
1972 return $return;
1973 },
1974
1975 /**
1976 * @OA\Get(
1977 * path="/api/patient/{puuid}/encounter/{euuid}",
1978 * description="Retrieves a single encounter for a patient",
1979 * tags={"standard"},
1980 * @OA\Parameter(
1981 * name="puuid",
1982 * in="path",
1983 * description="The uuid for the patient.",
1984 * required=true,
1985 * @OA\Schema(
1986 * type="string"
1987 * )
1988 * ),
1989 * @OA\Parameter(
1990 * name="euuid",
1991 * in="path",
1992 * description="The uuid for the encounter.",
1993 * required=true,
1994 * @OA\Schema(
1995 * type="string"
1996 * )
1997 * ),
1998 * @OA\Response(
1999 * response="200",
2000 * description="Standard response",
2001 * @OA\MediaType(
2002 * mediaType="application/json",
2003 * @OA\Schema(ref="#/components/schemas/api_encounter_response")
2004 * )
2005 * ),
2006 * @OA\Response(
2007 * response="401",
2008 * ref="#/components/responses/unauthorized"
2009 * ),
2010 * security={{"openemr_auth":{}}}
2011 * )
2012 */
2013 "GET /api/patient/:puuid/encounter/:euuid" => function ($puuid, $euuid) {
2014 RestConfig::authorization_check("encounters", "auth_a");
2015 $return = (new EncounterRestController())->getOne($puuid, $euuid);
2016 RestConfig::apiLog($return);
2017 return $return;
2018 },
2019
2020 /**
2021 * @OA\Get(
2022 * path="/api/patient/{pid}/encounter/{eid}/soap_note",
2023 * description="Retrieves soap notes from an encounter for a patient",
2024 * tags={"standard"},
2025 * @OA\Parameter(
2026 * name="pid",
2027 * in="path",
2028 * description="The pid for the patient.",
2029 * required=true,
2030 * @OA\Schema(
2031 * type="string"
2032 * )
2033 * ),
2034 * @OA\Parameter(
2035 * name="eid",
2036 * in="path",
2037 * description="The id for the encounter.",
2038 * required=true,
2039 * @OA\Schema(
2040 * type="string"
2041 * )
2042 * ),
2043 * @OA\Response(
2044 * response="200",
2045 * ref="#/components/responses/standard"
2046 * ),
2047 * @OA\Response(
2048 * response="400",
2049 * ref="#/components/responses/badrequest"
2050 * ),
2051 * @OA\Response(
2052 * response="401",
2053 * ref="#/components/responses/unauthorized"
2054 * ),
2055 * security={{"openemr_auth":{}}}
2056 * )
2057 */
2058 "GET /api/patient/:pid/encounter/:eid/soap_note" => function ($pid, $eid) {
2059 RestConfig::authorization_check("encounters", "notes");
2060 $return = (new EncounterRestController())->getSoapNotes($pid, $eid);
2061 RestConfig::apiLog($return);
2062 return $return;
2063 },
2064
2065 /**
2066 * Schema for the vital request
2067 *
2068 * @OA\Schema(
2069 * schema="api_vital_request",
2070 * @OA\Property(
2071 * property="bps",
2072 * description="The bps of vitals.",
2073 * type="string"
2074 * ),
2075 * @OA\Property(
2076 * property="bpd",
2077 * description="The bpd of vitals.",
2078 * type="string"
2079 * ),
2080 * @OA\Property(
2081 * property="weight",
2082 * description="The weight of vitals. (unit is lb)",
2083 * type="string"
2084 * ),
2085 * @OA\Property(
2086 * property="height",
2087 * description="The height of vitals. (unit is inches)",
2088 * type="string"
2089 * ),
2090 * @OA\Property(
2091 * property="temperature",
2092 * description="The temperature of temperature. (unit is F)",
2093 * type="string"
2094 * ),
2095 * @OA\Property(
2096 * property="temp_method",
2097 * description="The temp_method of vitals.",
2098 * type="string"
2099 * ),
2100 * @OA\Property(
2101 * property="pulse",
2102 * description="The pulse of vitals.",
2103 * type="string"
2104 * ),
2105 * @OA\Property(
2106 * property="respiration",
2107 * description="The respiration of vitals.",
2108 * type="string"
2109 * ),
2110 * @OA\Property(
2111 * property="note",
2112 * description="The note (ie. comments) of vitals.",
2113 * type="string"
2114 * ),
2115 * @OA\Property(
2116 * property="waist_circ",
2117 * description="The waist circumference of vitals. (unit is inches)",
2118 * type="string"
2119 * ),
2120 * @OA\Property(
2121 * property="head_circ",
2122 * description="The head circumference of vitals. (unit is inches)",
2123 * type="string"
2124 * ),
2125 * @OA\Property(
2126 * property="oxygen_saturation",
2127 * description="The oxygen_saturation of vitals.",
2128 * type="string"
2129 * ),
2130 * example={
2131 * "bps": "130",
2132 * "bpd": "80",
2133 * "weight": "220",
2134 * "height": "70",
2135 * "temperature": "98",
2136 * "temp_method": "Oral",
2137 * "pulse": "60",
2138 * "respiration": "20",
2139 * "note": "Patient with difficulty standing, which made weight measurement difficult.",
2140 * "waist_circ": "37",
2141 * "head_circ": "22.2",
2142 * "oxygen_saturation": "96"
2143 * }
2144 * )
2145 */
2146 /**
2147 * @OA\Post(
2148 * path="/api/patient/{pid}/encounter/{eid}/vital",
2149 * description="Submits a new vitals form",
2150 * tags={"standard"},
2151 * @OA\Parameter(
2152 * name="pid",
2153 * in="path",
2154 * description="The id for the patient.",
2155 * required=true,
2156 * @OA\Schema(
2157 * type="string"
2158 * )
2159 * ),
2160 * @OA\Parameter(
2161 * name="eid",
2162 * in="path",
2163 * description="The id for the encounter.",
2164 * required=true,
2165 * @OA\Schema(
2166 * type="string"
2167 * )
2168 * ),
2169 * @OA\RequestBody(
2170 * required=true,
2171 * @OA\MediaType(
2172 * mediaType="application/json",
2173 * @OA\Schema(ref="#/components/schemas/api_vital_request")
2174 * )
2175 * ),
2176 * @OA\Response(
2177 * response="200",
2178 * ref="#/components/responses/standard"
2179 * ),
2180 * @OA\Response(
2181 * response="400",
2182 * ref="#/components/responses/badrequest"
2183 * ),
2184 * @OA\Response(
2185 * response="401",
2186 * ref="#/components/responses/unauthorized"
2187 * ),
2188 * security={{"openemr_auth":{}}}
2189 * )
2190 */
2191 "POST /api/patient/:pid/encounter/:eid/vital" => function ($pid, $eid) {
2192 RestConfig::authorization_check("encounters", "notes");
2193 $data = json_decode(file_get_contents("php://input"), true) ?? [];
2194 $return = (new EncounterRestController())->postVital($pid, $eid, $data);
2195 RestConfig::apiLog($return, $data);
2196 return $return;
2197 },
2198
2199 /**
2200 * @OA\Put(
2201 * path="/api/patient/{pid}/encounter/{eid}/vital/{vid}",
2202 * description="Edit a vitals form",
2203 * tags={"standard"},
2204 * @OA\Parameter(
2205 * name="pid",
2206 * in="path",
2207 * description="The id for the patient.",
2208 * required=true,
2209 * @OA\Schema(
2210 * type="string"
2211 * )
2212 * ),
2213 * @OA\Parameter(
2214 * name="eid",
2215 * in="path",
2216 * description="The id for the encounter.",
2217 * required=true,
2218 * @OA\Schema(
2219 * type="string"
2220 * )
2221 * ),
2222 * @OA\Parameter(
2223 * name="vid",
2224 * in="path",
2225 * description="The id for the vitalss form.",
2226 * required=true,
2227 * @OA\Schema(
2228 * type="string"
2229 * )
2230 * ),
2231 * @OA\RequestBody(
2232 * required=true,
2233 * @OA\MediaType(
2234 * mediaType="application/json",
2235 * @OA\Schema(ref="#/components/schemas/api_vital_request")
2236 * )
2237 * ),
2238 * @OA\Response(
2239 * response="200",
2240 * ref="#/components/responses/standard"
2241 * ),
2242 * @OA\Response(
2243 * response="400",
2244 * ref="#/components/responses/badrequest"
2245 * ),
2246 * @OA\Response(
2247 * response="401",
2248 * ref="#/components/responses/unauthorized"
2249 * ),
2250 * security={{"openemr_auth":{}}}
2251 * )
2252 */
2253 "PUT /api/patient/:pid/encounter/:eid/vital/:vid" => function ($pid, $eid, $vid) {
2254 RestConfig::authorization_check("encounters", "notes");
2255 $data = json_decode(file_get_contents("php://input"), true) ?? [];
2256 $return = (new EncounterRestController())->putVital($pid, $eid, $vid, $data);
2257 RestConfig::apiLog($return, $data);
2258 return $return;
2259 },
2260
2261 /**
2262 * @OA\Get(
2263 * path="/api/patient/{pid}/encounter/{eid}/vital",
2264 * description="Retrieves all vitals from an encounter for a patient",
2265 * tags={"standard"},
2266 * @OA\Parameter(
2267 * name="pid",
2268 * in="path",
2269 * description="The pid for the patient.",
2270 * required=true,
2271 * @OA\Schema(
2272 * type="string"
2273 * )
2274 * ),
2275 * @OA\Parameter(
2276 * name="eid",
2277 * in="path",
2278 * description="The id for the encounter.",
2279 * required=true,
2280 * @OA\Schema(
2281 * type="string"
2282 * )
2283 * ),
2284 * @OA\Response(
2285 * response="200",
2286 * ref="#/components/responses/standard"
2287 * ),
2288 * @OA\Response(
2289 * response="400",
2290 * ref="#/components/responses/badrequest"
2291 * ),
2292 * @OA\Response(
2293 * response="401",
2294 * ref="#/components/responses/unauthorized"
2295 * ),
2296 * security={{"openemr_auth":{}}}
2297 * )
2298 */
2299 "GET /api/patient/:pid/encounter/:eid/vital" => function ($pid, $eid) {
2300 RestConfig::authorization_check("encounters", "notes");
2301 $return = (new EncounterRestController())->getVitals($pid, $eid);
2302 RestConfig::apiLog($return);
2303 return $return;
2304 },
2305
2306 /**
2307 * @OA\Get(
2308 * path="/api/patient/{pid}/encounter/{eid}/vital/{vid}",
2309 * description="Retrieves a vitals form from an encounter for a patient",
2310 * tags={"standard"},
2311 * @OA\Parameter(
2312 * name="pid",
2313 * in="path",
2314 * description="The pid for the patient.",
2315 * required=true,
2316 * @OA\Schema(
2317 * type="string"
2318 * )
2319 * ),
2320 * @OA\Parameter(
2321 * name="eid",
2322 * in="path",
2323 * description="The id for the encounter.",
2324 * required=true,
2325 * @OA\Schema(
2326 * type="string"
2327 * )
2328 * ),
2329 * @OA\Parameter(
2330 * name="vid",
2331 * in="path",
2332 * description="The id for the vitals form.",
2333 * required=true,
2334 * @OA\Schema(
2335 * type="string"
2336 * )
2337 * ),
2338 * @OA\Response(
2339 * response="200",
2340 * ref="#/components/responses/standard"
2341 * ),
2342 * @OA\Response(
2343 * response="400",
2344 * ref="#/components/responses/badrequest"
2345 * ),
2346 * @OA\Response(
2347 * response="401",
2348 * ref="#/components/responses/unauthorized"
2349 * ),
2350 * security={{"openemr_auth":{}}}
2351 * )
2352 */
2353 "GET /api/patient/:pid/encounter/:eid/vital/:vid" => function ($pid, $eid, $vid) {
2354 RestConfig::authorization_check("encounters", "notes");
2355 $return = (new EncounterRestController())->getVital($pid, $eid, $vid);
2356 RestConfig::apiLog($return);
2357 return $return;
2358 },
2359
2360 /**
2361 * @OA\Get(
2362 * path="/api/patient/{pid}/encounter/{eid}/soap_note/{sid}",
2363 * description="Retrieves a soap note from an encounter for a patient",
2364 * tags={"standard"},
2365 * @OA\Parameter(
2366 * name="pid",
2367 * in="path",
2368 * description="The pid for the patient.",
2369 * required=true,
2370 * @OA\Schema(
2371 * type="string"
2372 * )
2373 * ),
2374 * @OA\Parameter(
2375 * name="eid",
2376 * in="path",
2377 * description="The id for the encounter.",
2378 * required=true,
2379 * @OA\Schema(
2380 * type="string"
2381 * )
2382 * ),
2383 * @OA\Parameter(
2384 * name="sid",
2385 * in="path",
2386 * description="The id for the soap note.",
2387 * required=true,
2388 * @OA\Schema(
2389 * type="string"
2390 * )
2391 * ),
2392 * @OA\Response(
2393 * response="200",
2394 * ref="#/components/responses/standard"
2395 * ),
2396 * @OA\Response(
2397 * response="400",
2398 * ref="#/components/responses/badrequest"
2399 * ),
2400 * @OA\Response(
2401 * response="401",
2402 * ref="#/components/responses/unauthorized"
2403 * ),
2404 * security={{"openemr_auth":{}}}
2405 * )
2406 */
2407 "GET /api/patient/:pid/encounter/:eid/soap_note/:sid" => function ($pid, $eid, $sid) {
2408 RestConfig::authorization_check("encounters", "notes");
2409 $return = (new EncounterRestController())->getSoapNote($pid, $eid, $sid);
2410 RestConfig::apiLog($return);
2411 return $return;
2412 },
2413
2414 /**
2415 * Schema for the soap_note request
2416 *
2417 * @OA\Schema(
2418 * schema="api_soap_note_request",
2419 * @OA\Property(
2420 * property="subjective",
2421 * description="The subjective of soap note.",
2422 * type="string"
2423 * ),
2424 * @OA\Property(
2425 * property="objective",
2426 * description="The objective of soap note.",
2427 * type="string"
2428 * ),
2429 * @OA\Property(
2430 * property="assessment",
2431 * description="The assessment of soap note.",
2432 * type="string"
2433 * ),
2434 * @OA\Property(
2435 * property="plan",
2436 * description="The plan of soap note.",
2437 * type="string"
2438 * ),
2439 * example={
2440 * "subjective": "The patient with mechanical fall and cut finger.",
2441 * "objective": "The patient with finger laceration on exam.",
2442 * "assessment": "The patient with finger laceration requiring sutures.",
2443 * "plan": "Sutured finger laceration."
2444 * }
2445 * )
2446 */
2447 /**
2448 * @OA\Post(
2449 * path="/api/patient/{pid}/encounter/{eid}/soap_note",
2450 * description="Submits a new soap note",
2451 * tags={"standard"},
2452 * @OA\Parameter(
2453 * name="pid",
2454 * in="path",
2455 * description="The id for the patient.",
2456 * required=true,
2457 * @OA\Schema(
2458 * type="string"
2459 * )
2460 * ),
2461 * @OA\Parameter(
2462 * name="eid",
2463 * in="path",
2464 * description="The id for the encounter.",
2465 * required=true,
2466 * @OA\Schema(
2467 * type="string"
2468 * )
2469 * ),
2470 * @OA\RequestBody(
2471 * required=true,
2472 * @OA\MediaType(
2473 * mediaType="application/json",
2474 * @OA\Schema(ref="#/components/schemas/api_soap_note_request")
2475 * )
2476 * ),
2477 * @OA\Response(
2478 * response="200",
2479 * ref="#/components/responses/standard"
2480 * ),
2481 * @OA\Response(
2482 * response="400",
2483 * ref="#/components/responses/badrequest"
2484 * ),
2485 * @OA\Response(
2486 * response="401",
2487 * ref="#/components/responses/unauthorized"
2488 * ),
2489 * security={{"openemr_auth":{}}}
2490 * )
2491 */
2492 "POST /api/patient/:pid/encounter/:eid/soap_note" => function ($pid, $eid) {
2493 RestConfig::authorization_check("encounters", "notes");
2494 $data = (array) (json_decode(file_get_contents("php://input")));
2495 $return = (new EncounterRestController())->postSoapNote($pid, $eid, $data);
2496 RestConfig::apiLog($return, $data);
2497 return $return;
2498 },
2499
2500 /**
2501 * @OA\Put(
2502 * path="/api/patient/{pid}/encounter/{eid}/soap_note/{sid}",
2503 * description="Edit a soap note",
2504 * tags={"standard"},
2505 * @OA\Parameter(
2506 * name="pid",
2507 * in="path",
2508 * description="The id for the patient.",
2509 * required=true,
2510 * @OA\Schema(
2511 * type="string"
2512 * )
2513 * ),
2514 * @OA\Parameter(
2515 * name="eid",
2516 * in="path",
2517 * description="The id for the encounter.",
2518 * required=true,
2519 * @OA\Schema(
2520 * type="string"
2521 * )
2522 * ),
2523 * @OA\Parameter(
2524 * name="sid",
2525 * in="path",
2526 * description="The id for the soap noted.",
2527 * required=true,
2528 * @OA\Schema(
2529 * type="string"
2530 * )
2531 * ),
2532 * @OA\RequestBody(
2533 * required=true,
2534 * @OA\MediaType(
2535 * mediaType="application/json",
2536 * @OA\Schema(ref="#/components/schemas/api_soap_note_request")
2537 * )
2538 * ),
2539 * @OA\Response(
2540 * response="200",
2541 * ref="#/components/responses/standard"
2542 * ),
2543 * @OA\Response(
2544 * response="400",
2545 * ref="#/components/responses/badrequest"
2546 * ),
2547 * @OA\Response(
2548 * response="401",
2549 * ref="#/components/responses/unauthorized"
2550 * ),
2551 * security={{"openemr_auth":{}}}
2552 * )
2553 */
2554 "PUT /api/patient/:pid/encounter/:eid/soap_note/:sid" => function ($pid, $eid, $sid) {
2555 RestConfig::authorization_check("encounters", "notes");
2556 $data = (array) (json_decode(file_get_contents("php://input")));
2557 $return = (new EncounterRestController())->putSoapNote($pid, $eid, $sid, $data);
2558 RestConfig::apiLog($return, $data);
2559 return $return;
2560 },
2561
2562
2563 /**
2564 * @OA\Get(
2565 * path="/api/practitioner",
2566 * description="Retrieves a list of practitioners",
2567 * tags={"standard"},
2568 * @OA\Parameter(
2569 * name="title",
2570 * in="query",
2571 * description="The title for the practitioner.",
2572 * required=false,
2573 * @OA\Schema(
2574 * type="string"
2575 * )
2576 * ),
2577 * @OA\Parameter(
2578 * name="fname",
2579 * in="query",
2580 * description="The first name for the practitioner.",
2581 * required=false,
2582 * @OA\Schema(
2583 * type="string"
2584 * )
2585 * ),
2586 * @OA\Parameter(
2587 * name="lname",
2588 * in="query",
2589 * description="The last name for the practitioner.",
2590 * required=false,
2591 * @OA\Schema(
2592 * type="string"
2593 * )
2594 * ),
2595 * @OA\Parameter(
2596 * name="mname",
2597 * in="query",
2598 * description="The middle name for the practitioner.",
2599 * required=false,
2600 * @OA\Schema(
2601 * type="string"
2602 * )
2603 * ),
2604 * @OA\Parameter(
2605 * name="federaltaxid",
2606 * in="query",
2607 * description="The federal tax id for the practitioner.",
2608 * required=false,
2609 * @OA\Schema(
2610 * type="string"
2611 * )
2612 * ),
2613 * @OA\Parameter(
2614 * name="federaldrugid",
2615 * in="query",
2616 * description="The federal drug id for the practitioner.",
2617 * required=false,
2618 * @OA\Schema(
2619 * type="string"
2620 * )
2621 * ),
2622 * @OA\Parameter(
2623 * name="upin",
2624 * in="query",
2625 * description="The upin for the practitioner.",
2626 * required=false,
2627 * @OA\Schema(
2628 * type="string"
2629 * )
2630 * ),
2631 * @OA\Parameter(
2632 * name="facility_id",
2633 * in="query",
2634 * description="The facility id for the practitioner.",
2635 * required=false,
2636 * @OA\Schema(
2637 * type="string"
2638 * )
2639 * ),
2640 * @OA\Parameter(
2641 * name="facility",
2642 * in="query",
2643 * description="The facility for the practitioner.",
2644 * required=false,
2645 * @OA\Schema(
2646 * type="string"
2647 * )
2648 * ),
2649 * @OA\Parameter(
2650 * name="npi",
2651 * in="query",
2652 * description="The npi for the practitioner.",
2653 * required=false,
2654 * @OA\Schema(
2655 * type="string"
2656 * )
2657 * ),
2658 * @OA\Parameter(
2659 * name="email",
2660 * in="query",
2661 * description="The email for the practitioner.",
2662 * required=false,
2663 * @OA\Schema(
2664 * type="string"
2665 * )
2666 * ),
2667 * @OA\Parameter(
2668 * name="specialty",
2669 * in="query",
2670 * description="The specialty for the practitioner.",
2671 * required=false,
2672 * @OA\Schema(
2673 * type="string"
2674 * )
2675 * ),
2676 * @OA\Parameter(
2677 * name="billname",
2678 * in="query",
2679 * description="The billname for the practitioner.",
2680 * required=false,
2681 * @OA\Schema(
2682 * type="string"
2683 * )
2684 * ),
2685 * @OA\Parameter(
2686 * name="url",
2687 * in="query",
2688 * description="The url for the practitioner.",
2689 * required=false,
2690 * @OA\Schema(
2691 * type="string"
2692 * )
2693 * ),
2694 * @OA\Parameter(
2695 * name="assistant",
2696 * in="query",
2697 * description="The assistant for the practitioner.",
2698 * required=false,
2699 * @OA\Schema(
2700 * type="string"
2701 * )
2702 * ),
2703 * @OA\Parameter(
2704 * name="organization",
2705 * in="query",
2706 * description="The organization for the practitioner.",
2707 * required=false,
2708 * @OA\Schema(
2709 * type="string"
2710 * )
2711 * ),
2712 * @OA\Parameter(
2713 * name="valedictory",
2714 * in="query",
2715 * description="The valedictory for the practitioner.",
2716 * required=false,
2717 * @OA\Schema(
2718 * type="string"
2719 * )
2720 * ),
2721 * @OA\Parameter(
2722 * name="street",
2723 * in="query",
2724 * description="The street for the practitioner.",
2725 * required=false,
2726 * @OA\Schema(
2727 * type="string"
2728 * )
2729 * ),
2730 * @OA\Parameter(
2731 * name="streetb",
2732 * in="query",
2733 * description="The street (line 2) for the practitioner.",
2734 * required=false,
2735 * @OA\Schema(
2736 * type="string"
2737 * )
2738 * ),
2739 * @OA\Parameter(
2740 * name="city",
2741 * in="query",
2742 * description="The city for the practitioner.",
2743 * required=false,
2744 * @OA\Schema(
2745 * type="string"
2746 * )
2747 * ),
2748 * @OA\Parameter(
2749 * name="state",
2750 * in="query",
2751 * description="The state for the practitioner.",
2752 * required=false,
2753 * @OA\Schema(
2754 * type="string"
2755 * )
2756 * ),
2757 * @OA\Parameter(
2758 * name="zip",
2759 * in="query",
2760 * description="The zip for the practitioner.",
2761 * required=false,
2762 * @OA\Schema(
2763 * type="string"
2764 * )
2765 * ),
2766 * @OA\Parameter(
2767 * name="phone",
2768 * in="query",
2769 * description="The phone for the practitioner.",
2770 * required=false,
2771 * @OA\Schema(
2772 * type="string"
2773 * )
2774 * ),
2775 * @OA\Parameter(
2776 * name="fax",
2777 * in="query",
2778 * description="The fax for the practitioner.",
2779 * required=false,
2780 * @OA\Schema(
2781 * type="string"
2782 * )
2783 * ),
2784 * @OA\Parameter(
2785 * name="phonew1",
2786 * in="query",
2787 * description="The phonew1 for the practitioner.",
2788 * required=false,
2789 * @OA\Schema(
2790 * type="string"
2791 * )
2792 * ),
2793 * @OA\Parameter(
2794 * name="phonecell",
2795 * in="query",
2796 * description="The phonecell for the practitioner.",
2797 * required=false,
2798 * @OA\Schema(
2799 * type="string"
2800 * )
2801 * ),
2802 * @OA\Parameter(
2803 * name="notes",
2804 * in="query",
2805 * description="The notes for the practitioner.",
2806 * required=false,
2807 * @OA\Schema(
2808 * type="string"
2809 * )
2810 * ),
2811 * @OA\Parameter(
2812 * name="state_license_number2",
2813 * in="query",
2814 * description="The state license number for the practitioner.",
2815 * required=false,
2816 * @OA\Schema(
2817 * type="string"
2818 * )
2819 * ),
2820 * @OA\Parameter(
2821 * name="username",
2822 * in="query",
2823 * description="The username for the practitioner.",
2824 * required=false,
2825 * @OA\Schema(
2826 * type="string"
2827 * )
2828 * ),
2829 * @OA\Response(
2830 * response="200",
2831 * ref="#/components/responses/standard"
2832 * ),
2833 * @OA\Response(
2834 * response="400",
2835 * ref="#/components/responses/badrequest"
2836 * ),
2837 * @OA\Response(
2838 * response="401",
2839 * ref="#/components/responses/unauthorized"
2840 * ),
2841 * security={{"openemr_auth":{}}}
2842 * )
2843 */
2844 "GET /api/practitioner" => function () {
2845 RestConfig::authorization_check("admin", "users");
2846 $return = (new PractitionerRestController())->getAll($_GET);
2847 RestConfig::apiLog($return);
2848 return $return;
2849 },
2850
2851 /**
2852 * @OA\Get(
2853 * path="/api/practitioner/{pruuid}",
2854 * description="Retrieves a single practitioner by their uuid",
2855 * tags={"standard"},
2856 * @OA\Parameter(
2857 * name="pruuid",
2858 * in="path",
2859 * description="The uuid for the practitioner.",
2860 * required=true,
2861 * @OA\Schema(
2862 * type="string"
2863 * )
2864 * ),
2865 * @OA\Response(
2866 * response="200",
2867 * ref="#/components/responses/standard"
2868 * ),
2869 * @OA\Response(
2870 * response="400",
2871 * ref="#/components/responses/badrequest"
2872 * ),
2873 * @OA\Response(
2874 * response="401",
2875 * ref="#/components/responses/unauthorized"
2876 * ),
2877 * security={{"openemr_auth":{}}}
2878 * )
2879 */
2880 "GET /api/practitioner/:pruuid" => function ($pruuid) {
2881 RestConfig::authorization_check("admin", "users");
2882 $return = (new PractitionerRestController())->getOne($pruuid);
2883 RestConfig::apiLog($return);
2884 return $return;
2885 },
2886
2887 /**
2888 * @OA\Post(
2889 * path="/api/practitioner",
2890 * description="Submits a new practitioner",
2891 * tags={"standard"},
2892 * @OA\RequestBody(
2893 * required=true,
2894 * @OA\MediaType(
2895 * mediaType="application/json",
2896 * @OA\Schema(
2897 * @OA\Property(
2898 * property="title",
2899 * description="The title for the practitioner.",
2900 * type="string"
2901 * ),
2902 * @OA\Property(
2903 * property="fname",
2904 * description="The first name for the practitioner.",
2905 * type="string"
2906 * ),
2907 * @OA\Property(
2908 * property="mname",
2909 * description="The middle name for the practitioner.",
2910 * type="string"
2911 * ),
2912 * @OA\Property(
2913 * property="lname",
2914 * description="The last name for the practitioner.",
2915 * type="string"
2916 * ),
2917 * @OA\Property(
2918 * property="federaltaxid",
2919 * description="The federal tax id for the practitioner.",
2920 * type="string"
2921 * ),
2922 * @OA\Property(
2923 * property="federaldrugid",
2924 * description="The federal drug id for the practitioner.",
2925 * type="string"
2926 * ),
2927 * @OA\Property(
2928 * property="upin",
2929 * description="The upin for the practitioner.",
2930 * type="string"
2931 * ),
2932 * @OA\Property(
2933 * property="facility_id",
2934 * description="The facility_id for the practitioner.",
2935 * type="string"
2936 * ),
2937 * @OA\Property(
2938 * property="facility",
2939 * description="The facility name for the practitioner.",
2940 * type="string"
2941 * ),
2942 * @OA\Property(
2943 * property="npi",
2944 * description="The npi for the practitioner.",
2945 * type="string"
2946 * ),
2947 * @OA\Property(
2948 * property="email",
2949 * description="The email for the practitioner.",
2950 * type="string"
2951 * ),
2952 * @OA\Property(
2953 * property="specialty",
2954 * description="The specialty for the practitioner.",
2955 * type="string"
2956 * ),
2957 * @OA\Property(
2958 * property="billname",
2959 * description="The billname for the practitioner.",
2960 * type="string"
2961 * ),
2962 * @OA\Property(
2963 * property="url",
2964 * description="The url for the practitioner.",
2965 * type="string"
2966 * ),
2967 * @OA\Property(
2968 * property="assistant",
2969 * description="The assistant for the practitioner.",
2970 * type="string"
2971 * ),
2972 * @OA\Property(
2973 * property="valedictory",
2974 * description="The valedictory for the practitioner.",
2975 * type="string"
2976 * ),
2977 * @OA\Property(
2978 * property="street",
2979 * description="The street address for the practitioner.",
2980 * type="string"
2981 * ),
2982 * @OA\Property(
2983 * property="streetb",
2984 * description="The streetb address for the practitioner.",
2985 * type="string"
2986 * ),
2987 * @OA\Property(
2988 * property="city",
2989 * description="The city for the practitioner.",
2990 * type="string"
2991 * ),
2992 * @OA\Property(
2993 * property="state",
2994 * description="The state for the practitioner.",
2995 * type="string"
2996 * ),
2997 * @OA\Property(
2998 * property="zip",
2999 * description="The zip for the practitioner.",
3000 * type="string"
3001 * ),
3002 * @OA\Property(
3003 * property="phone",
3004 * description="The phone for the practitioner.",
3005 * type="string"
3006 * ),
3007 * @OA\Property(
3008 * property="fax",
3009 * description="The fax for the practitioner.",
3010 * type="string"
3011 * ),
3012 * @OA\Property(
3013 * property="phonew1",
3014 * description="The phonew1 for the practitioner.",
3015 * type="string"
3016 * ),
3017 * @OA\Property(
3018 * property="phonecell",
3019 * description="The phonecell for the practitioner.",
3020 * type="string"
3021 * ),
3022 * @OA\Property(
3023 * property="notes",
3024 * description="The notes for the practitioner.",
3025 * type="string"
3026 * ),
3027 * @OA\Property(
3028 * property="state_license_number",
3029 * description="The state license number for the practitioner.",
3030 * type="string"
3031 * ),
3032 * @OA\Property(
3033 * property="username",
3034 * description="The username for the practitioner.",
3035 * type="string"
3036 * ),
3037 * required={"fname", "lname", "npi"},
3038 * example={
3039 * "title": "Mrs.",
3040 * "fname": "Eduardo",
3041 * "mname": "Kathy",
3042 * "lname": "Perez",
3043 * "federaltaxid": "",
3044 * "federaldrugid": "",
3045 * "upin": "",
3046 * "facility_id": "3",
3047 * "facility": "Your Clinic Name Here",
3048 * "npi": "12345678901",
3049 * "email": "info@pennfirm.com",
3050 * "specialty": "",
3051 * "billname": null,
3052 * "url": null,
3053 * "assistant": null,
3054 * "organization": null,
3055 * "valedictory": null,
3056 * "street": "789 Third Avenue",
3057 * "streetb": "123 Cannaut Street",
3058 * "city": "San Diego",
3059 * "state": "CA",
3060 * "zip": "90210",
3061 * "phone": "(619) 555-9827",
3062 * "fax": null,
3063 * "phonew1": "(619) 555-7822",
3064 * "phonecell": "(619) 555-7821",
3065 * "notes": null,
3066 * "state_license_number": "123456",
3067 * "username": "eduardoperez"
3068 * }
3069 * )
3070 * )
3071 * ),
3072 * @OA\Response(
3073 * response="200",
3074 * description="Standard response",
3075 * @OA\MediaType(
3076 * mediaType="application/json",
3077 * @OA\Schema(
3078 * @OA\Property(
3079 * property="validationErrors",
3080 * description="Validation errors.",
3081 * type="array",
3082 * @OA\Items(
3083 * type="object",
3084 * ),
3085 * ),
3086 * @OA\Property(
3087 * property="internalErrors",
3088 * description="Internal errors.",
3089 * type="array",
3090 * @OA\Items(
3091 * type="object",
3092 * ),
3093 * ),
3094 * @OA\Property(
3095 * property="data",
3096 * description="Returned data.",
3097 * type="array",
3098 * @OA\Items(
3099 * @OA\Property(
3100 * property="id",
3101 * description="practitioner id",
3102 * type="integer",
3103 * ),
3104 * @OA\Property(
3105 * property="uuid",
3106 * description="practitioner uuid",
3107 * type="string",
3108 * ),
3109 * ),
3110 * ),
3111 * example={
3112 * "validationErrors": {},
3113 * "error_description": {},
3114 * "data": {
3115 * "id": 7,
3116 * "uuid": "90d453fb-0248-4c0d-9575-d99d02b169f5"
3117 * }
3118 * }
3119 * )
3120 * )
3121 * ),
3122 * @OA\Response(
3123 * response="401",
3124 * ref="#/components/responses/unauthorized"
3125 * ),
3126 * security={{"openemr_auth":{}}}
3127 * )
3128 */
3129 "POST /api/practitioner" => function () {
3130 RestConfig::authorization_check("admin", "users");
3131 $data = (array) (json_decode(file_get_contents("php://input")));
3132 $return = (new PractitionerRestController())->post($data);
3133 RestConfig::apiLog($return, $data);
3134 return $return;
3135 },
3136
3137 /**
3138 * @OA\Put(
3139 * path="/api/practitioner/{pruuid}",
3140 * description="Edit a practitioner",
3141 * tags={"standard"},
3142 * @OA\Parameter(
3143 * name="pruuid",
3144 * in="path",
3145 * description="The uuid for the practitioner.",
3146 * required=true,
3147 * @OA\Schema(
3148 * type="string"
3149 * )
3150 * ),
3151 * @OA\RequestBody(
3152 * required=true,
3153 * @OA\MediaType(
3154 * mediaType="application/json",
3155 * @OA\Schema(
3156 * @OA\Property(
3157 * property="title",
3158 * description="The title for the practitioner.",
3159 * type="string"
3160 * ),
3161 * @OA\Property(
3162 * property="fname",
3163 * description="The first name for the practitioner.",
3164 * type="string"
3165 * ),
3166 * @OA\Property(
3167 * property="mname",
3168 * description="The middle name for the practitioner.",
3169 * type="string"
3170 * ),
3171 * @OA\Property(
3172 * property="lname",
3173 * description="The last name for the practitioner.",
3174 * type="string"
3175 * ),
3176 * @OA\Property(
3177 * property="federaltaxid",
3178 * description="The federal tax id for the practitioner.",
3179 * type="string"
3180 * ),
3181 * @OA\Property(
3182 * property="federaldrugid",
3183 * description="The federal drug id for the practitioner.",
3184 * type="string"
3185 * ),
3186 * @OA\Property(
3187 * property="upin",
3188 * description="The upin for the practitioner.",
3189 * type="string"
3190 * ),
3191 * @OA\Property(
3192 * property="facility_id",
3193 * description="The facility_id for the practitioner.",
3194 * type="string"
3195 * ),
3196 * @OA\Property(
3197 * property="facility",
3198 * description="The facility name for the practitioner.",
3199 * type="string"
3200 * ),
3201 * @OA\Property(
3202 * property="npi",
3203 * description="The npi for the practitioner.",
3204 * type="string"
3205 * ),
3206 * @OA\Property(
3207 * property="email",
3208 * description="The email for the practitioner.",
3209 * type="string"
3210 * ),
3211 * @OA\Property(
3212 * property="specialty",
3213 * description="The specialty for the practitioner.",
3214 * type="string"
3215 * ),
3216 * @OA\Property(
3217 * property="billname",
3218 * description="The billname for the practitioner.",
3219 * type="string"
3220 * ),
3221 * @OA\Property(
3222 * property="url",
3223 * description="The url for the practitioner.",
3224 * type="string"
3225 * ),
3226 * @OA\Property(
3227 * property="assistant",
3228 * description="The assistant for the practitioner.",
3229 * type="string"
3230 * ),
3231 * @OA\Property(
3232 * property="valedictory",
3233 * description="The valedictory for the practitioner.",
3234 * type="string"
3235 * ),
3236 * @OA\Property(
3237 * property="street",
3238 * description="The street address for the practitioner.",
3239 * type="string"
3240 * ),
3241 * @OA\Property(
3242 * property="streetb",
3243 * description="The streetb address for the practitioner.",
3244 * type="string"
3245 * ),
3246 * @OA\Property(
3247 * property="city",
3248 * description="The city for the practitioner.",
3249 * type="string"
3250 * ),
3251 * @OA\Property(
3252 * property="state",
3253 * description="The state for the practitioner.",
3254 * type="string"
3255 * ),
3256 * @OA\Property(
3257 * property="zip",
3258 * description="The zip for the practitioner.",
3259 * type="string"
3260 * ),
3261 * @OA\Property(
3262 * property="phone",
3263 * description="The phone for the practitioner.",
3264 * type="string"
3265 * ),
3266 * @OA\Property(
3267 * property="fax",
3268 * description="The fax for the practitioner.",
3269 * type="string"
3270 * ),
3271 * @OA\Property(
3272 * property="phonew1",
3273 * description="The phonew1 for the practitioner.",
3274 * type="string"
3275 * ),
3276 * @OA\Property(
3277 * property="phonecell",
3278 * description="The phonecell for the practitioner.",
3279 * type="string"
3280 * ),
3281 * @OA\Property(
3282 * property="notes",
3283 * description="The notes for the practitioner.",
3284 * type="string"
3285 * ),
3286 * @OA\Property(
3287 * property="state_license_number",
3288 * description="The state license number for the practitioner.",
3289 * type="string"
3290 * ),
3291 * @OA\Property(
3292 * property="username",
3293 * description="The username for the practitioner.",
3294 * type="string"
3295 * ),
3296 * example={
3297 * "title": "Mr",
3298 * "fname": "Baz",
3299 * "mname": "",
3300 * "lname": "Bop",
3301 * "street": "456 Tree Lane",
3302 * "zip": "08642",
3303 * "city": "FooTown",
3304 * "state": "FL",
3305 * "phone": "123-456-7890"
3306 * }
3307 * )
3308 * )
3309 * ),
3310 * @OA\Response(
3311 * response="200",
3312 * description="Standard response",
3313 * @OA\MediaType(
3314 * mediaType="application/json",
3315 * @OA\Schema(
3316 * @OA\Property(
3317 * property="validationErrors",
3318 * description="Validation errors.",
3319 * type="array",
3320 * @OA\Items(
3321 * type="object",
3322 * ),
3323 * ),
3324 * @OA\Property(
3325 * property="internalErrors",
3326 * description="Internal errors.",
3327 * type="array",
3328 * @OA\Items(
3329 * type="object",
3330 * ),
3331 * ),
3332 * @OA\Property(
3333 * property="data",
3334 * description="Returned data.",
3335 * type="array",
3336 * @OA\Items(
3337 * @OA\Property(
3338 * property="id",
3339 * description="practitioner id",
3340 * type="string",
3341 * ),
3342 * @OA\Property(
3343 * property="uuid",
3344 * description="practitioner uuid",
3345 * type="string",
3346 * ),
3347 * @OA\Property(
3348 * property="title",
3349 * description="practitioner title",
3350 * type="string",
3351 * ),
3352 * @OA\Property(
3353 * property="fname",
3354 * description="practitioner fname",
3355 * type="string",
3356 * ),
3357 * @OA\Property(
3358 * property="lname",
3359 * description="practitioner lname",
3360 * type="string",
3361 * ),
3362 * @OA\Property(
3363 * property="mname",
3364 * description="practitioner mname",
3365 * type="string",
3366 * ),
3367 * @OA\Property(
3368 * property="federaltaxid",
3369 * description="practitioner federaltaxid",
3370 * type="string",
3371 * ),
3372 * @OA\Property(
3373 * property="federaldrugid",
3374 * description="practitioner federaldrugid",
3375 * type="string",
3376 * ),
3377 * @OA\Property(
3378 * property="upin",
3379 * description="practitioner upin",
3380 * type="string",
3381 * ),
3382 * @OA\Property(
3383 * property="facility_id",
3384 * description="practitioner facility_id",
3385 * type="string",
3386 * ),
3387 * @OA\Property(
3388 * property="facility",
3389 * description="practitioner facility",
3390 * type="string",
3391 * ),
3392 * @OA\Property(
3393 * property="npi",
3394 * description="practitioner npi",
3395 * type="string",
3396 * ),
3397 * @OA\Property(
3398 * property="email",
3399 * description="practitioner email",
3400 * type="string",
3401 * ),
3402 * @OA\Property(
3403 * property="active",
3404 * description="practitioner active setting",
3405 * type="string",
3406 * ),
3407 * @OA\Property(
3408 * property="specialty",
3409 * description="practitioner specialty",
3410 * type="string",
3411 * ),
3412 * @OA\Property(
3413 * property="billname",
3414 * description="practitioner billname",
3415 * type="string",
3416 * ),
3417 * @OA\Property(
3418 * property="url",
3419 * description="practitioner url",
3420 * type="string",
3421 * ),
3422 * @OA\Property(
3423 * property="assistant",
3424 * description="practitioner assistant",
3425 * type="string",
3426 * ),
3427 * @OA\Property(
3428 * property="organization",
3429 * description="practitioner organization",
3430 * type="string",
3431 * ),
3432 * @OA\Property(
3433 * property="valedictory",
3434 * description="practitioner valedictory",
3435 * type="string",
3436 * ),
3437 * @OA\Property(
3438 * property="street",
3439 * description="practitioner street",
3440 * type="string",
3441 * ),
3442 * @OA\Property(
3443 * property="streetb",
3444 * description="practitioner streetb",
3445 * type="string",
3446 * ),
3447 * @OA\Property(
3448 * property="city",
3449 * description="practitioner city",
3450 * type="string",
3451 * ),
3452 * @OA\Property(
3453 * property="state",
3454 * description="practitioner state",
3455 * type="string",
3456 * ),
3457 * @OA\Property(
3458 * property="zip",
3459 * description="practitioner zip",
3460 * type="string",
3461 * ),
3462 * @OA\Property(
3463 * property="phone",
3464 * description="practitioner phone",
3465 * type="string",
3466 * ),
3467 * @OA\Property(
3468 * property="fax",
3469 * description="fax",
3470 * type="string",
3471 * ),
3472 * @OA\Property(
3473 * property="phonew1",
3474 * description="practitioner phonew1",
3475 * type="string",
3476 * ),
3477 * @OA\Property(
3478 * property="phonecell",
3479 * description="practitioner phonecell",
3480 * type="string",
3481 * ),
3482 * @OA\Property(
3483 * property="notes",
3484 * description="practitioner notes",
3485 * type="string",
3486 * ),
3487 * @OA\Property(
3488 * property="state_license_number",
3489 * description="practitioner state license number",
3490 * type="string",
3491 * ),
3492 * @OA\Property(
3493 * property="abook_title",
3494 * description="practitioner abook title",
3495 * type="string",
3496 * ),
3497 * @OA\Property(
3498 * property="physician_title",
3499 * description="practitioner physician title",
3500 * type="string",
3501 * ),
3502 * @OA\Property(
3503 * property="physician_code",
3504 * description="practitioner physician code",
3505 * type="string",
3506 * )
3507 * ),
3508 * ),
3509 * example={
3510 * "validationErrors": {},
3511 * "error_description": {},
3512 * "data": {
3513 * "id": 7,
3514 * "uuid": "90d453fb-0248-4c0d-9575-d99d02b169f5",
3515 * "title": "Mr",
3516 * "fname": "Baz",
3517 * "lname": "Bop",
3518 * "mname": "",
3519 * "federaltaxid": "",
3520 * "federaldrugid": "",
3521 * "upin": "",
3522 * "facility_id": "3",
3523 * "facility": "Your Clinic Name Here",
3524 * "npi": "0123456789",
3525 * "email": "info@pennfirm.com",
3526 * "active": "1",
3527 * "specialty": "",
3528 * "billname": "",
3529 * "url": "",
3530 * "assistant": "",
3531 * "organization": "",
3532 * "valedictory": "",
3533 * "street": "456 Tree Lane",
3534 * "streetb": "123 Cannaut Street",
3535 * "city": "FooTown",
3536 * "state": "FL",
3537 * "zip": "08642",
3538 * "phone": "123-456-7890",
3539 * "fax": "",
3540 * "phonew1": "(619) 555-7822",
3541 * "phonecell": "(619) 555-7821",
3542 * "notes": "",
3543 * "state_license_number": "123456",
3544 * "abook_title": null,
3545 * "physician_title": null,
3546 * "physician_code": null
3547 * }
3548 * }
3549 * )
3550 * )
3551 * ),
3552 * @OA\Response(
3553 * response="401",
3554 * ref="#/components/responses/unauthorized"
3555 * ),
3556 * security={{"openemr_auth":{}}}
3557 * )
3558 */
3559 "PUT /api/practitioner/:pruuid" => function ($pruuid) {
3560 RestConfig::authorization_check("admin", "users");
3561 $data = (array) (json_decode(file_get_contents("php://input")));
3562 $return = (new PractitionerRestController())->patch($pruuid, $data);
3563 RestConfig::apiLog($return, $data);
3564 return $return;
3565 },
3566
3567 /**
3568 * @OA\Get(
3569 * path="/api/medical_problem",
3570 * description="Retrieves a list of medical problems",
3571 * tags={"standard"},
3572 * @OA\Parameter(
3573 * name="puuid",
3574 * in="query",
3575 * description="The uuid for the patient.",
3576 * required=false,
3577 * @OA\Schema(
3578 * type="string"
3579 * )
3580 * ),
3581 * @OA\Parameter(
3582 * name="condition_uuid",
3583 * in="query",
3584 * description="The uuid for the medical problem.",
3585 * required=false,
3586 * @OA\Schema(
3587 * type="string"
3588 * )
3589 * ),
3590 * @OA\Parameter(
3591 * name="title",
3592 * in="query",
3593 * description="The title for the medical problem.",
3594 * required=false,
3595 * @OA\Schema(
3596 * type="string"
3597 * )
3598 * ),
3599 * @OA\Parameter(
3600 * name="begdate",
3601 * in="query",
3602 * description="The start date for the medical problem.",
3603 * required=false,
3604 * @OA\Schema(
3605 * type="string"
3606 * )
3607 * ),
3608 * @OA\Parameter(
3609 * name="enddate",
3610 * in="query",
3611 * description="The end date for the medical problem.",
3612 * required=false,
3613 * @OA\Schema(
3614 * type="string"
3615 * )
3616 * ),
3617 * @OA\Parameter(
3618 * name="diagnosis",
3619 * in="query",
3620 * description="The diagnosis for the medical problem.",
3621 * required=false,
3622 * @OA\Schema(
3623 * type="string"
3624 * )
3625 * ),
3626 * @OA\Response(
3627 * response="200",
3628 * ref="#/components/responses/standard"
3629 * ),
3630 * @OA\Response(
3631 * response="400",
3632 * ref="#/components/responses/badrequest"
3633 * ),
3634 * @OA\Response(
3635 * response="401",
3636 * ref="#/components/responses/unauthorized"
3637 * ),
3638 * security={{"openemr_auth":{}}}
3639 * )
3640 */
3641 "GET /api/medical_problem" => function () {
3642 RestConfig::authorization_check("encounters", "notes");
3643 $return = (new ConditionRestController())->getAll();
3644 RestConfig::apiLog($return);
3645 return $return;
3646 },
3647
3648 /**
3649 * @OA\Get(
3650 * path="/api/medical_problem/{muuid}",
3651 * description="Retrieves a single medical problem by their uuid",
3652 * tags={"standard"},
3653 * @OA\Parameter(
3654 * name="muuid",
3655 * in="path",
3656 * description="The uuid for the medical problem.",
3657 * required=true,
3658 * @OA\Schema(
3659 * type="string"
3660 * )
3661 * ),
3662 * @OA\Response(
3663 * response="200",
3664 * ref="#/components/responses/standard"
3665 * ),
3666 * @OA\Response(
3667 * response="400",
3668 * ref="#/components/responses/badrequest"
3669 * ),
3670 * @OA\Response(
3671 * response="401",
3672 * ref="#/components/responses/unauthorized"
3673 * ),
3674 * security={{"openemr_auth":{}}}
3675 * )
3676 */
3677 "GET /api/medical_problem/:muuid" => function ($muuid) {
3678 RestConfig::authorization_check("encounters", "notes");
3679 $return = (new ConditionRestController())->getOne($muuid);
3680 RestConfig::apiLog($return);
3681 return $return;
3682 },
3683
3684 /**
3685 * @OA\Get(
3686 * path="/api/patient/{puuid}/medical_problem",
3687 * description="Retrieves all medical problems for a patient",
3688 * tags={"standard"},
3689 * @OA\Parameter(
3690 * name="puuid",
3691 * in="path",
3692 * description="The uuid for the patient.",
3693 * required=true,
3694 * @OA\Schema(
3695 * type="string"
3696 * )
3697 * ),
3698 * @OA\Response(
3699 * response="200",
3700 * ref="#/components/responses/standard"
3701 * ),
3702 * @OA\Response(
3703 * response="400",
3704 * ref="#/components/responses/badrequest"
3705 * ),
3706 * @OA\Response(
3707 * response="401",
3708 * ref="#/components/responses/unauthorized"
3709 * ),
3710 * security={{"openemr_auth":{}}}
3711 * )
3712 */
3713 "GET /api/patient/:puuid/medical_problem" => function ($puuid) {
3714 RestConfig::authorization_check("encounters", "notes");
3715 $return = (new ConditionRestController())->getAll(['puuid' => $puuid, 'condition_uuid' => $muuid], "medical_problem");
3716 RestConfig::apiLog($return);
3717 return $return;
3718 },
3719
3720 /**
3721 * @OA\Get(
3722 * path="/api/patient/{puuid}/medical_problem/{muuid}",
3723 * description="Retrieves a medical problem for a patient",
3724 * tags={"standard"},
3725 * @OA\Parameter(
3726 * name="puuid",
3727 * in="path",
3728 * description="The uuid for the patient.",
3729 * required=true,
3730 * @OA\Schema(
3731 * type="string"
3732 * )
3733 * ),
3734 * @OA\Parameter(
3735 * name="muuid",
3736 * in="path",
3737 * description="The uuid for the medical problem.",
3738 * required=true,
3739 * @OA\Schema(
3740 * type="string"
3741 * )
3742 * ),
3743 * @OA\Response(
3744 * response="200",
3745 * ref="#/components/responses/standard"
3746 * ),
3747 * @OA\Response(
3748 * response="400",
3749 * ref="#/components/responses/badrequest"
3750 * ),
3751 * @OA\Response(
3752 * response="401",
3753 * ref="#/components/responses/unauthorized"
3754 * ),
3755 * security={{"openemr_auth":{}}}
3756 * )
3757 */
3758 "GET /api/patient/:puuid/medical_problem/:muuid" => function ($puuid, $muuid) {
3759 RestConfig::authorization_check("patients", "med");
3760 $return = (new ConditionRestController())->getAll(['puuid' => $puuid, 'condition_uuid' => $muuid]);
3761 RestConfig::apiLog($return);
3762 return $return;
3763 },
3764
3765 /**
3766 * Schema for the medical_problem request
3767 *
3768 * @OA\Schema(
3769 * schema="api_medical_problem_request",
3770 * @OA\Property(
3771 * property="title",
3772 * description="The title of medical problem.",
3773 * type="string"
3774 * ),
3775 * @OA\Property(
3776 * property="begdate",
3777 * description="The beginning date of medical problem.",
3778 * type="string"
3779 * ),
3780 * @OA\Property(
3781 * property="enddate",
3782 * description="The end date of medical problem.",
3783 * type="string"
3784 * ),
3785 * @OA\Property(
3786 * property="diagnosis",
3787 * description="The diagnosis of medical problem. In format `<codetype>:<code>`",
3788 * type="string"
3789 * ),
3790 * required={"title", "begdate"},
3791 * example={
3792 * "title": "Dermatochalasis",
3793 * "begdate": "2010-10-13",
3794 * "enddate": null,
3795 * "diagnosis": "ICD10:H02.839"
3796 * }
3797 * )
3798 */
3799 /**
3800 * @OA\Post(
3801 * path="/api/patient/{puuid}/medical_problem",
3802 * description="Submits a new medical problem",
3803 * tags={"standard"},
3804 * @OA\Parameter(
3805 * name="puuid",
3806 * in="path",
3807 * description="The uuid for the patient.",
3808 * required=true,
3809 * @OA\Schema(
3810 * type="string"
3811 * )
3812 * ),
3813 * @OA\RequestBody(
3814 * required=true,
3815 * @OA\MediaType(
3816 * mediaType="application/json",
3817 * @OA\Schema(ref="#/components/schemas/api_medical_problem_request")
3818 * )
3819 * ),
3820 * @OA\Response(
3821 * response="200",
3822 * ref="#/components/responses/standard"
3823 * ),
3824 * @OA\Response(
3825 * response="400",
3826 * ref="#/components/responses/badrequest"
3827 * ),
3828 * @OA\Response(
3829 * response="401",
3830 * ref="#/components/responses/unauthorized"
3831 * ),
3832 * security={{"openemr_auth":{}}}
3833 * )
3834 */
3835 "POST /api/patient/:puuid/medical_problem" => function ($puuid) {
3836 RestConfig::authorization_check("patients", "med");
3837 $data = (array) (json_decode(file_get_contents("php://input")));
3838 $return = (new ConditionRestController())->post($puuid, $data);
3839 RestConfig::apiLog($return, $data);
3840 return $return;
3841 },
3842
3843 /**
3844 * @OA\Put(
3845 * path="/api/patient/{puuid}/medical_problem/{muuid}",
3846 * description="Edit a medical problem",
3847 * tags={"standard"},
3848 * @OA\Parameter(
3849 * name="puuid",
3850 * in="path",
3851 * description="The uuid for the patient.",
3852 * required=true,
3853 * @OA\Schema(
3854 * type="string"
3855 * )
3856 * ),
3857 * @OA\Parameter(
3858 * name="muuid",
3859 * in="path",
3860 * description="The uuid for the medical problem.",
3861 * required=true,
3862 * @OA\Schema(
3863 * type="string"
3864 * )
3865 * ),
3866 * @OA\RequestBody(
3867 * required=true,
3868 * @OA\MediaType(
3869 * mediaType="application/json",
3870 * @OA\Schema(ref="#/components/schemas/api_medical_problem_request")
3871 * )
3872 * ),
3873 * @OA\Response(
3874 * response="200",
3875 * ref="#/components/responses/standard"
3876 * ),
3877 * @OA\Response(
3878 * response="400",
3879 * ref="#/components/responses/badrequest"
3880 * ),
3881 * @OA\Response(
3882 * response="401",
3883 * ref="#/components/responses/unauthorized"
3884 * ),
3885 * security={{"openemr_auth":{}}}
3886 * )
3887 */
3888 "PUT /api/patient/:puuid/medical_problem/:muuid" => function ($puuid, $muuid) {
3889 RestConfig::authorization_check("patients", "med");
3890 $data = (array) (json_decode(file_get_contents("php://input")));
3891 $return = (new ConditionRestController())->put($puuid, $muuid, $data);
3892 RestConfig::apiLog($return, $data);
3893 return $return;
3894 },
3895
3896 /**
3897 * @OA\Delete(
3898 * path="/api/patient/{puuid}/medical_problem/{muuid}",
3899 * description="Delete a medical problem",
3900 * tags={"standard"},
3901 * @OA\Parameter(
3902 * name="puuid",
3903 * in="path",
3904 * description="The uuid for the patient.",
3905 * required=true,
3906 * @OA\Schema(
3907 * type="string"
3908 * )
3909 * ),
3910 * @OA\Parameter(
3911 * name="muuid",
3912 * in="path",
3913 * description="The uuid for the medical problem.",
3914 * required=true,
3915 * @OA\Schema(
3916 * type="string"
3917 * )
3918 * ),
3919 * @OA\Response(
3920 * response="200",
3921 * ref="#/components/responses/standard"
3922 * ),
3923 * @OA\Response(
3924 * response="400",
3925 * ref="#/components/responses/badrequest"
3926 * ),
3927 * @OA\Response(
3928 * response="401",
3929 * ref="#/components/responses/unauthorized"
3930 * ),
3931 * security={{"openemr_auth":{}}}
3932 * )
3933 */
3934 "DELETE /api/patient/:puuid/medical_problem/:muuid" => function ($puuid, $muuid) {
3935 RestConfig::authorization_check("patients", "med");
3936 $return = (new ConditionRestController())->delete($puuid, $muuid);
3937 RestConfig::apiLog($return);
3938 return $return;
3939 },
3940
3941 /**
3942 * @OA\Get(
3943 * path="/api/allergy",
3944 * description="Retrieves a list of allergies",
3945 * tags={"standard"},
3946 * @OA\Parameter(
3947 * name="lists.pid",
3948 * in="query",
3949 * description="The uuid for the patient.",
3950 * required=false,
3951 * @OA\Schema(
3952 * type="string"
3953 * )
3954 * ),
3955 * @OA\Parameter(
3956 * name="lists.id",
3957 * in="query",
3958 * description="The uuid for the allergy.",
3959 * required=false,
3960 * @OA\Schema(
3961 * type="string"
3962 * )
3963 * ),
3964 * @OA\Parameter(
3965 * name="title",
3966 * in="query",
3967 * description="The title for the allergy.",
3968 * required=false,
3969 * @OA\Schema(
3970 * type="string"
3971 * )
3972 * ),
3973 * @OA\Parameter(
3974 * name="begdate",
3975 * in="query",
3976 * description="The start date for the allergy.",
3977 * required=false,
3978 * @OA\Schema(
3979 * type="string"
3980 * )
3981 * ),
3982 * @OA\Parameter(
3983 * name="enddate",
3984 * in="query",
3985 * description="The end date for the allergy.",
3986 * required=false,
3987 * @OA\Schema(
3988 * type="string"
3989 * )
3990 * ),
3991 * @OA\Parameter(
3992 * name="diagnosis",
3993 * in="query",
3994 * description="The diagnosis for the allergy.",
3995 * required=false,
3996 * @OA\Schema(
3997 * type="string"
3998 * )
3999 * ),
4000 * @OA\Response(
4001 * response="200",
4002 * ref="#/components/responses/standard"
4003 * ),
4004 * @OA\Response(
4005 * response="400",
4006 * ref="#/components/responses/badrequest"
4007 * ),
4008 * @OA\Response(
4009 * response="401",
4010 * ref="#/components/responses/unauthorized"
4011 * ),
4012 * security={{"openemr_auth":{}}}
4013 * )
4014 */
4015 "GET /api/allergy" => function () {
4016 RestConfig::authorization_check("patients", "med");
4017 $return = (new AllergyIntoleranceRestController())->getAll();
4018 RestConfig::apiLog($return);
4019 return $return;
4020 },
4021
4022 /**
4023 * @OA\Get(
4024 * path="/api/allergy/{auuid}",
4025 * description="Retrieves a single allergy by their uuid",
4026 * tags={"standard"},
4027 * @OA\Parameter(
4028 * name="auuid",
4029 * in="path",
4030 * description="The uuid for the allergy.",
4031 * required=true,
4032 * @OA\Schema(
4033 * type="string"
4034 * )
4035 * ),
4036 * @OA\Response(
4037 * response="200",
4038 * ref="#/components/responses/standard"
4039 * ),
4040 * @OA\Response(
4041 * response="400",
4042 * ref="#/components/responses/badrequest"
4043 * ),
4044 * @OA\Response(
4045 * response="401",
4046 * ref="#/components/responses/unauthorized"
4047 * ),
4048 * security={{"openemr_auth":{}}}
4049 * )
4050 */
4051 "GET /api/allergy/:auuid" => function ($auuid) {
4052 RestConfig::authorization_check("patients", "med");
4053 $return = (new AllergyIntoleranceRestController())->getOne($auuid);
4054 RestConfig::apiLog($return);
4055 return $return;
4056 },
4057
4058 /**
4059 * @OA\Get(
4060 * path="/api/patient/{puuid}/allergy",
4061 * description="Retrieves all allergies for a patient",
4062 * tags={"standard"},
4063 * @OA\Parameter(
4064 * name="puuid",
4065 * in="path",
4066 * description="The uuid for the patient.",
4067 * required=true,
4068 * @OA\Schema(
4069 * type="string"
4070 * )
4071 * ),
4072 * @OA\Response(
4073 * response="200",
4074 * ref="#/components/responses/standard"
4075 * ),
4076 * @OA\Response(
4077 * response="400",
4078 * ref="#/components/responses/badrequest"
4079 * ),
4080 * @OA\Response(
4081 * response="401",
4082 * ref="#/components/responses/unauthorized"
4083 * ),
4084 * security={{"openemr_auth":{}}}
4085 * )
4086 */
4087 "GET /api/patient/:puuid/allergy" => function ($puuid) {
4088 RestConfig::authorization_check("patients", "med");
4089 $return = (new AllergyIntoleranceRestController())->getAll(['lists.pid' => $puuid]);
4090 RestConfig::apiLog($return);
4091 return $return;
4092 },
4093
4094 /**
4095 * @OA\Get(
4096 * path="/api/patient/{puuid}/allergy/{auuid}",
4097 * description="Retrieves a allergy for a patient",
4098 * tags={"standard"},
4099 * @OA\Parameter(
4100 * name="puuid",
4101 * in="path",
4102 * description="The uuid for the patient.",
4103 * required=true,
4104 * @OA\Schema(
4105 * type="string"
4106 * )
4107 * ),
4108 * @OA\Parameter(
4109 * name="auuid",
4110 * in="path",
4111 * description="The uuid for the allergy.",
4112 * required=true,
4113 * @OA\Schema(
4114 * type="string"
4115 * )
4116 * ),
4117 * @OA\Response(
4118 * response="200",
4119 * ref="#/components/responses/standard"
4120 * ),
4121 * @OA\Response(
4122 * response="400",
4123 * ref="#/components/responses/badrequest"
4124 * ),
4125 * @OA\Response(
4126 * response="401",
4127 * ref="#/components/responses/unauthorized"
4128 * ),
4129 * security={{"openemr_auth":{}}}
4130 * )
4131 */
4132 "GET /api/patient/:puuid/allergy/:auuid" => function ($puuid, $auuid) {
4133 RestConfig::authorization_check("patients", "med");
4134 $return = (new AllergyIntoleranceRestController())->getAll(['lists.pid' => $puuid, 'lists.id' => $auuid]);
4135 RestConfig::apiLog($return);
4136 return $return;
4137 },
4138
4139 /**
4140 * Schema for the allergy request
4141 *
4142 * @OA\Schema(
4143 * schema="api_allergy_request",
4144 * @OA\Property(
4145 * property="title",
4146 * description="The title of allergy.",
4147 * type="string"
4148 * ),
4149 * @OA\Property(
4150 * property="begdate",
4151 * description="The beginning date of allergy.",
4152 * type="string"
4153 * ),
4154 * @OA\Property(
4155 * property="enddate",
4156 * description="The end date of allergy.",
4157 * type="string"
4158 * ),
4159 * @OA\Property(
4160 * property="diagnosis",
4161 * description="The diagnosis of allergy. In format `<codetype>:<code>`",
4162 * type="string"
4163 * ),
4164 * required={"title", "begdate"},
4165 * example={
4166 * "title": "Iodine",
4167 * "begdate": "2010-10-13",
4168 * "enddate": null
4169 * }
4170 * )
4171 */
4172 /**
4173 * @OA\Post(
4174 * path="/api/patient/{puuid}/allergy",
4175 * description="Submits a new allergy",
4176 * tags={"standard"},
4177 * @OA\Parameter(
4178 * name="puuid",
4179 * in="path",
4180 * description="The uuid for the patient.",
4181 * required=true,
4182 * @OA\Schema(
4183 * type="string"
4184 * )
4185 * ),
4186 * @OA\RequestBody(
4187 * required=true,
4188 * @OA\MediaType(
4189 * mediaType="application/json",
4190 * @OA\Schema(ref="#/components/schemas/api_allergy_request")
4191 * )
4192 * ),
4193 * @OA\Response(
4194 * response="200",
4195 * ref="#/components/responses/standard"
4196 * ),
4197 * @OA\Response(
4198 * response="400",
4199 * ref="#/components/responses/badrequest"
4200 * ),
4201 * @OA\Response(
4202 * response="401",
4203 * ref="#/components/responses/unauthorized"
4204 * ),
4205 * security={{"openemr_auth":{}}}
4206 * )
4207 */
4208 "POST /api/patient/:puuid/allergy" => function ($puuid) {
4209 RestConfig::authorization_check("patients", "med");
4210 $data = (array) (json_decode(file_get_contents("php://input")));
4211 $return = (new AllergyIntoleranceRestController())->post($puuid, $data);
4212 RestConfig::apiLog($return, $data);
4213 return $return;
4214 },
4215
4216 /**
4217 * @OA\Put(
4218 * path="/api/patient/{puuid}/allergy/{auuid}",
4219 * description="Edit a allergy",
4220 * tags={"standard"},
4221 * @OA\Parameter(
4222 * name="puuid",
4223 * in="path",
4224 * description="The uuid for the patient.",
4225 * required=true,
4226 * @OA\Schema(
4227 * type="string"
4228 * )
4229 * ),
4230 * @OA\Parameter(
4231 * name="auuid",
4232 * in="path",
4233 * description="The uuid for the allergy.",
4234 * required=true,
4235 * @OA\Schema(
4236 * type="string"
4237 * )
4238 * ),
4239 * @OA\RequestBody(
4240 * required=true,
4241 * @OA\MediaType(
4242 * mediaType="application/json",
4243 * @OA\Schema(ref="#/components/schemas/api_allergy_request")
4244 * )
4245 * ),
4246 * @OA\Response(
4247 * response="200",
4248 * ref="#/components/responses/standard"
4249 * ),
4250 * @OA\Response(
4251 * response="400",
4252 * ref="#/components/responses/badrequest"
4253 * ),
4254 * @OA\Response(
4255 * response="401",
4256 * ref="#/components/responses/unauthorized"
4257 * ),
4258 * security={{"openemr_auth":{}}}
4259 * )
4260 */
4261 "PUT /api/patient/:puuid/allergy/:auuid" => function ($puuid, $auuid) {
4262 RestConfig::authorization_check("patients", "med");
4263 $data = (array) (json_decode(file_get_contents("php://input")));
4264 $return = (new AllergyIntoleranceRestController())->put($puuid, $auuid, $data);
4265 RestConfig::apiLog($return, $data);
4266 return $return;
4267 },
4268
4269 /**
4270 * @OA\Delete(
4271 * path="/api/patient/{puuid}/allergy/{auuid}",
4272 * description="Delete a medical problem",
4273 * tags={"standard"},
4274 * @OA\Parameter(
4275 * name="puuid",
4276 * in="path",
4277 * description="The uuid for the patient.",
4278 * required=true,
4279 * @OA\Schema(
4280 * type="string"
4281 * )
4282 * ),
4283 * @OA\Parameter(
4284 * name="auuid",
4285 * in="path",
4286 * description="The uuid for the allergy.",
4287 * required=true,
4288 * @OA\Schema(
4289 * type="string"
4290 * )
4291 * ),
4292 * @OA\Response(
4293 * response="200",
4294 * ref="#/components/responses/standard"
4295 * ),
4296 * @OA\Response(
4297 * response="400",
4298 * ref="#/components/responses/badrequest"
4299 * ),
4300 * @OA\Response(
4301 * response="401",
4302 * ref="#/components/responses/unauthorized"
4303 * ),
4304 * security={{"openemr_auth":{}}}
4305 * )
4306 */
4307 "DELETE /api/patient/:puuid/allergy/:auuid" => function ($puuid, $auuid) {
4308 RestConfig::authorization_check("patients", "med");
4309 $return = (new AllergyIntoleranceRestController())->delete($puuid, $auuid);
4310 RestConfig::apiLog($return);
4311 return $return;
4312 },
4313
4314 /**
4315 * @OA\Get(
4316 * path="/api/patient/{pid}/medication",
4317 * description="Retrieves all medications for a patient",
4318 * tags={"standard"},
4319 * @OA\Parameter(
4320 * name="pid",
4321 * in="path",
4322 * description="The pid for the patient.",
4323 * required=true,
4324 * @OA\Schema(
4325 * type="string"
4326 * )
4327 * ),
4328 * @OA\Response(
4329 * response="200",
4330 * ref="#/components/responses/standard"
4331 * ),
4332 * @OA\Response(
4333 * response="400",
4334 * ref="#/components/responses/badrequest"
4335 * ),
4336 * @OA\Response(
4337 * response="401",
4338 * ref="#/components/responses/unauthorized"
4339 * ),
4340 * security={{"openemr_auth":{}}}
4341 * )
4342 */
4343 "GET /api/patient/:pid/medication" => function ($pid) {
4344 RestConfig::authorization_check("patients", "med");
4345 $return = (new ListRestController())->getAll($pid, "medication");
4346 RestConfig::apiLog($return);
4347 return $return;
4348 },
4349
4350 /**
4351 * Schema for the medication request
4352 *
4353 * @OA\Schema(
4354 * schema="api_medication_request",
4355 * @OA\Property(
4356 * property="title",
4357 * description="The title of medication.",
4358 * type="string"
4359 * ),
4360 * @OA\Property(
4361 * property="begdate",
4362 * description="The beginning date of medication.",
4363 * type="string"
4364 * ),
4365 * @OA\Property(
4366 * property="enddate",
4367 * description="The end date of medication.",
4368 * type="string"
4369 * ),
4370 * @OA\Property(
4371 * property="diagnosis",
4372 * description="The diagnosis of medication. In format `<codetype>:<code>`",
4373 * type="string"
4374 * ),
4375 * required={"title", "begdate"},
4376 * example={
4377 * "title": "Norvasc",
4378 * "begdate": "2013-04-13",
4379 * "enddate": null
4380 * }
4381 * )
4382 */
4383 /**
4384 * @OA\Post(
4385 * path="/api/patient/{pid}/medication",
4386 * description="Submits a new medication",
4387 * tags={"standard"},
4388 * @OA\Parameter(
4389 * name="pid",
4390 * in="path",
4391 * description="The pid for the patient.",
4392 * required=true,
4393 * @OA\Schema(
4394 * type="string"
4395 * )
4396 * ),
4397 * @OA\RequestBody(
4398 * required=true,
4399 * @OA\MediaType(
4400 * mediaType="application/json",
4401 * @OA\Schema(ref="#/components/schemas/api_medication_request")
4402 * )
4403 * ),
4404 * @OA\Response(
4405 * response="200",
4406 * ref="#/components/responses/standard"
4407 * ),
4408 * @OA\Response(
4409 * response="400",
4410 * ref="#/components/responses/badrequest"
4411 * ),
4412 * @OA\Response(
4413 * response="401",
4414 * ref="#/components/responses/unauthorized"
4415 * ),
4416 * security={{"openemr_auth":{}}}
4417 * )
4418 */
4419 "POST /api/patient/:pid/medication" => function ($pid) {
4420 RestConfig::authorization_check("patients", "med");
4421 $data = (array) (json_decode(file_get_contents("php://input")));
4422 $return = (new ListRestController())->post($pid, "medication", $data);
4423 RestConfig::apiLog($return, $data);
4424 return $return;
4425 },
4426
4427 /**
4428 * @OA\Put(
4429 * path="/api/patient/{pid}/medication/{mid}",
4430 * description="Edit a medication",
4431 * tags={"standard"},
4432 * @OA\Parameter(
4433 * name="pid",
4434 * in="path",
4435 * description="The pid for the patient.",
4436 * required=true,
4437 * @OA\Schema(
4438 * type="string"
4439 * )
4440 * ),
4441 * @OA\Parameter(
4442 * name="mid",
4443 * in="path",
4444 * description="The id for the medication.",
4445 * required=true,
4446 * @OA\Schema(
4447 * type="string"
4448 * )
4449 * ),
4450 * @OA\RequestBody(
4451 * required=true,
4452 * @OA\MediaType(
4453 * mediaType="application/json",
4454 * @OA\Schema(ref="#/components/schemas/api_medication_request")
4455 * )
4456 * ),
4457 * @OA\Response(
4458 * response="200",
4459 * ref="#/components/responses/standard"
4460 * ),
4461 * @OA\Response(
4462 * response="400",
4463 * ref="#/components/responses/badrequest"
4464 * ),
4465 * @OA\Response(
4466 * response="401",
4467 * ref="#/components/responses/unauthorized"
4468 * ),
4469 * security={{"openemr_auth":{}}}
4470 * )
4471 */
4472 "PUT /api/patient/:pid/medication/:mid" => function ($pid, $mid) {
4473 RestConfig::authorization_check("patients", "med");
4474 $data = (array) (json_decode(file_get_contents("php://input")));
4475 $return = (new ListRestController())->put($pid, $mid, "medication", $data);
4476 RestConfig::apiLog($return, $data);
4477 return $return;
4478 },
4479
4480 /**
4481 * @OA\Get(
4482 * path="/api/patient/{pid}/medication/{mid}",
4483 * description="Retrieves a medication for a patient",
4484 * tags={"standard"},
4485 * @OA\Parameter(
4486 * name="pid",
4487 * in="path",
4488 * description="The id for the patient.",
4489 * required=true,
4490 * @OA\Schema(
4491 * type="string"
4492 * )
4493 * ),
4494 * @OA\Parameter(
4495 * name="mid",
4496 * in="path",
4497 * description="The id for the medication.",
4498 * required=true,
4499 * @OA\Schema(
4500 * type="string"
4501 * )
4502 * ),
4503 * @OA\Response(
4504 * response="200",
4505 * ref="#/components/responses/standard"
4506 * ),
4507 * @OA\Response(
4508 * response="400",
4509 * ref="#/components/responses/badrequest"
4510 * ),
4511 * @OA\Response(
4512 * response="401",
4513 * ref="#/components/responses/unauthorized"
4514 * ),
4515 * security={{"openemr_auth":{}}}
4516 * )
4517 */
4518 "GET /api/patient/:pid/medication/:mid" => function ($pid, $mid) {
4519 RestConfig::authorization_check("patients", "med");
4520 $return = (new ListRestController())->getOne($pid, "medication", $mid);
4521 RestConfig::apiLog($return);
4522 return $return;
4523 },
4524
4525 /**
4526 * @OA\Delete(
4527 * path="/api/patient/{pid}/medication/{mid}",
4528 * description="Delete a medication",
4529 * tags={"standard"},
4530 * @OA\Parameter(
4531 * name="pid",
4532 * in="path",
4533 * description="The id for the patient.",
4534 * required=true,
4535 * @OA\Schema(
4536 * type="string"
4537 * )
4538 * ),
4539 * @OA\Parameter(
4540 * name="mid",
4541 * in="path",
4542 * description="The id for the medication.",
4543 * required=true,
4544 * @OA\Schema(
4545 * type="string"
4546 * )
4547 * ),
4548 * @OA\Response(
4549 * response="200",
4550 * ref="#/components/responses/standard"
4551 * ),
4552 * @OA\Response(
4553 * response="400",
4554 * ref="#/components/responses/badrequest"
4555 * ),
4556 * @OA\Response(
4557 * response="401",
4558 * ref="#/components/responses/unauthorized"
4559 * ),
4560 * security={{"openemr_auth":{}}}
4561 * )
4562 */
4563 "DELETE /api/patient/:pid/medication/:mid" => function ($pid, $mid) {
4564 RestConfig::authorization_check("patients", "med");
4565 $return = (new ListRestController())->delete($pid, $mid, "medication");
4566 RestConfig::apiLog($return);
4567 return $return;
4568 },
4569
4570 /**
4571 * @OA\Get(
4572 * path="/api/patient/{pid}/surgery",
4573 * description="Retrieves all surgeries for a patient",
4574 * tags={"standard"},
4575 * @OA\Parameter(
4576 * name="pid",
4577 * in="path",
4578 * description="The pid for the patient.",
4579 * required=true,
4580 * @OA\Schema(
4581 * type="string"
4582 * )
4583 * ),
4584 * @OA\Response(
4585 * response="200",
4586 * ref="#/components/responses/standard"
4587 * ),
4588 * @OA\Response(
4589 * response="400",
4590 * ref="#/components/responses/badrequest"
4591 * ),
4592 * @OA\Response(
4593 * response="401",
4594 * ref="#/components/responses/unauthorized"
4595 * ),
4596 * security={{"openemr_auth":{}}}
4597 * )
4598 */
4599 "GET /api/patient/:pid/surgery" => function ($pid) {
4600 RestConfig::authorization_check("patients", "med");
4601 $return = (new ListRestController())->getAll($pid, "surgery");
4602 RestConfig::apiLog($return);
4603 return $return;
4604 },
4605
4606 /**
4607 * @OA\Get(
4608 * path="/api/patient/{pid}/surgery/{sid}",
4609 * description="Retrieves a surgery for a patient",
4610 * tags={"standard"},
4611 * @OA\Parameter(
4612 * name="pid",
4613 * in="path",
4614 * description="The id for the patient.",
4615 * required=true,
4616 * @OA\Schema(
4617 * type="string"
4618 * )
4619 * ),
4620 * @OA\Parameter(
4621 * name="sid",
4622 * in="path",
4623 * description="The id for the surgery.",
4624 * required=true,
4625 * @OA\Schema(
4626 * type="string"
4627 * )
4628 * ),
4629 * @OA\Response(
4630 * response="200",
4631 * ref="#/components/responses/standard"
4632 * ),
4633 * @OA\Response(
4634 * response="400",
4635 * ref="#/components/responses/badrequest"
4636 * ),
4637 * @OA\Response(
4638 * response="401",
4639 * ref="#/components/responses/unauthorized"
4640 * ),
4641 * security={{"openemr_auth":{}}}
4642 * )
4643 */
4644 "GET /api/patient/:pid/surgery/:sid" => function ($pid, $sid) {
4645 RestConfig::authorization_check("patients", "med");
4646 $return = (new ListRestController())->getOne($pid, "surgery", $sid);
4647 RestConfig::apiLog($return);
4648 return $return;
4649 },
4650
4651 /**
4652 * @OA\Delete(
4653 * path="/api/patient/{pid}/surgery/{sid}",
4654 * description="Delete a surgery",
4655 * tags={"standard"},
4656 * @OA\Parameter(
4657 * name="pid",
4658 * in="path",
4659 * description="The id for the patient.",
4660 * required=true,
4661 * @OA\Schema(
4662 * type="string"
4663 * )
4664 * ),
4665 * @OA\Parameter(
4666 * name="sid",
4667 * in="path",
4668 * description="The id for the surgery.",
4669 * required=true,
4670 * @OA\Schema(
4671 * type="string"
4672 * )
4673 * ),
4674 * @OA\Response(
4675 * response="200",
4676 * ref="#/components/responses/standard"
4677 * ),
4678 * @OA\Response(
4679 * response="400",
4680 * ref="#/components/responses/badrequest"
4681 * ),
4682 * @OA\Response(
4683 * response="401",
4684 * ref="#/components/responses/unauthorized"
4685 * ),
4686 * security={{"openemr_auth":{}}}
4687 * )
4688 */
4689 "DELETE /api/patient/:pid/surgery/:sid" => function ($pid, $sid) {
4690 RestConfig::authorization_check("patients", "med");
4691 $return = (new ListRestController())->delete($pid, $sid, "surgery");
4692 RestConfig::apiLog($return);
4693 return $return;
4694 },
4695
4696 /**
4697 * Schema for the surgery request
4698 *
4699 * @OA\Schema(
4700 * schema="api_surgery_request",
4701 * @OA\Property(
4702 * property="title",
4703 * description="The title of surgery.",
4704 * type="string"
4705 * ),
4706 * @OA\Property(
4707 * property="begdate",
4708 * description="The beginning date of surgery.",
4709 * type="string"
4710 * ),
4711 * @OA\Property(
4712 * property="enddate",
4713 * description="The end date of surgery.",
4714 * type="string"
4715 * ),
4716 * @OA\Property(
4717 * property="diagnosis",
4718 * description="The diagnosis of surgery. In format `<codetype>:<code>`",
4719 * type="string"
4720 * ),
4721 * required={"title", "begdate"},
4722 * example={
4723 * "title": "Blepharoplasty",
4724 * "begdate": "2013-10-14",
4725 * "enddate": null,
4726 * "diagnosis": "CPT4:15823-50"
4727 * }
4728 * )
4729 */
4730 /**
4731 * @OA\Post(
4732 * path="/api/patient/{pid}/surgery",
4733 * description="Submits a new surgery",
4734 * tags={"standard"},
4735 * @OA\Parameter(
4736 * name="pid",
4737 * in="path",
4738 * description="The pid for the patient.",
4739 * required=true,
4740 * @OA\Schema(
4741 * type="string"
4742 * )
4743 * ),
4744 * @OA\RequestBody(
4745 * required=true,
4746 * @OA\MediaType(
4747 * mediaType="application/json",
4748 * @OA\Schema(ref="#/components/schemas/api_surgery_request")
4749 * )
4750 * ),
4751 * @OA\Response(
4752 * response="200",
4753 * ref="#/components/responses/standard"
4754 * ),
4755 * @OA\Response(
4756 * response="400",
4757 * ref="#/components/responses/badrequest"
4758 * ),
4759 * @OA\Response(
4760 * response="401",
4761 * ref="#/components/responses/unauthorized"
4762 * ),
4763 * security={{"openemr_auth":{}}}
4764 * )
4765 */
4766 "POST /api/patient/:pid/surgery" => function ($pid) {
4767 RestConfig::authorization_check("patients", "med");
4768 $data = (array) (json_decode(file_get_contents("php://input")));
4769 $return = (new ListRestController())->post($pid, "surgery", $data);
4770 RestConfig::apiLog($return, $data);
4771 return $return;
4772 },
4773
4774 /**
4775 * @OA\Put(
4776 * path="/api/patient/{pid}/surgery/{sid}",
4777 * description="Edit a surgery",
4778 * tags={"standard"},
4779 * @OA\Parameter(
4780 * name="pid",
4781 * in="path",
4782 * description="The pid for the patient.",
4783 * required=true,
4784 * @OA\Schema(
4785 * type="string"
4786 * )
4787 * ),
4788 * @OA\Parameter(
4789 * name="sid",
4790 * in="path",
4791 * description="The id for the surgery.",
4792 * required=true,
4793 * @OA\Schema(
4794 * type="string"
4795 * )
4796 * ),
4797 * @OA\RequestBody(
4798 * required=true,
4799 * @OA\MediaType(
4800 * mediaType="application/json",
4801 * @OA\Schema(ref="#/components/schemas/api_surgery_request")
4802 * )
4803 * ),
4804 * @OA\Response(
4805 * response="200",
4806 * ref="#/components/responses/standard"
4807 * ),
4808 * @OA\Response(
4809 * response="400",
4810 * ref="#/components/responses/badrequest"
4811 * ),
4812 * @OA\Response(
4813 * response="401",
4814 * ref="#/components/responses/unauthorized"
4815 * ),
4816 * security={{"openemr_auth":{}}}
4817 * )
4818 */
4819 "PUT /api/patient/:pid/surgery/:sid" => function ($pid, $sid) {
4820 RestConfig::authorization_check("patients", "med");
4821 $data = (array) (json_decode(file_get_contents("php://input")));
4822 $return = (new ListRestController())->put($pid, $sid, "surgery", $data);
4823 RestConfig::apiLog($return, $data);
4824 return $return;
4825 },
4826
4827 /**
4828 * @OA\Get(
4829 * path="/api/patient/{pid}/dental_issue",
4830 * description="Retrieves all dental issues for a patient",
4831 * tags={"standard"},
4832 * @OA\Parameter(
4833 * name="pid",
4834 * in="path",
4835 * description="The pid for the patient.",
4836 * required=true,
4837 * @OA\Schema(
4838 * type="string"
4839 * )
4840 * ),
4841 * @OA\Response(
4842 * response="200",
4843 * ref="#/components/responses/standard"
4844 * ),
4845 * @OA\Response(
4846 * response="400",
4847 * ref="#/components/responses/badrequest"
4848 * ),
4849 * @OA\Response(
4850 * response="401",
4851 * ref="#/components/responses/unauthorized"
4852 * ),
4853 * security={{"openemr_auth":{}}}
4854 * )
4855 */
4856 "GET /api/patient/:pid/dental_issue" => function ($pid) {
4857 RestConfig::authorization_check("patients", "med");
4858 $return = (new ListRestController())->getAll($pid, "dental");
4859 RestConfig::apiLog($return);
4860 return $return;
4861 },
4862
4863 /**
4864 * @OA\Get(
4865 * path="/api/patient/{pid}/dental_issue/{did}",
4866 * description="Retrieves a dental issue for a patient",
4867 * tags={"standard"},
4868 * @OA\Parameter(
4869 * name="pid",
4870 * in="path",
4871 * description="The id for the patient.",
4872 * required=true,
4873 * @OA\Schema(
4874 * type="string"
4875 * )
4876 * ),
4877 * @OA\Parameter(
4878 * name="did",
4879 * in="path",
4880 * description="The id for the dental issue.",
4881 * required=true,
4882 * @OA\Schema(
4883 * type="string"
4884 * )
4885 * ),
4886 * @OA\Response(
4887 * response="200",
4888 * ref="#/components/responses/standard"
4889 * ),
4890 * @OA\Response(
4891 * response="400",
4892 * ref="#/components/responses/badrequest"
4893 * ),
4894 * @OA\Response(
4895 * response="401",
4896 * ref="#/components/responses/unauthorized"
4897 * ),
4898 * security={{"openemr_auth":{}}}
4899 * )
4900 */
4901 "GET /api/patient/:pid/dental_issue/:did" => function ($pid, $did) {
4902 RestConfig::authorization_check("patients", "med");
4903 $return = (new ListRestController())->getOne($pid, "dental", $did);
4904 RestConfig::apiLog($return);
4905 return $return;
4906 },
4907
4908 /**
4909 * @OA\Delete(
4910 * path="/api/patient/{pid}/dental_issue/{did}",
4911 * description="Delete a dental issue",
4912 * tags={"standard"},
4913 * @OA\Parameter(
4914 * name="pid",
4915 * in="path",
4916 * description="The id for the patient.",
4917 * required=true,
4918 * @OA\Schema(
4919 * type="string"
4920 * )
4921 * ),
4922 * @OA\Parameter(
4923 * name="did",
4924 * in="path",
4925 * description="The id for the dental issue.",
4926 * required=true,
4927 * @OA\Schema(
4928 * type="string"
4929 * )
4930 * ),
4931 * @OA\Response(
4932 * response="200",
4933 * ref="#/components/responses/standard"
4934 * ),
4935 * @OA\Response(
4936 * response="400",
4937 * ref="#/components/responses/badrequest"
4938 * ),
4939 * @OA\Response(
4940 * response="401",
4941 * ref="#/components/responses/unauthorized"
4942 * ),
4943 * security={{"openemr_auth":{}}}
4944 * )
4945 */
4946 "DELETE /api/patient/:pid/dental_issue/:did" => function ($pid, $did) {
4947 RestConfig::authorization_check("patients", "med");
4948 $return = (new ListRestController())->delete($pid, $did, "dental");
4949 RestConfig::apiLog($return);
4950 return $return;
4951 },
4952
4953 /**
4954 * Schema for the dental_issue request
4955 *
4956 * @OA\Schema(
4957 * schema="api_dental_issue_request",
4958 * @OA\Property(
4959 * property="title",
4960 * description="The title of dental issue.",
4961 * type="string"
4962 * ),
4963 * @OA\Property(
4964 * property="begdate",
4965 * description="The beginning date of dental issue.",
4966 * type="string"
4967 * ),
4968 * @OA\Property(
4969 * property="enddate",
4970 * description="The end date of dental issue.",
4971 * type="string"
4972 * ),
4973 * @OA\Property(
4974 * property="diagnosis",
4975 * description="The diagnosis of dental issue. In format `<codetype>:<code>`",
4976 * type="string"
4977 * ),
4978 * required={"title", "begdate"},
4979 * example={
4980 * "title": "Halitosis",
4981 * "begdate": "2015-03-17",
4982 * "enddate": null,
4983 * }
4984 * )
4985 */
4986 /**
4987 * @OA\Post(
4988 * path="/api/patient/{pid}/dental_issue",
4989 * description="Submits a new dental issue",
4990 * tags={"standard"},
4991 * @OA\Parameter(
4992 * name="pid",
4993 * in="path",
4994 * description="The pid for the patient.",
4995 * required=true,
4996 * @OA\Schema(
4997 * type="string"
4998 * )
4999 * ),
5000 * @OA\RequestBody(
5001 * required=true,
5002 * @OA\MediaType(
5003 * mediaType="application/json",
5004 * @OA\Schema(ref="#/components/schemas/api_dental_issue_request")
5005 * )
5006 * ),
5007 * @OA\Response(
5008 * response="200",
5009 * ref="#/components/responses/standard"
5010 * ),
5011 * @OA\Response(
5012 * response="400",
5013 * ref="#/components/responses/badrequest"
5014 * ),
5015 * @OA\Response(
5016 * response="401",
5017 * ref="#/components/responses/unauthorized"
5018 * ),
5019 * security={{"openemr_auth":{}}}
5020 * )
5021 */
5022 "POST /api/patient/:pid/dental_issue" => function ($pid) {
5023 RestConfig::authorization_check("patients", "med");
5024 $data = (array) (json_decode(file_get_contents("php://input")));
5025 $return = (new ListRestController())->post($pid, "dental", $data);
5026 RestConfig::apiLog($return, $data);
5027 return $return;
5028 },
5029
5030 /**
5031 * @OA\Put(
5032 * path="/api/patient/{pid}/dental_issue/{did}",
5033 * description="Edit a dental issue",
5034 * tags={"standard"},
5035 * @OA\Parameter(
5036 * name="pid",
5037 * in="path",
5038 * description="The pid for the patient.",
5039 * required=true,
5040 * @OA\Schema(
5041 * type="string"
5042 * )
5043 * ),
5044 * @OA\Parameter(
5045 * name="did",
5046 * in="path",
5047 * description="The id for the dental issue.",
5048 * required=true,
5049 * @OA\Schema(
5050 * type="string"
5051 * )
5052 * ),
5053 * @OA\RequestBody(
5054 * required=true,
5055 * @OA\MediaType(
5056 * mediaType="application/json",
5057 * @OA\Schema(ref="#/components/schemas/api_dental_issue_request")
5058 * )
5059 * ),
5060 * @OA\Response(
5061 * response="200",
5062 * ref="#/components/responses/standard"
5063 * ),
5064 * @OA\Response(
5065 * response="400",
5066 * ref="#/components/responses/badrequest"
5067 * ),
5068 * @OA\Response(
5069 * response="401",
5070 * ref="#/components/responses/unauthorized"
5071 * ),
5072 * security={{"openemr_auth":{}}}
5073 * )
5074 */
5075 "PUT /api/patient/:pid/dental_issue/:did" => function ($pid, $did) {
5076 RestConfig::authorization_check("patients", "med");
5077 $data = (array) (json_decode(file_get_contents("php://input")));
5078 $return = (new ListRestController())->put($pid, $did, "dental", $data);
5079 RestConfig::apiLog($return, $data);
5080 return $return;
5081 },
5082
5083 /**
5084 * @OA\Get(
5085 * path="/api/patient/{pid}/appointment",
5086 * description="Retrieves all appointments for a patient",
5087 * tags={"standard"},
5088 * @OA\Parameter(
5089 * name="pid",
5090 * in="path",
5091 * description="The pid for the patient.",
5092 * required=true,
5093 * @OA\Schema(
5094 * type="string"
5095 * )
5096 * ),
5097 * @OA\Response(
5098 * response="200",
5099 * ref="#/components/responses/standard"
5100 * ),
5101 * @OA\Response(
5102 * response="400",
5103 * ref="#/components/responses/badrequest"
5104 * ),
5105 * @OA\Response(
5106 * response="401",
5107 * ref="#/components/responses/unauthorized"
5108 * ),
5109 * security={{"openemr_auth":{}}}
5110 * )
5111 */
5112 "GET /api/patient/:pid/appointment" => function ($pid) {
5113 RestConfig::authorization_check("patients", "appt");
5114 $return = (new AppointmentRestController())->getAllForPatient($pid);
5115 RestConfig::apiLog($return);
5116 return $return;
5117 },
5118
5119 /**
5120 * @OA\Post(
5121 * path="/api/patient/{pid}/appointment",
5122 * description="Submits a new appointment",
5123 * tags={"standard"},
5124 * @OA\Parameter(
5125 * name="pid",
5126 * in="path",
5127 * description="The id for the patient.",
5128 * required=true,
5129 * @OA\Schema(
5130 * type="string"
5131 * )
5132 * ),
5133 * @OA\RequestBody(
5134 * required=true,
5135 * @OA\MediaType(
5136 * mediaType="application/json",
5137 * @OA\Schema(
5138 * @OA\Property(
5139 * property="pc_catid",
5140 * description="The category of the appointment.",
5141 * type="string"
5142 * ),
5143 * @OA\Property(
5144 * property="pc_title",
5145 * description="The title of the appointment.",
5146 * type="string"
5147 * ),
5148 * @OA\Property(
5149 * property="pc_duration",
5150 * description="The duration of the appointment.",
5151 * type="string"
5152 * ),
5153 * @OA\Property(
5154 * property="pc_hometext",
5155 * description="Comments for the appointment.",
5156 * type="string"
5157 * ),
5158 * @OA\Property(
5159 * property="pc_apptstatus",
5160 * description="use an option from resource=/api/list/apptstat",
5161 * type="string"
5162 * ),
5163 * @OA\Property(
5164 * property="pc_eventDate",
5165 * description="The date of the appointment.",
5166 * type="string"
5167 * ),
5168 * @OA\Property(
5169 * property="pc_startTime",
5170 * description="The time of the appointment.",
5171 * type="string"
5172 * ),
5173 * @OA\Property(
5174 * property="pc_facility",
5175 * description="The facility id of the appointment.",
5176 * type="string"
5177 * ),
5178 * @OA\Property(
5179 * property="pc_billing_location",
5180 * description="The billinag location id of the appointment.",
5181 * type="string"
5182 * ),
5183 * @OA\Property(
5184 * property="pc_aid",
5185 * description="The provider id for the appointment.",
5186 * type="string"
5187 * ),
5188 * required={"pc_catid", "pc_title", "pc_duration", "pc_hometext", "pc_apptstatus", "pc_eventDate", "pc_startTime", "pc_facility", "pc_billing_location"},
5189 * example={
5190 * "pc_catid": "5",
5191 * "pc_title": "Office Visit",
5192 * "pc_duration": "900",
5193 * "pc_hometext": "Test",
5194 * "pc_apptstatus": "-",
5195 * "pc_eventDate": "2018-10-19",
5196 * "pc_startTime": "09:00",
5197 * "pc_facility": "9",
5198 * "pc_billing_location": "10",
5199 * "pc_aid": "1"
5200 * }
5201 * )
5202 * )
5203 * ),
5204 * @OA\Response(
5205 * response="200",
5206 * ref="#/components/responses/standard"
5207 * ),
5208 * @OA\Response(
5209 * response="400",
5210 * ref="#/components/responses/badrequest"
5211 * ),
5212 * @OA\Response(
5213 * response="401",
5214 * ref="#/components/responses/unauthorized"
5215 * ),
5216 * security={{"openemr_auth":{}}}
5217 * )
5218 */
5219 "POST /api/patient/:pid/appointment" => function ($pid) {
5220 RestConfig::authorization_check("patients", "appt");
5221 $data = (array) (json_decode(file_get_contents("php://input")));
5222 $return = (new AppointmentRestController())->post($pid, $data);
5223 RestConfig::apiLog($return, $data);
5224 return $return;
5225 },
5226
5227 /**
5228 * @OA\Get(
5229 * path="/api/appointment",
5230 * description="Retrieves all appointments",
5231 * tags={"standard"},
5232 * @OA\Response(
5233 * response="200",
5234 * ref="#/components/responses/standard"
5235 * ),
5236 * @OA\Response(
5237 * response="400",
5238 * ref="#/components/responses/badrequest"
5239 * ),
5240 * @OA\Response(
5241 * response="401",
5242 * ref="#/components/responses/unauthorized"
5243 * ),
5244 * security={{"openemr_auth":{}}}
5245 * )
5246 */
5247 "GET /api/appointment" => function () {
5248 RestConfig::authorization_check("patients", "appt");
5249 $return = (new AppointmentRestController())->getAll();
5250 RestConfig::apiLog($return);
5251 return $return;
5252 },
5253
5254 /**
5255 * @OA\Get(
5256 * path="/api/appointment/{eid}",
5257 * description="Retrieves an appointment",
5258 * tags={"standard"},
5259 * @OA\Parameter(
5260 * name="eid",
5261 * in="path",
5262 * description="The eid for the appointment.",
5263 * required=true,
5264 * @OA\Schema(
5265 * type="string"
5266 * )
5267 * ),
5268 * @OA\Response(
5269 * response="200",
5270 * ref="#/components/responses/standard"
5271 * ),
5272 * @OA\Response(
5273 * response="400",
5274 * ref="#/components/responses/badrequest"
5275 * ),
5276 * @OA\Response(
5277 * response="401",
5278 * ref="#/components/responses/unauthorized"
5279 * ),
5280 * security={{"openemr_auth":{}}}
5281 * )
5282 */
5283 "GET /api/appointment/:eid" => function ($eid) {
5284 RestConfig::authorization_check("patients", "appt");
5285 $return = (new AppointmentRestController())->getOne($eid);
5286 RestConfig::apiLog($return);
5287 return $return;
5288 },
5289
5290 /**
5291 * @OA\Delete(
5292 * path="/api/patient/{pid}/appointment/{eid}",
5293 * description="Delete a appointment",
5294 * tags={"standard"},
5295 * @OA\Parameter(
5296 * name="pid",
5297 * in="path",
5298 * description="The id for the patient.",
5299 * required=true,
5300 * @OA\Schema(
5301 * type="string"
5302 * )
5303 * ),
5304 * @OA\Parameter(
5305 * name="eid",
5306 * in="path",
5307 * description="The eid for the appointment.",
5308 * required=true,
5309 * @OA\Schema(
5310 * type="string"
5311 * )
5312 * ),
5313 * @OA\Response(
5314 * response="200",
5315 * ref="#/components/responses/standard"
5316 * ),
5317 * @OA\Response(
5318 * response="400",
5319 * ref="#/components/responses/badrequest"
5320 * ),
5321 * @OA\Response(
5322 * response="401",
5323 * ref="#/components/responses/unauthorized"
5324 * ),
5325 * security={{"openemr_auth":{}}}
5326 * )
5327 */
5328 "DELETE /api/patient/:pid/appointment/:eid" => function ($pid, $eid) {
5329 RestConfig::authorization_check("patients", "appt");
5330 $return = (new AppointmentRestController())->delete($eid);
5331 RestConfig::apiLog($return);
5332 return $return;
5333 },
5334
5335 /**
5336 * @OA\Get(
5337 * path="/api/patient/{pid}/appointment/{eid}",
5338 * description="Retrieves a appointment for a patient",
5339 * tags={"standard"},
5340 * @OA\Parameter(
5341 * name="pid",
5342 * in="path",
5343 * description="The id for the patient.",
5344 * required=true,
5345 * @OA\Schema(
5346 * type="string"
5347 * )
5348 * ),
5349 * @OA\Parameter(
5350 * name="eid",
5351 * in="path",
5352 * description="The eid for the appointment.",
5353 * required=true,
5354 * @OA\Schema(
5355 * type="string"
5356 * )
5357 * ),
5358 * @OA\Response(
5359 * response="200",
5360 * ref="#/components/responses/standard"
5361 * ),
5362 * @OA\Response(
5363 * response="400",
5364 * ref="#/components/responses/badrequest"
5365 * ),
5366 * @OA\Response(
5367 * response="401",
5368 * ref="#/components/responses/unauthorized"
5369 * ),
5370 * security={{"openemr_auth":{}}}
5371 * )
5372 */
5373 "GET /api/patient/:pid/appointment/:eid" => function ($pid, $eid) {
5374 RestConfig::authorization_check("patients", "appt");
5375 $return = (new AppointmentRestController())->getOne($eid);
5376 RestConfig::apiLog($return);
5377 return $return;
5378 },
5379
5380 /**
5381 * @OA\Get(
5382 * path="/api/list/{list_name}",
5383 * description="Retrieves a list",
5384 * tags={"standard"},
5385 * @OA\Parameter(
5386 * name="list_name",
5387 * in="path",
5388 * description="The list_id of the list.",
5389 * required=true,
5390 * @OA\Schema(
5391 * type="string"
5392 * )
5393 * ),
5394 * @OA\Response(
5395 * response="200",
5396 * ref="#/components/responses/standard"
5397 * ),
5398 * @OA\Response(
5399 * response="400",
5400 * ref="#/components/responses/badrequest"
5401 * ),
5402 * @OA\Response(
5403 * response="401",
5404 * ref="#/components/responses/unauthorized"
5405 * ),
5406 * security={{"openemr_auth":{}}}
5407 * )
5408 */
5409 "GET /api/list/:list_name" => function ($list_name) {
5410 RestConfig::authorization_check("lists", "default");
5411 $return = (new ListRestController())->getOptions($list_name);
5412 RestConfig::apiLog($return);
5413 return $return;
5414 },
5415
5416 /**
5417 * @OA\Get(
5418 * path="/api/user",
5419 * description="Retrieves a list of users",
5420 * tags={"standard"},
5421 * @OA\Parameter(
5422 * name="id",
5423 * in="query",
5424 * description="The id for the user.",
5425 * required=false,
5426 * @OA\Schema(
5427 * type="string"
5428 * )
5429 * ),
5430 * @OA\Parameter(
5431 * name="title",
5432 * in="query",
5433 * description="The title for the user.",
5434 * required=false,
5435 * @OA\Schema(
5436 * type="string"
5437 * )
5438 * ),
5439 * @OA\Parameter(
5440 * name="fname",
5441 * in="query",
5442 * description="The first name for the user.",
5443 * required=false,
5444 * @OA\Schema(
5445 * type="string"
5446 * )
5447 * ),
5448 * @OA\Parameter(
5449 * name="lname",
5450 * in="query",
5451 * description="The last name for the user.",
5452 * required=false,
5453 * @OA\Schema(
5454 * type="string"
5455 * )
5456 * ),
5457 * @OA\Parameter(
5458 * name="mname",
5459 * in="query",
5460 * description="The middle name for the user.",
5461 * required=false,
5462 * @OA\Schema(
5463 * type="string"
5464 * )
5465 * ),
5466 * @OA\Parameter(
5467 * name="federaltaxid",
5468 * in="query",
5469 * description="The federal tax id for the user.",
5470 * required=false,
5471 * @OA\Schema(
5472 * type="string"
5473 * )
5474 * ),
5475 * @OA\Parameter(
5476 * name="federaldrugid",
5477 * in="query",
5478 * description="The federal drug id for the user.",
5479 * required=false,
5480 * @OA\Schema(
5481 * type="string"
5482 * )
5483 * ),
5484 * @OA\Parameter(
5485 * name="upin",
5486 * in="query",
5487 * description="The upin for the user.",
5488 * required=false,
5489 * @OA\Schema(
5490 * type="string"
5491 * )
5492 * ),
5493 * @OA\Parameter(
5494 * name="facility_id",
5495 * in="query",
5496 * description="The facility id for the user.",
5497 * required=false,
5498 * @OA\Schema(
5499 * type="string"
5500 * )
5501 * ),
5502 * @OA\Parameter(
5503 * name="facility",
5504 * in="query",
5505 * description="The facility for the user.",
5506 * required=false,
5507 * @OA\Schema(
5508 * type="string"
5509 * )
5510 * ),
5511 * @OA\Parameter(
5512 * name="npi",
5513 * in="query",
5514 * description="The npi for the user.",
5515 * required=false,
5516 * @OA\Schema(
5517 * type="string"
5518 * )
5519 * ),
5520 * @OA\Parameter(
5521 * name="email",
5522 * in="query",
5523 * description="The email for the user.",
5524 * required=false,
5525 * @OA\Schema(
5526 * type="string"
5527 * )
5528 * ),
5529 * @OA\Parameter(
5530 * name="specialty",
5531 * in="query",
5532 * description="The specialty for the user.",
5533 * required=false,
5534 * @OA\Schema(
5535 * type="string"
5536 * )
5537 * ),
5538 * @OA\Parameter(
5539 * name="billname",
5540 * in="query",
5541 * description="The billname for the user.",
5542 * required=false,
5543 * @OA\Schema(
5544 * type="string"
5545 * )
5546 * ),
5547 * @OA\Parameter(
5548 * name="url",
5549 * in="query",
5550 * description="The url for the user.",
5551 * required=false,
5552 * @OA\Schema(
5553 * type="string"
5554 * )
5555 * ),
5556 * @OA\Parameter(
5557 * name="assistant",
5558 * in="query",
5559 * description="The assistant for the user.",
5560 * required=false,
5561 * @OA\Schema(
5562 * type="string"
5563 * )
5564 * ),
5565 * @OA\Parameter(
5566 * name="organization",
5567 * in="query",
5568 * description="The organization for the user.",
5569 * required=false,
5570 * @OA\Schema(
5571 * type="string"
5572 * )
5573 * ),
5574 * @OA\Parameter(
5575 * name="valedictory",
5576 * in="query",
5577 * description="The valedictory for the user.",
5578 * required=false,
5579 * @OA\Schema(
5580 * type="string"
5581 * )
5582 * ),
5583 * @OA\Parameter(
5584 * name="street",
5585 * in="query",
5586 * description="The street for the user.",
5587 * required=false,
5588 * @OA\Schema(
5589 * type="string"
5590 * )
5591 * ),
5592 * @OA\Parameter(
5593 * name="streetb",
5594 * in="query",
5595 * description="The street (line 2) for the user.",
5596 * required=false,
5597 * @OA\Schema(
5598 * type="string"
5599 * )
5600 * ),
5601 * @OA\Parameter(
5602 * name="city",
5603 * in="query",
5604 * description="The city for the user.",
5605 * required=false,
5606 * @OA\Schema(
5607 * type="string"
5608 * )
5609 * ),
5610 * @OA\Parameter(
5611 * name="state",
5612 * in="query",
5613 * description="The state for the user.",
5614 * required=false,
5615 * @OA\Schema(
5616 * type="string"
5617 * )
5618 * ),
5619 * @OA\Parameter(
5620 * name="zip",
5621 * in="query",
5622 * description="The zip for the user.",
5623 * required=false,
5624 * @OA\Schema(
5625 * type="string"
5626 * )
5627 * ),
5628 * @OA\Parameter(
5629 * name="phone",
5630 * in="query",
5631 * description="The phone for the user.",
5632 * required=false,
5633 * @OA\Schema(
5634 * type="string"
5635 * )
5636 * ),
5637 * @OA\Parameter(
5638 * name="fax",
5639 * in="query",
5640 * description="The fax for the user.",
5641 * required=false,
5642 * @OA\Schema(
5643 * type="string"
5644 * )
5645 * ),
5646 * @OA\Parameter(
5647 * name="phonew1",
5648 * in="query",
5649 * description="The phonew1 for the user.",
5650 * required=false,
5651 * @OA\Schema(
5652 * type="string"
5653 * )
5654 * ),
5655 * @OA\Parameter(
5656 * name="phonecell",
5657 * in="query",
5658 * description="The phonecell for the user.",
5659 * required=false,
5660 * @OA\Schema(
5661 * type="string"
5662 * )
5663 * ),
5664 * @OA\Parameter(
5665 * name="notes",
5666 * in="query",
5667 * description="The notes for the user.",
5668 * required=false,
5669 * @OA\Schema(
5670 * type="string"
5671 * )
5672 * ),
5673 * @OA\Parameter(
5674 * name="state_license_number2",
5675 * in="query",
5676 * description="The state license number for the user.",
5677 * required=false,
5678 * @OA\Schema(
5679 * type="string"
5680 * )
5681 * ),
5682 * @OA\Parameter(
5683 * name="username",
5684 * in="query",
5685 * description="The username for the user.",
5686 * required=false,
5687 * @OA\Schema(
5688 * type="string"
5689 * )
5690 * ),
5691 * @OA\Response(
5692 * response="200",
5693 * ref="#/components/responses/standard"
5694 * ),
5695 * @OA\Response(
5696 * response="400",
5697 * ref="#/components/responses/badrequest"
5698 * ),
5699 * @OA\Response(
5700 * response="401",
5701 * ref="#/components/responses/unauthorized"
5702 * ),
5703 * security={{"openemr_auth":{}}}
5704 * )
5705 */
5706 "GET /api/user" => function () {
5707 RestConfig::authorization_check("admin", "users");
5708 $return = (new UserRestController())->getAll($_GET);
5709 RestConfig::apiLog($return);
5710 return $return;
5711 },
5712
5713 /**
5714 * @OA\Get(
5715 * path="/api/user/{uuid}",
5716 * description="Retrieves a single user by their uuid",
5717 * tags={"standard"},
5718 * @OA\Parameter(
5719 * name="uuid",
5720 * in="path",
5721 * description="The uuid for the user.",
5722 * required=true,
5723 * @OA\Schema(
5724 * type="string"
5725 * )
5726 * ),
5727 * @OA\Response(
5728 * response="200",
5729 * ref="#/components/responses/standard"
5730 * ),
5731 * @OA\Response(
5732 * response="400",
5733 * ref="#/components/responses/badrequest"
5734 * ),
5735 * @OA\Response(
5736 * response="401",
5737 * ref="#/components/responses/unauthorized"
5738 * ),
5739 * security={{"openemr_auth":{}}}
5740 * )
5741 */
5742 "GET /api/user/:uuid" => function ($uuid) {
5743 RestConfig::authorization_check("admin", "users");
5744 $return = (new UserRestController())->getOne($uuid);
5745 RestConfig::apiLog($return);
5746 return $return;
5747 },
5748
5749 /**
5750 * @OA\Get(
5751 * path="/api/version",
5752 * description="Retrieves the OpenEMR version information",
5753 * tags={"standard"},
5754 * @OA\Response(
5755 * response="200",
5756 * ref="#/components/responses/standard"
5757 * ),
5758 * @OA\Response(
5759 * response="400",
5760 * ref="#/components/responses/badrequest"
5761 * ),
5762 * @OA\Response(
5763 * response="401",
5764 * ref="#/components/responses/unauthorized"
5765 * ),
5766 * security={{"openemr_auth":{}}}
5767 * )
5768 */
5769 "GET /api/version" => function () {
5770 $return = (new VersionRestController())->getOne();
5771 RestConfig::apiLog($return);
5772 return $return;
5773 },
5774
5775 /**
5776 * @OA\Get(
5777 * path="/api/product",
5778 * description="Retrieves the OpenEMR product registration information",
5779 * tags={"standard"},
5780 * @OA\Response(
5781 * response="200",
5782 * ref="#/components/responses/standard"
5783 * ),
5784 * @OA\Response(
5785 * response="400",
5786 * ref="#/components/responses/badrequest"
5787 * ),
5788 * @OA\Response(
5789 * response="401",
5790 * ref="#/components/responses/unauthorized"
5791 * ),
5792 * security={{"openemr_auth":{}}}
5793 * )
5794 */
5795 "GET /api/product" => function () {
5796 $return = (new ProductRegistrationRestController())->getOne();
5797 RestConfig::apiLog($return);
5798 return $return;
5799 },
5800
5801 /**
5802 * @OA\Get(
5803 * path="/api/insurance_company",
5804 * description="Retrieves all insurance companies",
5805 * tags={"standard"},
5806 * @OA\Response(
5807 * response="200",
5808 * ref="#/components/responses/standard"
5809 * ),
5810 * @OA\Response(
5811 * response="400",
5812 * ref="#/components/responses/badrequest"
5813 * ),
5814 * @OA\Response(
5815 * response="401",
5816 * ref="#/components/responses/unauthorized"
5817 * ),
5818 * security={{"openemr_auth":{}}}
5819 * )
5820 */
5821 "GET /api/insurance_company" => function () {
5822 $return = (new InsuranceCompanyRestController())->getAll();
5823 RestConfig::apiLog($return);
5824 return $return;
5825 },
5826
5827 /**
5828 * @OA\Get(
5829 * path="/api/insurance_company/{iid}",
5830 * description="Retrieves insurance company",
5831 * tags={"standard"},
5832 * @OA\Parameter(
5833 * name="iid",
5834 * in="path",
5835 * description="The id of the insurance company.",
5836 * required=true,
5837 * @OA\Schema(
5838 * type="string"
5839 * )
5840 * ),
5841 * @OA\Response(
5842 * response="200",
5843 * ref="#/components/responses/standard"
5844 * ),
5845 * @OA\Response(
5846 * response="400",
5847 * ref="#/components/responses/badrequest"
5848 * ),
5849 * @OA\Response(
5850 * response="401",
5851 * ref="#/components/responses/unauthorized"
5852 * ),
5853 * security={{"openemr_auth":{}}}
5854 * )
5855 */
5856 "GET /api/insurance_company/:iid" => function ($iid) {
5857 $return = (new InsuranceCompanyRestController())->getOne($iid);
5858 RestConfig::apiLog($return);
5859 return $return;
5860 },
5861
5862 /**
5863 * @OA\Get(
5864 * path="/api/insurance_type",
5865 * description="Retrieves all insurance types",
5866 * tags={"standard"},
5867 * @OA\Response(
5868 * response="200",
5869 * ref="#/components/responses/standard"
5870 * ),
5871 * @OA\Response(
5872 * response="400",
5873 * ref="#/components/responses/badrequest"
5874 * ),
5875 * @OA\Response(
5876 * response="401",
5877 * ref="#/components/responses/unauthorized"
5878 * ),
5879 * security={{"openemr_auth":{}}}
5880 * )
5881 */
5882 "GET /api/insurance_type" => function () {
5883 $return = (new InsuranceCompanyRestController())->getInsuranceTypes();
5884 RestConfig::apiLog($return);
5885 return $return;
5886 },
5887
5888 /**
5889 * Schema for the insurance_company request
5890 *
5891 * @OA\Schema(
5892 * schema="api_insurance_company_request",
5893 * @OA\Property(
5894 * property="name",
5895 * description="The name of insurance company.",
5896 * type="string"
5897 * ),
5898 * @OA\Property(
5899 * property="attn",
5900 * description="The attn of insurance company.",
5901 * type="string"
5902 * ),
5903 * @OA\Property(
5904 * property="cms_id",
5905 * description="The cms id of insurance company.",
5906 * type="string"
5907 * ),
5908 * @OA\Property(
5909 * property="ins_type_code",
5910 * description="The insurance type code of insurance company. The insurance type code can be found by inspecting the route at (/api/insurance_type).",
5911 * type="string"
5912 * ),
5913 * @OA\Property(
5914 * property="x12_receiver_id",
5915 * description="The x12 receiver id of insurance company.",
5916 * type="string"
5917 * ),
5918 * @OA\Property(
5919 * property="x12_default_partner_id",
5920 * description="The x12 default partner id of insurance company.",
5921 * type="string"
5922 * ),
5923 * @OA\Property(
5924 * property="alt_cms_id",
5925 * description="The alternate cms id of insurance company.",
5926 * type="string"
5927 * ),
5928 * @OA\Property(
5929 * property="line1",
5930 * description="The line1 address of insurance company.",
5931 * type="string"
5932 * ),
5933 * @OA\Property(
5934 * property="line2",
5935 * description="The line2 address of insurance company.",
5936 * type="string"
5937 * ),
5938 * @OA\Property(
5939 * property="city",
5940 * description="The city of insurance company.",
5941 * type="string"
5942 * ),
5943 * @OA\Property(
5944 * property="state",
5945 * description="The state of insurance company.",
5946 * type="string"
5947 * ),
5948 * @OA\Property(
5949 * property="zip",
5950 * description="The zip of insurance company.",
5951 * type="string"
5952 * ),
5953 * @OA\Property(
5954 * property="country",
5955 * description="The country of insurance company.",
5956 * type="string"
5957 * ),
5958 * required={"name"},
5959 * example={
5960 * "name": "Cool Insurance Company",
5961 * "attn": null,
5962 * "cms_id": null,
5963 * "ins_type_code": "2",
5964 * "x12_receiver_id": null,
5965 * "x12_default_partner_id": null,
5966 * "alt_cms_id": "",
5967 * "line1": "123 Cool Lane",
5968 * "line2": "Suite 123",
5969 * "city": "Cooltown",
5970 * "state": "CA",
5971 * "zip": "12245",
5972 * "country": "USA"
5973 * }
5974 * )
5975 */
5976 /**
5977 * @OA\Post(
5978 * path="/api/insurance_company",
5979 * description="Submits a new insurance company",
5980 * tags={"standard"},
5981 * @OA\RequestBody(
5982 * required=true,
5983 * @OA\MediaType(
5984 * mediaType="application/json",
5985 * @OA\Schema(ref="#/components/schemas/api_insurance_company_request")
5986 * )
5987 * ),
5988 * @OA\Response(
5989 * response="200",
5990 * ref="#/components/responses/standard"
5991 * ),
5992 * @OA\Response(
5993 * response="400",
5994 * ref="#/components/responses/badrequest"
5995 * ),
5996 * @OA\Response(
5997 * response="401",
5998 * ref="#/components/responses/unauthorized"
5999 * ),
6000 * security={{"openemr_auth":{}}}
6001 * )
6002 */
6003 "POST /api/insurance_company" => function () {
6004 $data = (array) (json_decode(file_get_contents("php://input")));
6005 $return = (new InsuranceCompanyRestController())->post($data);
6006 RestConfig::apiLog($return, $data);
6007 return $return;
6008 },
6009
6010 /**
6011 * @OA\Put(
6012 * path="/api/insurance_company/{iid}",
6013 * description="Edit a insurance company",
6014 * tags={"standard"},
6015 * @OA\Parameter(
6016 * name="iid",
6017 * in="path",
6018 * description="The id for the insurance company.",
6019 * required=true,
6020 * @OA\Schema(
6021 * type="string"
6022 * )
6023 * ),
6024 * @OA\RequestBody(
6025 * required=true,
6026 * @OA\MediaType(
6027 * mediaType="application/json",
6028 * @OA\Schema(ref="#/components/schemas/api_insurance_company_request")
6029 * )
6030 * ),
6031 * @OA\Response(
6032 * response="200",
6033 * ref="#/components/responses/standard"
6034 * ),
6035 * @OA\Response(
6036 * response="400",
6037 * ref="#/components/responses/badrequest"
6038 * ),
6039 * @OA\Response(
6040 * response="401",
6041 * ref="#/components/responses/unauthorized"
6042 * ),
6043 * security={{"openemr_auth":{}}}
6044 * )
6045 */
6046 "PUT /api/insurance_company/:iid" => function ($iid) {
6047 $data = (array) (json_decode(file_get_contents("php://input")));
6048 $return = (new InsuranceCompanyRestController())->put($iid, $data);
6049 RestConfig::apiLog($return, $data);
6050 return $return;
6051 },
6052
6053 /**
6054 * @OA\Post(
6055 * path="/api/patient/{pid}/document",
6056 * description="Submits a new patient document",
6057 * tags={"standard"},
6058 * @OA\Parameter(
6059 * name="pid",
6060 * in="path",
6061 * description="The pid for the patient.",
6062 * required=true,
6063 * @OA\Schema(
6064 * type="string"
6065 * )
6066 * ),
6067 * @OA\Parameter(
6068 * name="path",
6069 * in="query",
6070 * description="The category of the document.",
6071 * required=true,
6072 * @OA\Schema(
6073 * type="string"
6074 * )
6075 * ),
6076 * @OA\RequestBody(
6077 * required=true,
6078 * @OA\MediaType(
6079 * mediaType="multipart/form-data",
6080 * @OA\Schema(
6081 * @OA\Property(
6082 * property="document",
6083 * description="document",
6084 * type="string",
6085 * format="binary"
6086 * ),
6087 * ),
6088 * ),
6089 * ),
6090 * @OA\Response(
6091 * response="200",
6092 * ref="#/components/responses/standard"
6093 * ),
6094 * @OA\Response(
6095 * response="400",
6096 * ref="#/components/responses/badrequest"
6097 * ),
6098 * @OA\Response(
6099 * response="401",
6100 * ref="#/components/responses/unauthorized"
6101 * ),
6102 * security={{"openemr_auth":{}}}
6103 * )
6104 */
6105 "POST /api/patient/:pid/document" => function ($pid) {
6106 $return = (new DocumentRestController())->postWithPath($pid, $_GET['path'], $_FILES['document']);
6107 RestConfig::apiLog($return);
6108 return $return;
6109 },
6110
6111 /**
6112 * @OA\Get(
6113 * path="/api/patient/{pid}/document",
6114 * description="Retrieves all file information of documents from a category for a patient",
6115 * tags={"standard"},
6116 * @OA\Parameter(
6117 * name="pid",
6118 * in="path",
6119 * description="The pid for the patient.",
6120 * required=true,
6121 * @OA\Schema(
6122 * type="string"
6123 * )
6124 * ),
6125 * @OA\Parameter(
6126 * name="path",
6127 * in="query",
6128 * description="The category of the documents.",
6129 * required=true,
6130 * @OA\Schema(
6131 * type="string"
6132 * )
6133 * ),
6134 * @OA\Response(
6135 * response="200",
6136 * ref="#/components/responses/standard"
6137 * ),
6138 * @OA\Response(
6139 * response="400",
6140 * ref="#/components/responses/badrequest"
6141 * ),
6142 * @OA\Response(
6143 * response="401",
6144 * ref="#/components/responses/unauthorized"
6145 * ),
6146 * security={{"openemr_auth":{}}}
6147 * )
6148 */
6149 "GET /api/patient/:pid/document" => function ($pid) {
6150 $return = (new DocumentRestController())->getAllAtPath($pid, $_GET['path']);
6151 RestConfig::apiLog($return);
6152 return $return;
6153 },
6154
6155 /**
6156 * @OA\Get(
6157 * path="/api/patient/{pid}/document/{did}",
6158 * description="Retrieves a document for a patient",
6159 * tags={"standard"},
6160 * @OA\Parameter(
6161 * name="pid",
6162 * in="path",
6163 * description="The pid for the patient.",
6164 * required=true,
6165 * @OA\Schema(
6166 * type="string"
6167 * )
6168 * ),
6169 * @OA\Parameter(
6170 * name="did",
6171 * in="path",
6172 * description="The id for the patient document.",
6173 * required=true,
6174 * @OA\Schema(
6175 * type="string"
6176 * )
6177 * ),
6178 * @OA\Response(
6179 * response="200",
6180 * ref="#/components/responses/standard"
6181 * ),
6182 * @OA\Response(
6183 * response="400",
6184 * ref="#/components/responses/badrequest"
6185 * ),
6186 * @OA\Response(
6187 * response="401",
6188 * ref="#/components/responses/unauthorized"
6189 * ),
6190 * security={{"openemr_auth":{}}}
6191 * )
6192 */
6193 "GET /api/patient/:pid/document/:did" => function ($pid, $did) {
6194 $return = (new DocumentRestController())->downloadFile($pid, $did);
6195 RestConfig::apiLog($return);
6196 return $return;
6197 },
6198
6199 /**
6200 * @OA\Get(
6201 * path="/api/patient/{puuid}/employer",
6202 * description="Retrieves all the employer data for a patient. Returns an array of the employer data for the patient.",
6203 * tags={"standard"},
6204 * @OA\Parameter(
6205 * name="pid",
6206 * in="path",
6207 * description="The uuid for the patient.",
6208 * required=true,
6209 * @OA\Schema(
6210 * type="string"
6211 * )
6212 * ),
6213 * @OA\Response(
6214 * response="200",
6215 * ref="#/components/responses/standard"
6216 * ),
6217 * @OA\Response(
6218 * response="400",
6219 * ref="#/components/responses/badrequest"
6220 * ),
6221 * @OA\Response(
6222 * response="401",
6223 * ref="#/components/responses/unauthorized"
6224 * ),
6225 * security={{"openemr_auth":{}}}
6226 * )
6227 */
6228 "GET /api/patient/:puuid/employer" => function ($puuid, HttpRestRequest $request) {
6229 $searchParams = $request->getQueryParams();
6230 $searchParams['puuid'] = $puuid;
6231 if ($request->isPatientRequest()) {
6232 $searchParams['puuid'] = $request->getPatientUUIDString();
6233 }
6234 $return = (new EmployerRestController())->getAll($searchParams);
6235 RestConfig::apiLog($return);
6236 return $return;
6237 },
6238
6239 /**
6240 * @OA\Get(
6241 * path="/api/patient/{puuid}/insurance",
6242 * description="Retrieves all insurances for a patient",
6243 * tags={"standard"},
6244 * @OA\Parameter(
6245 * name="pid",
6246 * in="path",
6247 * description="The uuid for the patient.",
6248 * required=true,
6249 * @OA\Schema(
6250 * type="string"
6251 * )
6252 * ),
6253 * @OA\Response(
6254 * response="200",
6255 * ref="#/components/responses/standard"
6256 * ),
6257 * @OA\Response(
6258 * response="400",
6259 * ref="#/components/responses/badrequest"
6260 * ),
6261 * @OA\Response(
6262 * response="401",
6263 * ref="#/components/responses/unauthorized"
6264 * ),
6265 * security={{"openemr_auth":{}}}
6266 * )
6267 */
6268 "GET /api/patient/:puuid/insurance" => function ($puuid, HttpRestRequest $request) {
6269 $searchParams = $request->getQueryParams();
6270 $searchParams['puuid'] = $puuid;
6271 if ($request->isPatientRequest()) {
6272 $searchParams['puuid'] = $request->getPatientUUIDString();
6273 }
6274 $return = (new InsuranceRestController())->getAll($searchParams);
6275 RestConfig::apiLog($return);
6276 return $return;
6277 },
6278
6279 /**
6280 * @OA\Get(
6281 * path="/api/patient/{puuid}/insurance/$swap-insurance",
6282 * description="Updates the insurance for the passed in uuid to be a policy of type `type` and updates (if one exists) the current or most recent insurance for the passed in `type` for a patient to be the `type` of the insurance for the given `uuid`. Validations on the swap operation are performed to make sure the effective `date` of the src and target policies being swapped can be received in each given policy `type` as a policy `type` and `date` must together be unique per patient.",
6283 * tags={"standard"},
6284 * @OA\Parameter(
6285 * name="pid",
6286 * in="path",
6287 * description="The uuid for the patient.",
6288 * required=true,
6289 * @OA\Schema(
6290 * type="string"
6291 * )
6292 * ),
6293 * @OA\Parameter(
6294 * name="type",
6295 * in="query",
6296 * description="The type or category of OpenEMR insurance policy, 'primary', 'secondary', or 'tertiary'.",
6297 * required=true,
6298 * @OA\Schema(
6299 * type="string"
6300 * )
6301 * ),
6302 * @OA\Parameter(
6303 * name="uuid",
6304 * in="query",
6305 * description="The insurance uuid that will be swapped into the list of insurances for the type query parameter",
6306 * required=true,
6307 * @OA\Schema(
6308 * type="string"
6309 * )
6310 * ),
6311 * @OA\Response(
6312 * response="200",
6313 * ref="#/components/responses/standard"
6314 * ),
6315 * @OA\Response(
6316 * response="400",
6317 * ref="#/components/responses/badrequest"
6318 * ),
6319 * @OA\Response(
6320 * response="401",
6321 * ref="#/components/responses/unauthorized"
6322 * ),
6323 * security={{"openemr_auth":{}}}
6324 * )
6325 */
6326 'GET /api/patient/:puuid/insurance/$swap-insurance' => function ($puuid, HttpRestRequest $request) {
6327 if ($request->isPatientRequest()) {
6328 $puuid = $request->getPatientUUIDString();
6329 }
6330 $type = $request->getQueryParam('type');
6331 $insuranceUuid = $request->getQueryParam('uuid');
6332
6333 $return = (new InsuranceRestController())->operationSwapInsurance($puuid, $type, $insuranceUuid);
6334 RestConfig::apiLog($return);
6335 return $return;
6336 },
6337
6338 /**
6339 * @OA\Get(
6340 * path="/api/patient/{puuid}/insurance/{uuid}",
6341 * description="Retrieves all insurances for a patient",
6342 * tags={"standard"},
6343 * @OA\Parameter(
6344 * name="pid",
6345 * in="path",
6346 * description="The uuid for the patient.",
6347 * required=true,
6348 * @OA\Schema(
6349 * type="string"
6350 * )
6351 * ),
6352 * @OA\Response(
6353 * response="200",
6354 * ref="#/components/responses/standard"
6355 * ),
6356 * @OA\Response(
6357 * response="400",
6358 * ref="#/components/responses/badrequest"
6359 * ),
6360 * @OA\Response(
6361 * response="401",
6362 * ref="#/components/responses/unauthorized"
6363 * ),
6364 * security={{"openemr_auth":{}}}
6365 * )
6366 */
6367 "GET /api/patient/:puuid/insurance/:uuid" => function ($puuid, $uuid, HttpRestRequest $request) {
6368 if ($request->isPatientRequest()) {
6369 $puuid = $request->getPatientUUIDString();
6370 }
6371 $return = (new InsuranceRestController())->getOne($uuid, $puuid);
6372 RestConfig::apiLog($return);
6373 return $return;
6374 },
6375
6376 /**
6377 * Schema for the insurance request. Note the following additional validation checks on the request.
6378 * If the subscriber_relationship value is of type 'self' then the subscriber_fname and subscriber_lname fields
6379 * must match the patient's first and last name or a patient's previous first and last name.
6380 *
6381 * If the subscriber_relationship value is of type 'self' then the subscriber_ss field must match the patient's
6382 * social security number.
6383 *
6384 * If the subscriber_relationship value is not of type 'self' then the subscriber_ss field MUST not be the current patient's social security number.
6385 *
6386 * If the system's global configuration permits only a single insurance type option then any insurance rquest where the type is NOT 'primary' will fail.
6387 *
6388 * An insurance is considered the current policy for the policy type if the policy date_end field is null. Only one of these records per policy type can exist for a patient.
6389 * @OA\Schema(
6390 * schema="api_insurance_request",
6391 * @OA\Property(
6392 * property="provider",
6393 * description="The insurance company id.",
6394 * type="string"
6395 * ),
6396 * @OA\Property(
6397 * property="plan_name",
6398 * description="The plan name of insurance. (2-255 characters)",
6399 * type="string"
6400 * ),
6401 * @OA\Property(
6402 * property="policy_number",
6403 * description="The policy number of insurance. (2-255 characters)",
6404 * type="string"
6405 * ),
6406 * @OA\Property(
6407 * property="group_number",
6408 * description="The group number of insurance.(2-255 characters)",
6409 * type="string"
6410 * ),
6411 * @OA\Property(
6412 * property="subscriber_lname",
6413 * description="The subscriber last name of insurance.(2-255 characters).",
6414 * type="string"
6415 * ),
6416 * @OA\Property(
6417 * property="subscriber_mname",
6418 * description="The subscriber middle name of insurance.",
6419 * type="string"
6420 * ),
6421 * @OA\Property(
6422 * property="subscriber_fname",
6423 * description="The subscriber first name of insurance.",
6424 * type="string"
6425 * ),
6426 * @OA\Property(
6427 * property="subscriber_relationship",
6428 * description="The subscriber relationship of insurance. `subscriber_relationship` can be found by querying `resource=/api/list/subscriber_relationship`",
6429 * type="string"
6430 * ),
6431 * @OA\Property(
6432 * property="subscriber_ss",
6433 * description="The subscriber ss number of insurance.",
6434 * type="string"
6435 * ),
6436 * @OA\Property(
6437 * property="subscriber_DOB",
6438 * description="The subscriber DOB of insurance.",
6439 * type="string"
6440 * ),
6441 * @OA\Property(
6442 * property="subscriber_street",
6443 * description="The subscriber street address of insurance.",
6444 * type="string"
6445 * ),
6446 * @OA\Property(
6447 * property="subscriber_postal_code",
6448 * description="The subscriber postal code of insurance.",
6449 * type="string"
6450 * ),
6451 * @OA\Property(
6452 * property="subscriber_city",
6453 * description="The subscriber city of insurance.",
6454 * type="string"
6455 * ),
6456 * @OA\Property(
6457 * property="subscriber_state",
6458 * description="The subscriber state of insurance. `state` can be found by querying `resource=/api/list/state`",
6459 * type="string"
6460 * ),
6461 * @OA\Property(
6462 * property="subscriber_country",
6463 * description="The subscriber country of insurance. `country` can be found by querying `resource=/api/list/country`",
6464 * type="string"
6465 * ),
6466 * @OA\Property(
6467 * property="subscriber_phone",
6468 * description="The subscriber phone of insurance.",
6469 * type="string"
6470 * ),
6471 * @OA\Property(
6472 * property="subscriber_employer",
6473 * description="The subscriber employer of insurance.",
6474 * type="string"
6475 * ),
6476 * @OA\Property(
6477 * property="subscriber_employer_street",
6478 * description="The subscriber employer street of insurance.",
6479 * type="string"
6480 * ),
6481 * @OA\Property(
6482 * property="subscriber_employer_postal_code",
6483 * description="The subscriber employer postal code of insurance.",
6484 * type="string"
6485 * ),
6486 * @OA\Property(
6487 * property="subscriber_employer_state",
6488 * description="The subscriber employer state of insurance.",
6489 * type="string"
6490 * ),
6491 * @OA\Property(
6492 * property="subscriber_employer_country",
6493 * description="The subscriber employer country of insurance.",
6494 * type="string"
6495 * ),
6496 * @OA\Property(
6497 * property="subscriber_employer_city",
6498 * description="The subscriber employer city of insurance.",
6499 * type="string"
6500 * ),
6501 * @OA\Property(
6502 * property="copay",
6503 * description="The copay of insurance.",
6504 * type="string"
6505 * ),
6506 * @OA\Property(
6507 * property="date",
6508 * description="The effective date of insurance in YYYY-MM-DD format. This value cannot be after the date_end property and cannot be the same date as any other insurance policy for the same insurance type ('primary, 'secondary', etc).",
6509 * type="string"
6510 * ),
6511 * @OA\Property(
6512 * property="date_end",
6513 * description="The effective end date of insurance in YYYY-MM-DD format. This value cannot be before the date property. If it is null then this policy is the current policy for this policy type for the patient. There can only be one current policy per type and the request will fail if there is already a current policy for this type.",
6514 * type="string"
6515 * ),
6516 * @OA\Property(
6517 * property="subscriber_sex",
6518 * description="The subscriber sex of insurance.",
6519 * type="string"
6520 * ),
6521 * @OA\Property(
6522 * property="accept_assignment",
6523 * description="The accept_assignment of insurance.",
6524 * type="string"
6525 * ),
6526 * @OA\Property(
6527 * property="policy_type",
6528 * description="The 837p list of policy types for an insurance. See src/Billing/InsurancePolicyType.php for the list of valid values.",
6529 * type="string"
6530 * ),
6531 * @OA\Property(
6532 * property="type",
6533 * description="The type or category of OpenEMR insurance policy, 'primary', 'secondary', or 'tertiary'. If this field is missing it will default to 'primary'.",
6534 * type="string"
6535 * ),
6536 * required={"provider", "policy_number", "subscriber_fname", "subscriber_lname", "subscriber_relationship", "subscriber_ss", "subscriber_DOB", "subscriber_street", "subscriber_postal_code", "subscriber_city", "subscriber_state", "subscriber_sex", "accept_assignment"},
6537 * example={
6538 * "provider": "33",
6539 * "plan_name": "Some Plan",
6540 * "policy_number": "12345",
6541 * "group_number": "252412",
6542 * "subscriber_lname": "Tester",
6543 * "subscriber_mname": "Xi",
6544 * "subscriber_fname": "Foo",
6545 * "subscriber_relationship": "other",
6546 * "subscriber_ss": "234231234",
6547 * "subscriber_DOB": "2018-10-03",
6548 * "subscriber_street": "183 Cool St",
6549 * "subscriber_postal_code": "23418",
6550 * "subscriber_city": "Cooltown",
6551 * "subscriber_state": "AZ",
6552 * "subscriber_country": "USA",
6553 * "subscriber_phone": "234-598-2123",
6554 * "subscriber_employer": "Some Employer",
6555 * "subscriber_employer_street": "123 Heather Lane",
6556 * "subscriber_employer_postal_code": "23415",
6557 * "subscriber_employer_state": "AZ",
6558 * "subscriber_employer_country": "USA",
6559 * "subscriber_employer_city": "Cooltown",
6560 * "copay": "35",
6561 * "date": "2018-10-15",
6562 * "subscriber_sex": "Female",
6563 * "accept_assignment": "TRUE",
6564 * "policy_type": "a",
6565 * "type": "primary"
6566 * }
6567 * )
6568 */
6569
6570 /**
6571 * @OA\Put(
6572 * path="/api/patient/{puuid}/insurance/{insuranceUuid}",
6573 * description="Edit a specific patient insurance policy. Requires the patients/demo/write ACL to call. This method is the preferred method for updating a patient insurance policy. The {insuranceId} can be found by querying /api/patient/{pid}/insurance",
6574 * tags={"standard"},
6575 * @OA\Parameter(
6576 * name="puuid",
6577 * in="path",
6578 * description="The uuid for the patient.",
6579 * required=true,
6580 * @OA\Schema(
6581 * type="string"
6582 * )
6583 * ),
6584 * @OA\Parameter(
6585 * name="insuranceUuid",
6586 * in="path",
6587 * description="The insurance policy uuid for the patient.",
6588 * required=true,
6589 * @OA\Schema(
6590 * type="string"
6591 * )
6592 * ),
6593 * @OA\RequestBody(
6594 * required=true,
6595 * @OA\MediaType(
6596 * mediaType="application/json",
6597 * @OA\Schema(ref="#/components/schemas/api_insurance_request")
6598 * )
6599 * ),
6600 * @OA\Response(
6601 * response="200",
6602 * ref="#/components/responses/standard"
6603 * ),
6604 * @OA\Response(
6605 * response="400",
6606 * ref="#/components/responses/badrequest"
6607 * ),
6608 * @OA\Response(
6609 * response="401",
6610 * ref="#/components/responses/unauthorized"
6611 * ),
6612 * security={{"openemr_auth":{}}}
6613 * )
6614 */
6615 "PUT /api/patient/:puuid/insurance/:insuranceUuid" => function ($puuid, $insuranceUuid, HttpRestRequest $request) {
6616 RestConfig::authorization_check("patients", "demo", '', 'write');
6617 $data = (array) (json_decode(file_get_contents("php://input")));
6618 $return = (new InsuranceRestController())->put($puuid, $insuranceUuid, $data);
6619 RestConfig::apiLog($return, $data);
6620 return $return;
6621 },
6622
6623 /**
6624 * @OA\Post(
6625 * path="/api/patient/{puuid}/insurance",
6626 * description="Submits a new patient insurance.",
6627 * tags={"standard"},
6628 * @OA\Parameter(
6629 * name="puuid",
6630 * in="path",
6631 * description="The uuid for the patient.",
6632 * required=true,
6633 * @OA\Schema(
6634 * type="string"
6635 * )
6636 * ),
6637 * @OA\RequestBody(
6638 * required=true,
6639 * @OA\MediaType(
6640 * mediaType="application/json",
6641 * @OA\Schema(ref="#/components/schemas/api_insurance_request")
6642 * )
6643 * ),
6644 * @OA\Response(
6645 * response="200",
6646 * ref="#/components/responses/standard"
6647 * ),
6648 * @OA\Response(
6649 * response="400",
6650 * ref="#/components/responses/badrequest"
6651 * ),
6652 * @OA\Response(
6653 * response="401",
6654 * ref="#/components/responses/unauthorized"
6655 * ),
6656 * security={{"openemr_auth":{}}}
6657 * )
6658 */
6659 "POST /api/patient/:puuid/insurance" => function ($puuid) {
6660 RestConfig::authorization_check("patients", "demo", '', ['write','addonly']);
6661 $data = (array) (json_decode(file_get_contents("php://input")));
6662 $return = (new InsuranceRestController())->post($puuid, $data);
6663 RestConfig::apiLog($return, $data);
6664 return $return;
6665 },
6666 /**
6667 * Schema for the message request
6668 *
6669 * @OA\Schema(
6670 * schema="api_message_request",
6671 * @OA\Property(
6672 * property="body",
6673 * description="The body of message.",
6674 * type="string"
6675 * ),
6676 * @OA\Property(
6677 * property="groupname",
6678 * description="The group name (usually is 'Default').",
6679 * type="string"
6680 * ),
6681 * @OA\Property(
6682 * property="from",
6683 * description="The sender of the message.",
6684 * type="string"
6685 * ),
6686 * @OA\Property(
6687 * property="to",
6688 * description="The recipient of the message.",
6689 * type="string"
6690 * ),
6691 * @OA\Property(
6692 * property="title",
6693 * description="use an option from resource=/api/list/note_type",
6694 * type="string"
6695 * ),
6696 * @OA\Property(
6697 * property="message_status",
6698 * description="use an option from resource=/api/list/message_status",
6699 * type="string"
6700 * ),
6701 * required={"body", "groupname", "from", "to", "title", "message_status"},
6702 * example={
6703 * "body": "Test 456",
6704 * "groupname": "Default",
6705 * "from": "Matthew",
6706 * "to": "admin",
6707 * "title": "Other",
6708 * "message_status": "New"
6709 * }
6710 * )
6711 */
6712 /**
6713 * @OA\Post(
6714 * path="/api/patient/{pid}/message",
6715 * description="Submits a pnote message",
6716 * tags={"standard"},
6717 * @OA\Parameter(
6718 * name="pid",
6719 * in="path",
6720 * description="The id for the patient.",
6721 * required=true,
6722 * @OA\Schema(
6723 * type="string"
6724 * )
6725 * ),
6726 * @OA\RequestBody(
6727 * required=true,
6728 * @OA\MediaType(
6729 * mediaType="application/json",
6730 * @OA\Schema(ref="#/components/schemas/api_message_request")
6731 * )
6732 * ),
6733 * @OA\Response(
6734 * response="200",
6735 * ref="#/components/responses/standard"
6736 * ),
6737 * @OA\Response(
6738 * response="400",
6739 * ref="#/components/responses/badrequest"
6740 * ),
6741 * @OA\Response(
6742 * response="401",
6743 * ref="#/components/responses/unauthorized"
6744 * ),
6745 * security={{"openemr_auth":{}}}
6746 * )
6747 */
6748 "POST /api/patient/:pid/message" => function ($pid) {
6749 RestConfig::authorization_check("patients", "notes");
6750 $data = (array) (json_decode(file_get_contents("php://input")));
6751 $return = (new MessageRestController())->post($pid, $data);
6752 RestConfig::apiLog($return, $data);
6753 return $return;
6754 },
6755
6756 /**
6757 * @OA\Get(
6758 * path="/api/patient/{pid}/transaction",
6759 * description="Get Transactions for a patient",
6760 * tags={"standard"},
6761 * @OA\Parameter(
6762 * name="pid",
6763 * in="path",
6764 * description="The pid for the patient",
6765 * required=true,
6766 * @OA\Schema(
6767 * type="string"
6768 * )
6769 * ),
6770 * @OA\Response(
6771 * response="200",
6772 * ref="#/components/responses/standard"
6773 * ),
6774 * @OA\Response(
6775 * response="400",
6776 * ref="#/components/responses/badrequest"
6777 * ),
6778 * @OA\Response(
6779 * response="401",
6780 * ref="#/components/responses/unauthorized"
6781 * ),
6782 * security={{"openemr_auth":{}}}
6783 * )
6784 */
6785
6786 "GET /api/patient/:pid/transaction" => function ($pid) {
6787 RestConfig::authorization_check("patients", "trans");
6788 $cont = new TransactionRestController();
6789 $return = (new TransactionRestController())->GetPatientTransactions($pid);
6790 RestConfig::apiLog($return);
6791 return $return;
6792 },
6793
6794 /**
6795 * Schema for the transaction request
6796 *
6797 * @OA\Schema(
6798 * schema="api_transaction_request",
6799 * @OA\Property(
6800 * property="message",
6801 * description="The message of the transaction.",
6802 * type="string"
6803 * ),
6804 * @OA\Property(
6805 * property="type",
6806 * description="The type of transaction. Use an option from resource=/api/transaction_type",
6807 * type="string"
6808 * ),
6809 * @OA\Property(
6810 * property="groupname",
6811 * description="The group name (usually is 'Default').",
6812 * type="string"
6813 * ),
6814 * @OA\Property(
6815 * property="referByNpi",
6816 * description="NPI of the person creating the referral.",
6817 * type="string"
6818 * ),
6819 * @OA\Property(
6820 * property="referToNpi",
6821 * description="NPI of the person getting the referral.",
6822 * type="string"
6823 * ),
6824 * @OA\Property(
6825 * property="referDiagnosis",
6826 * description="The referral diagnosis.",
6827 * type="string"
6828 * ),
6829 * @OA\Property(
6830 * property="riskLevel",
6831 * description="The risk level. (Low, Medium, High)",
6832 * type="string"
6833 * ),
6834 * @OA\Property(
6835 * property="includeVitals",
6836 * description="Are vitals included (0,1)",
6837 * type="string"
6838 * ),
6839 * @OA\Property(
6840 * property="referralDate",
6841 * description="The date of the referral",
6842 * type="string"
6843 * ),
6844 * @OA\Property(
6845 * property="authorization",
6846 * description="The authorization for the referral",
6847 * type="string"
6848 * ),
6849 * @OA\Property(
6850 * property="visits",
6851 * description="The number of vists for the referral",
6852 * type="string"
6853 * ),
6854 * @OA\Property(
6855 * property="validFrom",
6856 * description="The date the referral is valid from",
6857 * type="string"
6858 * ),
6859 * @OA\Property(
6860 * property="validThrough",
6861 * description="The date the referral is valid through",
6862 * type="string"
6863 * ),
6864 * required={"message", "groupname", "title"},
6865 * example={
6866 * "message": "Message",
6867 * "type": "LBTref",
6868 * "groupname": "Default",
6869 * "referByNpi":"9999999999",
6870 * "referToNpi":"9999999999",
6871 * "referDiagnosis":"Diag 1",
6872 * "riskLevel":"Low",
6873 * "includeVitals":"1",
6874 * "referralDate":"2022-01-01",
6875 * "authorization":"Auth_123",
6876 * "visits": "1",
6877 * "validFrom": "2022-01-02",
6878 * "validThrough": "2022-01-03",
6879 * "body": "Reason 1"
6880 * }
6881 * )
6882 */
6883 /**
6884 * @OA\Post(
6885 * path="/api/patient/{pid}/transaction",
6886 * description="Submits a transaction",
6887 * tags={"standard"},
6888 * @OA\Parameter(
6889 * name="pid",
6890 * in="path",
6891 * description="The pid for the patient.",
6892 * required=true,
6893 * @OA\Schema(
6894 * type="string"
6895 * )
6896 * ),
6897 * @OA\RequestBody(
6898 * required=true,
6899 * @OA\MediaType(
6900 * mediaType="application/json",
6901 * @OA\Schema(ref="#/components/schemas/api_transaction_request")
6902 * )
6903 * ),
6904 * @OA\Response(
6905 * response="200",
6906 * ref="#/components/responses/standard"
6907 * ),
6908 * @OA\Response(
6909 * response="400",
6910 * ref="#/components/responses/badrequest"
6911 * ),
6912 * @OA\Response(
6913 * response="401",
6914 * ref="#/components/responses/unauthorized"
6915 * ),
6916 * security={{"openemr_auth":{}}}
6917 * )
6918 */
6919 "POST /api/patient/:pid/transaction" => function ($pid) {
6920 RestConfig::authorization_check("patients", "trans");
6921 $data = (array) (json_decode(file_get_contents("php://input")));
6922 $return = (new TransactionRestController())->CreateTransaction($pid, $data);
6923 RestConfig::apiLog($return, $data);
6924 return $return;
6925 },
6926
6927 /**
6928 * @OA\PUT(
6929 * path="/api/transaction/{tid}",
6930 * description="Updates a transaction",
6931 * tags={"standard"},
6932 * @OA\Parameter(
6933 * name="tid",
6934 * in="path",
6935 * description="The id for the transaction.",
6936 * required=true,
6937 * @OA\Schema(
6938 * type="string"
6939 * )
6940 * ),
6941 * @OA\RequestBody(
6942 * required=true,
6943 * @OA\MediaType(
6944 * mediaType="application/json",
6945 * @OA\Schema(ref="#/components/schemas/api_transaction_request")
6946 * )
6947 * ),
6948 * @OA\Response(
6949 * response="200",
6950 * ref="#/components/responses/standard"
6951 * ),
6952 * @OA\Response(
6953 * response="400",
6954 * ref="#/components/responses/badrequest"
6955 * ),
6956 * @OA\Response(
6957 * response="401",
6958 * ref="#/components/responses/unauthorized"
6959 * ),
6960 * security={{"openemr_auth":{}}}
6961 * )
6962 */
6963 "PUT /api/transaction/:tid" => function ($tid) {
6964 RestConfig::authorization_check("patients", "trans");
6965 $data = (array) (json_decode(file_get_contents("php://input")));
6966 $return = (new TransactionRestController())->UpdateTransaction($tid, $data);
6967 RestConfig::apiLog($return, $data);
6968 return $return;
6969 },
6970
6971 /**
6972 * @OA\Put(
6973 * path="/api/patient/{pid}/message/{mid}",
6974 * description="Edit a pnote message",
6975 * tags={"standard"},
6976 * @OA\Parameter(
6977 * name="pid",
6978 * in="path",
6979 * description="The id for the patient.",
6980 * required=true,
6981 * @OA\Schema(
6982 * type="string"
6983 * )
6984 * ),
6985 * @OA\Parameter(
6986 * name="mid",
6987 * in="path",
6988 * description="The id for the pnote message.",
6989 * required=true,
6990 * @OA\Schema(
6991 * type="string"
6992 * )
6993 * ),
6994 * @OA\RequestBody(
6995 * required=true,
6996 * @OA\MediaType(
6997 * mediaType="application/json",
6998 * @OA\Schema(ref="#/components/schemas/api_message_request")
6999 * )
7000 * ),
7001 * @OA\Response(
7002 * response="200",
7003 * ref="#/components/responses/standard"
7004 * ),
7005 * @OA\Response(
7006 * response="400",
7007 * ref="#/components/responses/badrequest"
7008 * ),
7009 * @OA\Response(
7010 * response="401",
7011 * ref="#/components/responses/unauthorized"
7012 * ),
7013 * security={{"openemr_auth":{}}}
7014 * )
7015 */
7016 "PUT /api/patient/:pid/message/:mid" => function ($pid, $mid) {
7017 RestConfig::authorization_check("patients", "notes");
7018 $data = (array) (json_decode(file_get_contents("php://input")));
7019 $return = (new MessageRestController())->put($pid, $mid, $data);
7020 RestConfig::apiLog($return, $data);
7021 return $return;
7022 },
7023
7024 /**
7025 * @OA\Delete(
7026 * path="/api/patient/{pid}/message/{mid}",
7027 * description="Delete a pnote message",
7028 * tags={"standard"},
7029 * @OA\Parameter(
7030 * name="pid",
7031 * in="path",
7032 * description="The id for the patient.",
7033 * required=true,
7034 * @OA\Schema(
7035 * type="string"
7036 * )
7037 * ),
7038 * @OA\Parameter(
7039 * name="mid",
7040 * in="path",
7041 * description="The id for the pnote message.",
7042 * required=true,
7043 * @OA\Schema(
7044 * type="string"
7045 * )
7046 * ),
7047 * @OA\Response(
7048 * response="200",
7049 * ref="#/components/responses/standard"
7050 * ),
7051 * @OA\Response(
7052 * response="400",
7053 * ref="#/components/responses/badrequest"
7054 * ),
7055 * @OA\Response(
7056 * response="401",
7057 * ref="#/components/responses/unauthorized"
7058 * ),
7059 * security={{"openemr_auth":{}}}
7060 * )
7061 */
7062 "DELETE /api/patient/:pid/message/:mid" => function ($pid, $mid) {
7063 RestConfig::authorization_check("patients", "notes");
7064 $return = (new MessageRestController())->delete($pid, $mid);
7065 RestConfig::apiLog($return);
7066 return $return;
7067 },
7068
7069 /**
7070 * @OA\Get(
7071 * path="/api/immunization",
7072 * description="Retrieves a list of immunizations",
7073 * tags={"standard"},
7074 * @OA\Parameter(
7075 * name="patient_id",
7076 * in="query",
7077 * description="The pid for the patient.",
7078 * required=false,
7079 * @OA\Schema(
7080 * type="string"
7081 * )
7082 * ),
7083 * @OA\Parameter(
7084 * name="id",
7085 * in="query",
7086 * description="The id for the immunization.",
7087 * required=false,
7088 * @OA\Schema(
7089 * type="string"
7090 * )
7091 * ),
7092 * @OA\Parameter(
7093 * name="uuid",
7094 * in="query",
7095 * description="The uuid for the immunization.",
7096 * required=false,
7097 * @OA\Schema(
7098 * type="string"
7099 * )
7100 * ),
7101 * @OA\Parameter(
7102 * name="administered_date",
7103 * in="query",
7104 * description="The administered date for the immunization.",
7105 * required=false,
7106 * @OA\Schema(
7107 * type="string"
7108 * )
7109 * ),
7110 * @OA\Parameter(
7111 * name="immunization_id",
7112 * in="query",
7113 * description="The immunization list_id for the immunization.",
7114 * required=false,
7115 * @OA\Schema(
7116 * type="string"
7117 * )
7118 * ),
7119 * @OA\Parameter(
7120 * name="cvx_code",
7121 * in="query",
7122 * description="The cvx code for the immunization.",
7123 * required=false,
7124 * @OA\Schema(
7125 * type="string"
7126 * )
7127 * ),
7128 * @OA\Parameter(
7129 * name="manufacturer",
7130 * in="query",
7131 * description="The manufacturer for the immunization.",
7132 * required=false,
7133 * @OA\Schema(
7134 * type="string"
7135 * )
7136 * ),
7137 * @OA\Parameter(
7138 * name="lot_number",
7139 * in="query",
7140 * description="The lot number for the immunization.",
7141 * required=false,
7142 * @OA\Schema(
7143 * type="string"
7144 * )
7145 * ),
7146 * @OA\Parameter(
7147 * name="administered_by_id",
7148 * in="query",
7149 * description="The administered by id for the immunization.",
7150 * required=false,
7151 * @OA\Schema(
7152 * type="string"
7153 * )
7154 * ),
7155 * @OA\Parameter(
7156 * name="administered_by",
7157 * in="query",
7158 * description="The administered by for the immunization.",
7159 * required=false,
7160 * @OA\Schema(
7161 * type="string"
7162 * )
7163 * ),
7164 * @OA\Parameter(
7165 * name="education_date",
7166 * in="query",
7167 * description="The education date for the immunization.",
7168 * required=false,
7169 * @OA\Schema(
7170 * type="string"
7171 * )
7172 * ),
7173 * @OA\Parameter(
7174 * name="vis_date",
7175 * in="query",
7176 * description="The vis date for the immunization.",
7177 * required=false,
7178 * @OA\Schema(
7179 * type="string"
7180 * )
7181 * ),
7182 * @OA\Parameter(
7183 * name="note",
7184 * in="query",
7185 * description="The note for the immunization.",
7186 * required=false,
7187 * @OA\Schema(
7188 * type="string"
7189 * )
7190 * ),
7191 * @OA\Parameter(
7192 * name="create_date",
7193 * in="query",
7194 * description="The create date for the immunization.",
7195 * required=false,
7196 * @OA\Schema(
7197 * type="string"
7198 * )
7199 * ),
7200 * @OA\Parameter(
7201 * name="update_date",
7202 * in="query",
7203 * description="The update date for the immunization.",
7204 * required=false,
7205 * @OA\Schema(
7206 * type="string"
7207 * )
7208 * ),
7209 * @OA\Parameter(
7210 * name="created_by",
7211 * in="query",
7212 * description="The created_by for the immunization.",
7213 * required=false,
7214 * @OA\Schema(
7215 * type="string"
7216 * )
7217 * ),
7218 * @OA\Parameter(
7219 * name="updated_by",
7220 * in="query",
7221 * description="The updated_by for the immunization.",
7222 * required=false,
7223 * @OA\Schema(
7224 * type="string"
7225 * )
7226 * ),
7227 * @OA\Parameter(
7228 * name="amount_administered",
7229 * in="query",
7230 * description="The amount administered for the immunization.",
7231 * required=false,
7232 * @OA\Schema(
7233 * type="string"
7234 * )
7235 * ),
7236 * @OA\Parameter(
7237 * name="amount_administered_unit",
7238 * in="query",
7239 * description="The amount administered unit for the immunization.",
7240 * required=false,
7241 * @OA\Schema(
7242 * type="string"
7243 * )
7244 * ),
7245 * @OA\Parameter(
7246 * name="expiration_date",
7247 * in="query",
7248 * description="The expiration date for the immunization.",
7249 * required=false,
7250 * @OA\Schema(
7251 * type="string"
7252 * )
7253 * ),
7254 * @OA\Parameter(
7255 * name="route",
7256 * in="query",
7257 * description="The route for the immunization.",
7258 * required=false,
7259 * @OA\Schema(
7260 * type="string"
7261 * )
7262 * ),
7263 * @OA\Parameter(
7264 * name="administration_site",
7265 * in="query",
7266 * description="The administration site for the immunization.",
7267 * required=false,
7268 * @OA\Schema(
7269 * type="string"
7270 * )
7271 * ),
7272 * @OA\Parameter(
7273 * name="added_erroneously",
7274 * in="query",
7275 * description="The added_erroneously for the immunization.",
7276 * required=false,
7277 * @OA\Schema(
7278 * type="string"
7279 * )
7280 * ),
7281 * @OA\Parameter(
7282 * name="external_id",
7283 * in="query",
7284 * description="The external_id for the immunization.",
7285 * required=false,
7286 * @OA\Schema(
7287 * type="string"
7288 * )
7289 * ),
7290 * @OA\Parameter(
7291 * name="completion_status",
7292 * in="query",
7293 * description="The completion status for the immunization.",
7294 * required=false,
7295 * @OA\Schema(
7296 * type="string"
7297 * )
7298 * ),
7299 * @OA\Parameter(
7300 * name="information_source",
7301 * in="query",
7302 * description="The information source for the immunization.",
7303 * required=false,
7304 * @OA\Schema(
7305 * type="string"
7306 * )
7307 * ),
7308 * @OA\Parameter(
7309 * name="refusal_reason",
7310 * in="query",
7311 * description="The refusal reason for the immunization.",
7312 * required=false,
7313 * @OA\Schema(
7314 * type="string"
7315 * )
7316 * ),
7317 * @OA\Parameter(
7318 * name="ordering_provider",
7319 * in="query",
7320 * description="The ordering provider for the immunization.",
7321 * required=false,
7322 * @OA\Schema(
7323 * type="string"
7324 * )
7325 * ),
7326 * @OA\Response(
7327 * response="200",
7328 * ref="#/components/responses/standard"
7329 * ),
7330 * @OA\Response(
7331 * response="400",
7332 * ref="#/components/responses/badrequest"
7333 * ),
7334 * @OA\Response(
7335 * response="401",
7336 * ref="#/components/responses/unauthorized"
7337 * ),
7338 * security={{"openemr_auth":{}}}
7339 * )
7340 */
7341 "GET /api/immunization" => function () {
7342 RestConfig::authorization_check("patients", "med");
7343 $return = (new ImmunizationRestController())->getAll($_GET);
7344 RestConfig::apiLog($return);
7345 return $return;
7346 },
7347
7348 /**
7349 * @OA\Get(
7350 * path="/api/immunization/{uuid}",
7351 * description="Retrieves a immunization",
7352 * tags={"standard"},
7353 * @OA\Parameter(
7354 * name="uuid",
7355 * in="path",
7356 * description="The uuid for the immunization.",
7357 * required=true,
7358 * @OA\Schema(
7359 * type="string"
7360 * )
7361 * ),
7362 * @OA\Response(
7363 * response="200",
7364 * ref="#/components/responses/standard"
7365 * ),
7366 * @OA\Response(
7367 * response="400",
7368 * ref="#/components/responses/badrequest"
7369 * ),
7370 * @OA\Response(
7371 * response="401",
7372 * ref="#/components/responses/unauthorized"
7373 * ),
7374 * security={{"openemr_auth":{}}}
7375 * )
7376 */
7377 "GET /api/immunization/:uuid" => function ($uuid) {
7378 RestConfig::authorization_check("patients", "med");
7379 $return = (new ImmunizationRestController())->getOne($uuid);
7380 RestConfig::apiLog($return);
7381 return $return;
7382 },
7383
7384 /**
7385 * @OA\Get(
7386 * path="/api/procedure",
7387 * description="Retrieves a list of all procedures",
7388 * tags={"standard"},
7389 * @OA\Response(
7390 * response="200",
7391 * ref="#/components/responses/standard"
7392 * ),
7393 * @OA\Response(
7394 * response="400",
7395 * ref="#/components/responses/badrequest"
7396 * ),
7397 * @OA\Response(
7398 * response="401",
7399 * ref="#/components/responses/unauthorized"
7400 * ),
7401 * security={{"openemr_auth":{}}}
7402 * )
7403 */
7404 "GET /api/procedure" => function () {
7405 RestConfig::authorization_check("patients", "med");
7406 $return = (new ProcedureRestController())->getAll();
7407 RestConfig::apiLog($return);
7408 return $return;
7409 },
7410
7411 /**
7412 * @OA\Get(
7413 * path="/api/procedure/{uuid}",
7414 * description="Retrieves a procedure",
7415 * tags={"standard"},
7416 * @OA\Parameter(
7417 * name="uuid",
7418 * in="path",
7419 * description="The uuid for the procedure.",
7420 * required=true,
7421 * @OA\Schema(
7422 * type="string"
7423 * )
7424 * ),
7425 * @OA\Response(
7426 * response="200",
7427 * ref="#/components/responses/standard"
7428 * ),
7429 * @OA\Response(
7430 * response="400",
7431 * ref="#/components/responses/badrequest"
7432 * ),
7433 * @OA\Response(
7434 * response="401",
7435 * ref="#/components/responses/unauthorized"
7436 * ),
7437 * security={{"openemr_auth":{}}}
7438 * )
7439 */
7440 "GET /api/procedure/:uuid" => function ($uuid) {
7441 RestConfig::authorization_check("patients", "med");
7442 $return = (new ProcedureRestController())->getOne($uuid);
7443 RestConfig::apiLog($return);
7444 return $return;
7445 },
7446
7447 /**
7448 * @OA\Get(
7449 * path="/api/drug",
7450 * description="Retrieves a list of all drugs",
7451 * tags={"standard"},
7452 * @OA\Response(
7453 * response="200",
7454 * ref="#/components/responses/standard"
7455 * ),
7456 * @OA\Response(
7457 * response="400",
7458 * ref="#/components/responses/badrequest"
7459 * ),
7460 * @OA\Response(
7461 * response="401",
7462 * ref="#/components/responses/unauthorized"
7463 * ),
7464 * security={{"openemr_auth":{}}}
7465 * )
7466 */
7467 "GET /api/drug" => function () {
7468 RestConfig::authorization_check("patients", "med");
7469 $return = (new DrugRestController())->getAll();
7470 RestConfig::apiLog($return);
7471 return $return;
7472 },
7473
7474 /**
7475 * @OA\Get(
7476 * path="/api/drug/{uuid}",
7477 * description="Retrieves a drug",
7478 * tags={"standard"},
7479 * @OA\Parameter(
7480 * name="uuid",
7481 * in="path",
7482 * description="The uuid for the drug.",
7483 * required=true,
7484 * @OA\Schema(
7485 * type="string"
7486 * )
7487 * ),
7488 * @OA\Response(
7489 * response="200",
7490 * ref="#/components/responses/standard"
7491 * ),
7492 * @OA\Response(
7493 * response="400",
7494 * ref="#/components/responses/badrequest"
7495 * ),
7496 * @OA\Response(
7497 * response="401",
7498 * ref="#/components/responses/unauthorized"
7499 * ),
7500 * security={{"openemr_auth":{}}}
7501 * )
7502 */
7503 "GET /api/drug/:uuid" => function ($uuid) {
7504 RestConfig::authorization_check("patients", "med");
7505 $return = (new DrugRestController())->getOne($uuid);
7506 RestConfig::apiLog($return);
7507 return $return;
7508 },
7509
7510 /**
7511 * @OA\Get(
7512 * path="/api/prescription",
7513 * description="Retrieves a list of all prescriptions",
7514 * tags={"standard"},
7515 * @OA\Response(
7516 * response="200",
7517 * ref="#/components/responses/standard"
7518 * ),
7519 * @OA\Response(
7520 * response="400",
7521 * ref="#/components/responses/badrequest"
7522 * ),
7523 * @OA\Response(
7524 * response="401",
7525 * ref="#/components/responses/unauthorized"
7526 * ),
7527 * security={{"openemr_auth":{}}}
7528 * )
7529 */
7530 "GET /api/prescription" => function () {
7531 RestConfig::authorization_check("patients", "med");
7532 $return = (new PrescriptionRestController())->getAll();
7533 RestConfig::apiLog($return);
7534 return $return;
7535 },
7536
7537 /**
7538 * @OA\Get(
7539 * path="/api/prescription/{uuid}",
7540 * description="Retrieves a prescription",
7541 * tags={"standard"},
7542 * @OA\Parameter(
7543 * name="uuid",
7544 * in="path",
7545 * description="The uuid for the prescription.",
7546 * required=true,
7547 * @OA\Schema(
7548 * type="string"
7549 * )
7550 * ),
7551 * @OA\Response(
7552 * response="200",
7553 * ref="#/components/responses/standard"
7554 * ),
7555 * @OA\Response(
7556 * response="400",
7557 * ref="#/components/responses/badrequest"
7558 * ),
7559 * @OA\Response(
7560 * response="401",
7561 * ref="#/components/responses/unauthorized"
7562 * ),
7563 * security={{"openemr_auth":{}}}
7564 * )
7565 */
7566 "GET /api/prescription/:uuid" => function ($uuid) {
7567 RestConfig::authorization_check("patients", "med");
7568 $return = (new PrescriptionRestController())->getOne($uuid);
7569 RestConfig::apiLog($return);
7570 return $return;
7571 }
7572 );
7573
7574 use OpenEMR\Common\Http\StatusCode;
7575 use OpenEMR\Common\Http\Psr17Factory;
7576 use OpenEMR\RestControllers\FHIR\FhirAllergyIntoleranceRestController;
7577 use OpenEMR\RestControllers\FHIR\FhirAppointmentRestController;
7578 use OpenEMR\RestControllers\FHIR\FhirCarePlanRestController;
7579 use OpenEMR\RestControllers\FHIR\FhirCareTeamRestController;
7580 use OpenEMR\RestControllers\FHIR\FhirConditionRestController;
7581 use OpenEMR\RestControllers\FHIR\FhirCoverageRestController;
7582 use OpenEMR\RestControllers\FHIR\FhirDeviceRestController;
7583 use OpenEMR\RestControllers\FHIR\FhirDiagnosticReportRestController;
7584 use OpenEMR\RestControllers\FHIR\FhirDocumentReferenceRestController;
7585 use OpenEMR\RestControllers\FHIR\FhirEncounterRestController;
7586 use OpenEMR\RestControllers\FHIR\FhirObservationRestController;
7587 use OpenEMR\RestControllers\FHIR\FhirImmunizationRestController;
7588 use OpenEMR\RestControllers\FHIR\FhirGoalRestController;
7589 use OpenEMR\RestControllers\FHIR\FhirGroupRestController;
7590 use OpenEMR\RestControllers\FHIR\FhirLocationRestController;
7591 use OpenEMR\RestControllers\FHIR\FhirMedicationRestController;
7592 use OpenEMR\RestControllers\FHIR\FhirMedicationRequestRestController;
7593 use OpenEMR\RestControllers\FHIR\FhirOrganizationRestController;
7594 use OpenEMR\RestControllers\FHIR\FhirPatientRestController;
7595 use OpenEMR\RestControllers\FHIR\FhirPersonRestController;
7596 use OpenEMR\RestControllers\FHIR\FhirPractitionerRoleRestController;
7597 use OpenEMR\RestControllers\FHIR\FhirPractitionerRestController;
7598 use OpenEMR\RestControllers\FHIR\FhirProcedureRestController;
7599 use OpenEMR\RestControllers\FHIR\FhirProvenanceRestController;
7600 use OpenEMR\RestControllers\FHIR\FhirValueSetRestController;
7601 use OpenEMR\RestControllers\FHIR\FhirMetaDataRestController;
7602 use OpenEMR\RestControllers\FHIR\Operations\FhirOperationExportRestController;
7603 use OpenEMR\RestControllers\FHIR\Operations\FhirOperationDocRefRestController;
7604 use OpenEMR\RestControllers\FHIR\Operations\FhirOperationDefinitionRestController;
7605
7606 // Note that the fhir route includes both user role and patient role
7607 // (there is a mechanism in place to ensure patient role is binded
7608 // to only see the data of the one patient)
7609 RestConfig::$FHIR_ROUTE_MAP = array(
7610 /**
7611 * @OA\Get(
7612 * path="/fhir/AllergyIntolerance",
7613 * description="Returns a list of AllergyIntolerance resources.",
7614 * tags={"fhir"},
7615 * @OA\Parameter(
7616 * name="_id",
7617 * in="query",
7618 * description="The uuid for the AllergyIntolerance resource.",
7619 * required=false,
7620 * @OA\Schema(
7621 * type="string"
7622 * )
7623 * ),
7624 * @OA\Parameter(
7625 * name="_lastUpdated",
7626 * in="query",
7627 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
7628 * required=false,
7629 * @OA\Schema(
7630 * type="string"
7631 * )
7632 * ),
7633 * @OA\Parameter(
7634 * name="patient",
7635 * in="query",
7636 * description="The uuid for the patient.",
7637 * required=false,
7638 * @OA\Schema(
7639 * type="string"
7640 * )
7641 * ),
7642 * @OA\Response(
7643 * response="200",
7644 * description="Standard Response",
7645 * @OA\MediaType(
7646 * mediaType="application/json",
7647 * @OA\Schema(
7648 * @OA\Property(
7649 * property="json object",
7650 * description="FHIR Json object.",
7651 * type="object"
7652 * ),
7653 * example={
7654 * "meta": {
7655 * "lastUpdated": "2021-09-14T09:13:51"
7656 * },
7657 * "resourceType": "Bundle",
7658 * "type": "collection",
7659 * "total": 0,
7660 * "link": {
7661 * {
7662 * "relation": "self",
7663 * "url": "https://localhost:9300/apis/default/fhir/AllergyIntolerance"
7664 * }
7665 * }
7666 * }
7667 * )
7668 * )
7669 * ),
7670 * @OA\Response(
7671 * response="400",
7672 * ref="#/components/responses/badrequest"
7673 * ),
7674 * @OA\Response(
7675 * response="401",
7676 * ref="#/components/responses/unauthorized"
7677 * ),
7678 * security={{"openemr_auth":{}}}
7679 * )
7680 */
7681 "GET /fhir/AllergyIntolerance" => function (HttpRestRequest $request) {
7682 $getParams = $request->getQueryParams();
7683 if ($request->isPatientRequest()) {
7684 // only allow access to data of binded patient
7685 $return = (new FhirAllergyIntoleranceRestController($request))->getAll($getParams, $request->getPatientUUIDString());
7686 } else {
7687 RestConfig::authorization_check("patients", "med");
7688 $return = (new FhirAllergyIntoleranceRestController($request))->getAll($getParams);
7689 }
7690 RestConfig::apiLog($return);
7691 return $return;
7692 },
7693
7694 /**
7695 * @OA\Get(
7696 * path="/fhir/AllergyIntolerance/{uuid}",
7697 * description="Returns a single AllergyIntolerance resource.",
7698 * tags={"fhir"},
7699 * @OA\Parameter(
7700 * name="uuid",
7701 * in="path",
7702 * description="The uuid for the AllergyIntolerance resource.",
7703 * required=true,
7704 * @OA\Schema(
7705 * type="string"
7706 * )
7707 * ),
7708 * @OA\Response(
7709 * response="200",
7710 * description="Standard Response",
7711 * @OA\MediaType(
7712 * mediaType="application/json",
7713 * @OA\Schema(
7714 * @OA\Property(
7715 * property="json object",
7716 * description="FHIR Json object.",
7717 * type="object"
7718 * ),
7719 * example={
7720 * "id": "94682fe5-f383-4885-9505-64b02e34906f",
7721 * "meta": {
7722 * "versionId": "1",
7723 * "lastUpdated": "2021-09-16T00:27:32+00:00"
7724 * },
7725 * "resourceType": "AllergyIntolerance",
7726 * "text": {
7727 * "status": "additional",
7728 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'>penicillin</div>"
7729 * },
7730 * "clinicalStatus": {
7731 * "coding": {
7732 * {
7733 * "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
7734 * "code": "active",
7735 * "display": "Active"
7736 * }
7737 * }
7738 * },
7739 * "verificationStatus": {
7740 * "coding": {
7741 * {
7742 * "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
7743 * "code": "confirmed",
7744 * "display": "Confirmed"
7745 * }
7746 * }
7747 * },
7748 * "category": {
7749 * "medication"
7750 * },
7751 * "criticality": "low",
7752 * "code": {
7753 * "coding": {
7754 * {
7755 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
7756 * "code": "unknown",
7757 * "display": "Unknown"
7758 * }
7759 * }
7760 * },
7761 * "patient": {
7762 * "reference": "Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92"
7763 * },
7764 * "reaction": {
7765 * {
7766 * "manifestation": {
7767 * {
7768 * "coding": {
7769 * {
7770 * "system": "http://snomed.info/sct",
7771 * "code": "422587007",
7772 * "display": "Nausea"
7773 * }
7774 * },
7775 * "text": "Nausea"
7776 * }
7777 * }
7778 * }
7779 * }
7780 * }
7781 * )
7782 * )
7783 * ),
7784 * @OA\Response(
7785 * response="400",
7786 * ref="#/components/responses/badrequest"
7787 * ),
7788 * @OA\Response(
7789 * response="401",
7790 * ref="#/components/responses/unauthorized"
7791 * ),
7792 * @OA\Response(
7793 * response="404",
7794 * ref="#/components/responses/uuidnotfound"
7795 * ),
7796 * security={{"openemr_auth":{}}}
7797 * )
7798 */
7799 "GET /fhir/AllergyIntolerance/:uuid" => function ($uuid, HttpRestRequest $request) {
7800 if ($request->isPatientRequest()) {
7801 // only allow access to data of binded patient
7802 $return = (new FhirAllergyIntoleranceRestController($request))->getOne($uuid, $request->getPatientUUIDString());
7803 } else {
7804 RestConfig::authorization_check("patients", "med");
7805 $return = (new FhirAllergyIntoleranceRestController($request))->getOne($uuid);
7806 }
7807 RestConfig::apiLog($return);
7808 return $return;
7809 },
7810
7811 /**
7812 * @OA\Get(
7813 * path="/fhir/Appointment",
7814 * description="Returns a list of Appointment resources.",
7815 * tags={"fhir"},
7816 * @OA\Parameter(
7817 * name="_id",
7818 * in="query",
7819 * description="The uuid for the Appointment resource.",
7820 * required=false,
7821 * @OA\Schema(
7822 * type="string"
7823 * )
7824 * ),
7825 * @OA\Parameter(
7826 * name="_lastUpdated",
7827 * in="query",
7828 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
7829 * required=false,
7830 * @OA\Schema(
7831 * type="string"
7832 * )
7833 * ),
7834 * @OA\Parameter(
7835 * name="patient",
7836 * in="query",
7837 * description="The uuid for the patient.",
7838 * required=false,
7839 * @OA\Schema(
7840 * type="string"
7841 * )
7842 * ),
7843 * @OA\Response(
7844 * response="200",
7845 * description="Standard Response",
7846 * @OA\MediaType(
7847 * mediaType="application/json",
7848 * @OA\Schema(
7849 * @OA\Property(
7850 * property="json object",
7851 * description="FHIR Json object.",
7852 * type="object"
7853 * ),
7854 * example={
7855 * "meta": {
7856 * "lastUpdated": "2021-09-14T09:13:51"
7857 * },
7858 * "resourceType": "Bundle",
7859 * "type": "collection",
7860 * "total": 0,
7861 * "link": {
7862 * {
7863 * "relation": "self",
7864 * "url": "https://localhost:9300/apis/default/fhir/AllergyIntolerance"
7865 * }
7866 * }
7867 * }
7868 * )
7869 * )
7870 * ),
7871 * @OA\Response(
7872 * response="400",
7873 * ref="#/components/responses/badrequest"
7874 * ),
7875 * @OA\Response(
7876 * response="401",
7877 * ref="#/components/responses/unauthorized"
7878 * ),
7879 * security={{"openemr_auth":{}}}
7880 * )
7881 */
7882 "GET /fhir/Appointment" => function (HttpRestRequest $request) {
7883 $getParams = $request->getQueryParams();
7884 if ($request->isPatientRequest()) {
7885 // only allow access to data of binded patient
7886 $return = (new FhirAppointmentRestController($request))->getAll($getParams, $request->getPatientUUIDString());
7887 } else {
7888 RestConfig::authorization_check("patients", "appt");
7889 $return = (new FhirAppointmentRestController($request))->getAll($getParams);
7890 }
7891 RestConfig::apiLog($return);
7892 return $return;
7893 },
7894
7895 /**
7896 * @OA\Get(
7897 * path="/fhir/Appointment/{uuid}",
7898 * description="Returns a single Appointment resource.",
7899 * tags={"fhir"},
7900 * @OA\Parameter(
7901 * name="uuid",
7902 * in="path",
7903 * description="The uuid for the Appointment resource.",
7904 * required=true,
7905 * @OA\Schema(
7906 * type="string"
7907 * )
7908 * ),
7909 * @OA\Response(
7910 * response="200",
7911 * description="Standard Response",
7912 * @OA\MediaType(
7913 * mediaType="application/json",
7914 * @OA\Schema(
7915 * @OA\Property(
7916 * property="json object",
7917 * description="FHIR Json object.",
7918 * type="object"
7919 * ),
7920 * example={}
7921 * )
7922 * )
7923 * ),
7924 * @OA\Response(
7925 * response="400",
7926 * ref="#/components/responses/badrequest"
7927 * ),
7928 * @OA\Response(
7929 * response="401",
7930 * ref="#/components/responses/unauthorized"
7931 * ),
7932 * @OA\Response(
7933 * response="404",
7934 * ref="#/components/responses/uuidnotfound"
7935 * ),
7936 * security={{"openemr_auth":{}}}
7937 * )
7938 */
7939 "GET /fhir/Appointment/:uuid" => function ($uuid, HttpRestRequest $request) {
7940 if ($request->isPatientRequest()) {
7941 // only allow access to data of binded patient
7942 $return = (new FhirAppointmentRestController($request))->getOne($uuid, $request->getPatientUUIDString());
7943 } else {
7944 RestConfig::authorization_check("patients", "appt");
7945 $return = (new FhirAppointmentRestController($request))->getOne($uuid);
7946 }
7947 RestConfig::apiLog($return);
7948 return $return;
7949 },
7950
7951 /**
7952 * @OA\Get(
7953 * path="/fhir/CarePlan",
7954 * description="Returns a list of CarePlan resources.",
7955 * tags={"fhir"},
7956 * @OA\Parameter(
7957 * name="_id",
7958 * in="query",
7959 * description="The uuid for the CarePlan resource.",
7960 * required=false,
7961 * @OA\Schema(
7962 * type="string"
7963 * )
7964 * ),
7965 * @OA\Parameter(
7966 * name="_lastUpdated",
7967 * in="query",
7968 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
7969 * required=false,
7970 * @OA\Schema(
7971 * type="string"
7972 * )
7973 * ),
7974 * @OA\Parameter(
7975 * name="patient",
7976 * in="query",
7977 * description="The uuid for the patient.",
7978 * required=false,
7979 * @OA\Schema(
7980 * type="string"
7981 * )
7982 * ),
7983 * @OA\Parameter(
7984 * name="category",
7985 * in="query",
7986 * description="The category of the CarePlan resource.",
7987 * required=false,
7988 * @OA\Schema(
7989 * type="string"
7990 * )
7991 * ),
7992 * @OA\Response(
7993 * response="200",
7994 * description="Standard Response",
7995 * @OA\MediaType(
7996 * mediaType="application/json",
7997 * @OA\Schema(
7998 * @OA\Property(
7999 * property="json object",
8000 * description="FHIR Json object.",
8001 * type="object"
8002 * ),
8003 * example={
8004 * "meta": {
8005 * "lastUpdated": "2021-09-14T09:13:51"
8006 * },
8007 * "resourceType": "Bundle",
8008 * "type": "collection",
8009 * "total": 0,
8010 * "link": {
8011 * {
8012 * "relation": "self",
8013 * "url": "https://localhost:9300/apis/default/fhir/CarePlan"
8014 * }
8015 * }
8016 * }
8017 * )
8018 * )
8019 * ),
8020 * @OA\Response(
8021 * response="400",
8022 * ref="#/components/responses/badrequest"
8023 * ),
8024 * @OA\Response(
8025 * response="401",
8026 * ref="#/components/responses/unauthorized"
8027 * ),
8028 * security={{"openemr_auth":{}}}
8029 * )
8030 */
8031 "GET /fhir/CarePlan" => function (HttpRestRequest $request) {
8032 $getParams = $request->getQueryParams();
8033 if ($request->isPatientRequest()) {
8034 // only allow access to data of binded patient
8035 $return = (new FhirCarePlanRestController())->getAll($getParams, $request->getPatientUUIDString());
8036 } else {
8037 RestConfig::authorization_check("patients", "med");
8038 $return = (new FhirCarePlanRestController())->getAll($getParams);
8039 }
8040 RestConfig::apiLog($return);
8041 return $return;
8042 },
8043
8044 /**
8045 * @OA\Get(
8046 * path="/fhir/CarePlan/{uuid}",
8047 * description="Returns a single CarePlan resource.",
8048 * tags={"fhir"},
8049 * @OA\Parameter(
8050 * name="uuid",
8051 * in="path",
8052 * description="The uuid for the CarePlan resource.",
8053 * required=true,
8054 * @OA\Schema(
8055 * type="string"
8056 * )
8057 * ),
8058 * @OA\Response(
8059 * response="200",
8060 * description="Standard Response",
8061 * @OA\MediaType(
8062 * mediaType="application/json",
8063 * @OA\Schema(
8064 * @OA\Property(
8065 * property="json object",
8066 * description="FHIR Json object.",
8067 * type="object"
8068 * ),
8069 * example={
8070 * "id": "94682f08-8fbc-451e-b1ec-f922d765c38f_1",
8071 * "meta": {
8072 * "versionId": "1",
8073 * "lastUpdated": "2021-09-16T00:54:18+00:00"
8074 * },
8075 * "resourceType": "CarePlan",
8076 * "text": {
8077 * "status": "generated",
8078 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""><p>Treat flu.</p></div>"
8079 * },
8080 * "status": "active",
8081 * "intent": "plan",
8082 * "category": {
8083 * {
8084 * "coding": {
8085 * {
8086 * "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
8087 * "code": "assess-plan"
8088 * }
8089 * }
8090 * }
8091 * },
8092 * "description": "Treat flu.",
8093 * "subject": {
8094 * "reference": "Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92",
8095 * "type": "Patient"
8096 * }
8097 * }
8098 * )
8099 * )
8100 * ),
8101 * @OA\Response(
8102 * response="400",
8103 * ref="#/components/responses/badrequest"
8104 * ),
8105 * @OA\Response(
8106 * response="401",
8107 * ref="#/components/responses/unauthorized"
8108 * ),
8109 * @OA\Response(
8110 * response="404",
8111 * ref="#/components/responses/uuidnotfound"
8112 * ),
8113 * security={{"openemr_auth":{}}}
8114 * )
8115 */
8116 "GET /fhir/CarePlan/:uuid" => function ($uuid, HttpRestRequest $request) {
8117 if ($request->isPatientRequest()) {
8118 // only allow access to data of binded patient
8119 $return = (new FhirCarePlanRestController())->getOne($uuid, $request->getPatientUUIDString());
8120 } else {
8121 RestConfig::authorization_check("patients", "med");
8122 $return = (new FhirCarePlanRestController())->getOne($uuid);
8123 }
8124 RestConfig::apiLog($return);
8125 return $return;
8126 },
8127
8128 /**
8129 * @OA\Get(
8130 * path="/fhir/CareTeam",
8131 * description="Returns a list of CareTeam resources.",
8132 * tags={"fhir"},
8133 * @OA\Parameter(
8134 * name="_id",
8135 * in="query",
8136 * description="The uuid for the CareTeam resource.",
8137 * required=false,
8138 * @OA\Schema(
8139 * type="string"
8140 * )
8141 * ),
8142 * @OA\Parameter(
8143 * name="_lastUpdated",
8144 * in="query",
8145 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8146 * required=false,
8147 * @OA\Schema(
8148 * type="string"
8149 * )
8150 * ),
8151 * @OA\Parameter(
8152 * name="patient",
8153 * in="query",
8154 * description="The uuid for the patient.",
8155 * required=false,
8156 * @OA\Schema(
8157 * type="string"
8158 * )
8159 * ),
8160 * @OA\Parameter(
8161 * name="status",
8162 * in="query",
8163 * description="The status of the CarePlan resource.",
8164 * required=false,
8165 * @OA\Schema(
8166 * type="string"
8167 * )
8168 * ),
8169 * @OA\Response(
8170 * response="200",
8171 * description="Standard Response",
8172 * @OA\MediaType(
8173 * mediaType="application/json",
8174 * @OA\Schema(
8175 * @OA\Property(
8176 * property="json object",
8177 * description="FHIR Json object.",
8178 * type="object"
8179 * ),
8180 * example={
8181 * "meta": {
8182 * "lastUpdated": "2021-09-14T09:13:51"
8183 * },
8184 * "resourceType": "Bundle",
8185 * "type": "collection",
8186 * "total": 0,
8187 * "link": {
8188 * {
8189 * "relation": "self",
8190 * "url": "https://localhost:9300/apis/default/fhir/CareTeam"
8191 * }
8192 * }
8193 * }
8194 * )
8195 * )
8196 * ),
8197 * @OA\Response(
8198 * response="400",
8199 * ref="#/components/responses/badrequest"
8200 * ),
8201 * @OA\Response(
8202 * response="401",
8203 * ref="#/components/responses/unauthorized"
8204 * ),
8205 * security={{"openemr_auth":{}}}
8206 * )
8207 */
8208 "GET /fhir/CareTeam" => function (HttpRestRequest $request) {
8209 $getParams = $request->getQueryParams();
8210 if ($request->isPatientRequest()) {
8211 // only allow access to data of binded patient
8212 $return = (new FhirCareTeamRestController())->getAll($getParams, $request->getPatientUUIDString());
8213 } else {
8214 RestConfig::authorization_check("patients", "med");
8215 $return = (new FhirCareTeamRestController())->getAll($getParams);
8216 }
8217 RestConfig::apiLog($return);
8218 return $return;
8219 },
8220
8221 /**
8222 * @OA\Get(
8223 * path="/fhir/CareTeam/{uuid}",
8224 * description="Returns a single CareTeam resource.",
8225 * tags={"fhir"},
8226 * @OA\Parameter(
8227 * name="uuid",
8228 * in="path",
8229 * description="The uuid for the CareTeam resource.",
8230 * required=true,
8231 * @OA\Schema(
8232 * type="string"
8233 * )
8234 * ),
8235 * @OA\Parameter(
8236 * name="_lastUpdated",
8237 * in="query",
8238 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8239 * required=false,
8240 * @OA\Schema(
8241 * type="string"
8242 * )
8243 * ),
8244 * @OA\Response(
8245 * response="200",
8246 * description="Standard Response",
8247 * @OA\MediaType(
8248 * mediaType="application/json",
8249 * @OA\Schema(
8250 * @OA\Property(
8251 * property="json object",
8252 * description="FHIR Json object.",
8253 * type="object"
8254 * ),
8255 * example={
8256 * "id": "94682f09-69fe-4ada-8ea6-753a52bd1516",
8257 * "meta": {
8258 * "versionId": "1",
8259 * "lastUpdated": "2021-09-16T01:07:22+00:00"
8260 * },
8261 * "resourceType": "CareTeam",
8262 * "status": "active",
8263 * "subject": {
8264 * "reference": "Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92",
8265 * "type": "Patient"
8266 * },
8267 * "participant": {
8268 * {
8269 * "role": {
8270 * {
8271 * "coding": {
8272 * {
8273 * "system": "http://nucc.org/provider-taxonomy",
8274 * "code": "102L00000X",
8275 * "display": "Psychoanalyst"
8276 * }
8277 * }
8278 * }
8279 * },
8280 * "member": {
8281 * "reference": "Practitioner/94682c68-f712-4c39-9158-ff132a08f26b",
8282 * "type": "Practitioner"
8283 * },
8284 * "onBehalfOf": {
8285 * "reference": "Organization/94682c62-b801-4498-84a1-13f158bb2a18",
8286 * "type": "Organization"
8287 * }
8288 * },
8289 * {
8290 * "role": {
8291 * {
8292 * "coding": {
8293 * {
8294 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
8295 * "code": "unknown",
8296 * "display": "Unknown"
8297 * }
8298 * }
8299 * }
8300 * },
8301 * "member": {
8302 * "reference": "Organization/94682c62-b801-4498-84a1-13f158bb2a18",
8303 * "type": "Organization"
8304 * }
8305 * }
8306 * }
8307 * }
8308 * )
8309 * )
8310 * ),
8311 * @OA\Response(
8312 * response="400",
8313 * ref="#/components/responses/badrequest"
8314 * ),
8315 * @OA\Response(
8316 * response="401",
8317 * ref="#/components/responses/unauthorized"
8318 * ),
8319 * @OA\Response(
8320 * response="404",
8321 * ref="#/components/responses/uuidnotfound"
8322 * ),
8323 * security={{"openemr_auth":{}}}
8324 * )
8325 */
8326 "GET /fhir/CareTeam/:uuid" => function ($uuid, HttpRestRequest $request) {
8327 if ($request->isPatientRequest()) {
8328 // only allow access to data of binded patient
8329 $return = (new FhirCareTeamRestController())->getOne($uuid, $request->getPatientUUIDString());
8330 } else {
8331 RestConfig::authorization_check("patients", "med");
8332 $return = (new FhirCareTeamRestController())->getOne($uuid);
8333 }
8334 RestConfig::apiLog($return);
8335 return $return;
8336 },
8337
8338 /**
8339 * @OA\Get(
8340 * path="/fhir/Condition",
8341 * description="Returns a list of Condition resources.",
8342 * tags={"fhir"},
8343 * @OA\Parameter(
8344 * name="_id",
8345 * in="query",
8346 * description="The uuid for the Condition resource.",
8347 * required=false,
8348 * @OA\Schema(
8349 * type="string"
8350 * )
8351 * ),
8352 * @OA\Parameter(
8353 * name="_lastUpdated",
8354 * in="query",
8355 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8356 * required=false,
8357 * @OA\Schema(
8358 * type="string"
8359 * )
8360 * ),
8361 * @OA\Parameter(
8362 * name="patient",
8363 * in="query",
8364 * description="The uuid for the patient.",
8365 * required=false,
8366 * @OA\Schema(
8367 * type="string"
8368 * )
8369 * ),
8370 * @OA\Response(
8371 * response="200",
8372 * description="Standard Response",
8373 * @OA\MediaType(
8374 * mediaType="application/json",
8375 * @OA\Schema(
8376 * @OA\Property(
8377 * property="json object",
8378 * description="FHIR Json object.",
8379 * type="object"
8380 * ),
8381 * example={
8382 * "meta": {
8383 * "lastUpdated": "2021-09-14T09:13:51"
8384 * },
8385 * "resourceType": "Bundle",
8386 * "type": "collection",
8387 * "total": 0,
8388 * "link": {
8389 * {
8390 * "relation": "self",
8391 * "url": "https://localhost:9300/apis/default/fhir/Condition"
8392 * }
8393 * }
8394 * }
8395 * )
8396 * )
8397 * ),
8398 * @OA\Response(
8399 * response="400",
8400 * ref="#/components/responses/badrequest"
8401 * ),
8402 * @OA\Response(
8403 * response="401",
8404 * ref="#/components/responses/unauthorized"
8405 * ),
8406 * security={{"openemr_auth":{}}}
8407 * )
8408 */
8409 "GET /fhir/Condition" => function (HttpRestRequest $request) {
8410 $getParams = $request->getQueryParams();
8411 if ($request->isPatientRequest()) {
8412 // only allow access to data of binded patient
8413 $return = (new FhirConditionRestController())->getAll($getParams, $request->getPatientUUIDString());
8414 } else {
8415 RestConfig::authorization_check("patients", "med");
8416 $return = (new FhirConditionRestController())->getAll($getParams);
8417 }
8418 RestConfig::apiLog($return);
8419 return $return;
8420 },
8421
8422 /**
8423 * @OA\Get(
8424 * path="/fhir/Condition/{uuid}",
8425 * description="Returns a single Condition resource.",
8426 * tags={"fhir"},
8427 * @OA\Parameter(
8428 * name="uuid",
8429 * in="path",
8430 * description="The uuid for the Condition resource.",
8431 * required=true,
8432 * @OA\Schema(
8433 * type="string"
8434 * )
8435 * ),
8436 * @OA\Response(
8437 * response="200",
8438 * description="Standard Response",
8439 * @OA\MediaType(
8440 * mediaType="application/json",
8441 * @OA\Schema(
8442 * @OA\Property(
8443 * property="json object",
8444 * description="FHIR Json object.",
8445 * type="object"
8446 * ),
8447 * example={
8448 * "id": "94682c68-e5bb-4c5c-859a-cebaa5a1e582",
8449 * "meta": {
8450 * "versionId": "1",
8451 * "lastUpdated": "2021-09-16T02:41:53+00:00"
8452 * },
8453 * "resourceType": "Condition",
8454 * "clinicalStatus": {
8455 * "coding": {
8456 * {
8457 * "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
8458 * "code": "inactive",
8459 * "display": "Inactive"
8460 * }
8461 * }
8462 * },
8463 * "verificationStatus": {
8464 * "coding": {
8465 * {
8466 * "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
8467 * "code": "unconfirmed",
8468 * "display": "Unconfirmed"
8469 * }
8470 * }
8471 * },
8472 * "category": {
8473 * {
8474 * "coding": {
8475 * {
8476 * "system": "http://terminology.hl7.org/CodeSystem/condition-category",
8477 * "code": "problem-list-item",
8478 * "display": "Problem List Item"
8479 * }
8480 * }
8481 * }
8482 * },
8483 * "code": {
8484 * "coding": {
8485 * {
8486 * "system": "http://snomed.info/sct",
8487 * "code": "444814009",
8488 * "display": ""
8489 * }
8490 * }
8491 * },
8492 * "subject": {
8493 * "reference": "Patient/94682c62-d37e-48b5-8018-c5f6f3566609"
8494 * }
8495 * }
8496 * )
8497 * )
8498 * ),
8499 * @OA\Response(
8500 * response="400",
8501 * ref="#/components/responses/badrequest"
8502 * ),
8503 * @OA\Response(
8504 * response="401",
8505 * ref="#/components/responses/unauthorized"
8506 * ),
8507 * @OA\Response(
8508 * response="404",
8509 * ref="#/components/responses/uuidnotfound"
8510 * ),
8511 * security={{"openemr_auth":{}}}
8512 * )
8513 */
8514 "GET /fhir/Condition/:uuid" => function ($uuid, HttpRestRequest $request) {
8515 if ($request->isPatientRequest()) {
8516 // only allow access to data of binded patient
8517 $return = (new FhirConditionRestController())->getOne($uuid, $request->getPatientUUIDString());
8518 } else {
8519 RestConfig::authorization_check("patients", "med");
8520 $return = (new FhirConditionRestController())->getOne($uuid);
8521 }
8522 RestConfig::apiLog($return);
8523 return $return;
8524 },
8525
8526 /**
8527 * @OA\Get(
8528 * path="/fhir/Coverage",
8529 * description="Returns a list of Coverage resources.",
8530 * tags={"fhir"},
8531 * @OA\Parameter(
8532 * name="_id",
8533 * in="query",
8534 * description="The uuid for the Coverage resource.",
8535 * required=false,
8536 * @OA\Schema(
8537 * type="string"
8538 * )
8539 * ),
8540 * @OA\Parameter(
8541 * name="_lastUpdated",
8542 * in="query",
8543 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8544 * required=false,
8545 * @OA\Schema(
8546 * type="string"
8547 * )
8548 * ),
8549 * @OA\Parameter(
8550 * name="patient",
8551 * in="query",
8552 * description="The uuid for the patient.",
8553 * required=false,
8554 * @OA\Schema(
8555 * type="string"
8556 * )
8557 * ),
8558 * @OA\Parameter(
8559 * name="payor",
8560 * in="query",
8561 * description="The payor of the Coverage resource.",
8562 * required=false,
8563 * @OA\Schema(
8564 * type="string"
8565 * )
8566 * ),
8567 * @OA\Response(
8568 * response="200",
8569 * description="Standard Response",
8570 * @OA\MediaType(
8571 * mediaType="application/json",
8572 * @OA\Schema(
8573 * @OA\Property(
8574 * property="json object",
8575 * description="FHIR Json object.",
8576 * type="object"
8577 * ),
8578 * example={
8579 * "meta": {
8580 * "lastUpdated": "2021-09-14T09:13:51"
8581 * },
8582 * "resourceType": "Bundle",
8583 * "type": "collection",
8584 * "total": 0,
8585 * "link": {
8586 * {
8587 * "relation": "self",
8588 * "url": "https://localhost:9300/apis/default/fhir/Coverage"
8589 * }
8590 * }
8591 * }
8592 * )
8593 * )
8594 * ),
8595 * @OA\Response(
8596 * response="400",
8597 * ref="#/components/responses/badrequest"
8598 * ),
8599 * @OA\Response(
8600 * response="401",
8601 * ref="#/components/responses/unauthorized"
8602 * ),
8603 * security={{"openemr_auth":{}}}
8604 * )
8605 */
8606 "GET /fhir/Coverage" => function (HttpRestRequest $request) {
8607 if ($request->isPatientRequest()) {
8608 // only allow access to data of binded patient
8609 $return = (new FhirCoverageRestController())->getAll($request->getQueryParams(), $request->getPatientUUIDString());
8610 } else {
8611 RestConfig::authorization_check("admin", "super");
8612 $return = (new FhirCoverageRestController())->getAll($request->getQueryParams());
8613 }
8614 RestConfig::apiLog($return);
8615 return $return;
8616 },
8617
8618 /**
8619 * @OA\Get(
8620 * path="/fhir/Coverage/{uuid}",
8621 * description="Returns a single Coverage resource.",
8622 * tags={"fhir"},
8623 * @OA\Parameter(
8624 * name="uuid",
8625 * in="path",
8626 * description="The uuid for the Coverage resource.",
8627 * required=true,
8628 * @OA\Schema(
8629 * type="string"
8630 * )
8631 * ),
8632 * @OA\Response(
8633 * response="200",
8634 * description="Standard Response",
8635 * @OA\MediaType(
8636 * mediaType="application/json",
8637 * @OA\Schema(
8638 * @OA\Property(
8639 * property="json object",
8640 * description="FHIR Json object.",
8641 * type="object"
8642 * ),
8643 * example={
8644 * "id": "960d5f10-edc6-4c65-a6d4-39a1e1da87a8",
8645 * "meta": {
8646 * "versionId": "1",
8647 * "lastUpdated": "2022-04-14T07:58:45+00:00"
8648 * },
8649 * "resourceType": "Coverage",
8650 * "status": "active",
8651 * "beneficiary": {
8652 * "reference": "Patient/960d5f08-9fdf-4bdc-9108-84a149e28bac"
8653 * },
8654 * "relationship": {
8655 * "coding": {
8656 * {
8657 * "system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
8658 * "code": ""
8659 * }
8660 * }
8661 * }
8662 * }
8663 * )
8664 * )
8665 * ),
8666 * @OA\Response(
8667 * response="400",
8668 * ref="#/components/responses/badrequest"
8669 * ),
8670 * @OA\Response(
8671 * response="401",
8672 * ref="#/components/responses/unauthorized"
8673 * ),
8674 * @OA\Response(
8675 * response="404",
8676 * ref="#/components/responses/uuidnotfound"
8677 * ),
8678 * security={{"openemr_auth":{}}}
8679 * )
8680 */
8681 "GET /fhir/Coverage/:uuid" => function ($uuid, HttpRestRequest $request) {
8682 if ($request->isPatientRequest()) {
8683 // only allow access to data of binded patient
8684 $return = (new FhirCoverageRestController())->getOne($uuid, $request->getPatientUUIDString());
8685 } else {
8686 RestConfig::authorization_check("admin", "super");
8687 $return = (new FhirCoverageRestController())->getOne($uuid);
8688 }
8689 RestConfig::apiLog($return);
8690 return $return;
8691 },
8692
8693 /**
8694 * @OA\Get(
8695 * path="/fhir/Device",
8696 * description="Returns a list of Device resources.",
8697 * tags={"fhir"},
8698 * @OA\Parameter(
8699 * name="_id",
8700 * in="query",
8701 * description="The uuid for the Device resource.",
8702 * required=false,
8703 * @OA\Schema(
8704 * type="string"
8705 * )
8706 * ),
8707 * @OA\Parameter(
8708 * name="_lastUpdated",
8709 * in="query",
8710 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8711 * required=false,
8712 * @OA\Schema(
8713 * type="string"
8714 * )
8715 * ),
8716 * @OA\Parameter(
8717 * name="patient",
8718 * in="query",
8719 * description="The uuid for the patient.",
8720 * required=false,
8721 * @OA\Schema(
8722 * type="string"
8723 * )
8724 * ),
8725 * @OA\Response(
8726 * response="200",
8727 * description="Standard Response",
8728 * @OA\MediaType(
8729 * mediaType="application/json",
8730 * @OA\Schema(
8731 * @OA\Property(
8732 * property="json object",
8733 * description="FHIR Json object.",
8734 * type="object"
8735 * ),
8736 * example={
8737 * "meta": {
8738 * "lastUpdated": "2021-09-14T09:13:51"
8739 * },
8740 * "resourceType": "Bundle",
8741 * "type": "collection",
8742 * "total": 0,
8743 * "link": {
8744 * {
8745 * "relation": "self",
8746 * "url": "https://localhost:9300/apis/default/fhir/Device"
8747 * }
8748 * }
8749 * }
8750 * )
8751 * )
8752 * ),
8753 * @OA\Response(
8754 * response="400",
8755 * ref="#/components/responses/badrequest"
8756 * ),
8757 * @OA\Response(
8758 * response="401",
8759 * ref="#/components/responses/unauthorized"
8760 * ),
8761 * security={{"openemr_auth":{}}}
8762 * )
8763 */
8764 "GET /fhir/Device" => function (HttpRestRequest $request) {
8765 if ($request->isPatientRequest()) {
8766 // only allow access to data of binded patient
8767 $return = (new FhirDeviceRestController())->getAll($request->getQueryParams(), $request->getPatientUUIDString());
8768 } else {
8769 RestConfig::authorization_check("admin", "super");
8770 $return = (new FhirDeviceRestController())->getAll($request->getQueryParams());
8771 }
8772 RestConfig::apiLog($return);
8773 return $return;
8774 },
8775
8776 /**
8777 * @OA\Get(
8778 * path="/fhir/Device/{uuid}",
8779 * description="Returns a single Device resource.",
8780 * tags={"fhir"},
8781 * @OA\Parameter(
8782 * name="uuid",
8783 * in="path",
8784 * description="The uuid for the Device resource.",
8785 * required=true,
8786 * @OA\Schema(
8787 * type="string"
8788 * )
8789 * ),
8790 * @OA\Response(
8791 * response="200",
8792 * description="Standard Response",
8793 * @OA\MediaType(
8794 * mediaType="application/json",
8795 * @OA\Schema(
8796 * @OA\Property(
8797 * property="json object",
8798 * description="FHIR Json object.",
8799 * type="object"
8800 * ),
8801 * example={
8802 * "id": "946dce19-c80a-402c-862a-eadf3f2377f0",
8803 * "meta": {
8804 * "versionId": "1",
8805 * "lastUpdated": "2021-09-18T19:28:59+00:00"
8806 * },
8807 * "resourceType": "Device",
8808 * "udiCarrier": {
8809 * {
8810 * "deviceIdentifier": "08717648200274",
8811 * "carrierHRF": "=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123"
8812 * }
8813 * },
8814 * "distinctIdentifier": "A99971312345600",
8815 * "manufactureDate": "2013-02-01",
8816 * "expirationDate": "2014-02-01",
8817 * "lotNumber": "000000000000XYZ123",
8818 * "serialNumber": "000025",
8819 * "type": {
8820 * "extension": {
8821 * {
8822 * "valueCode": "unknown",
8823 * "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
8824 * }
8825 * }
8826 * },
8827 * "patient": {
8828 * "reference": "Patient/946da619-c631-431a-a282-487cd6fb7802",
8829 * "type": "Patient"
8830 * }
8831 * }
8832 * )
8833 * )
8834 * ),
8835 * @OA\Response(
8836 * response="400",
8837 * ref="#/components/responses/badrequest"
8838 * ),
8839 * @OA\Response(
8840 * response="401",
8841 * ref="#/components/responses/unauthorized"
8842 * ),
8843 * @OA\Response(
8844 * response="404",
8845 * ref="#/components/responses/uuidnotfound"
8846 * ),
8847 * security={{"openemr_auth":{}}}
8848 * )
8849 */
8850 "GET /fhir/Device/:uuid" => function ($uuid, HttpRestRequest $request) {
8851 if ($request->isPatientRequest()) {
8852 // only allow access to data of binded patient
8853 $return = (new FhirDeviceRestController())->getOne($uuid, $request->getPatientUUIDString());
8854 } else {
8855 RestConfig::authorization_check("admin", "super");
8856 $return = (new FhirDeviceRestController())->getOne($uuid);
8857 }
8858 RestConfig::apiLog($return);
8859 return $return;
8860 },
8861
8862 /**
8863 * @OA\Get(
8864 * path="/fhir/DiagnosticReport",
8865 * description="Returns a list of DiagnosticReport resources.",
8866 * tags={"fhir"},
8867 * @OA\Parameter(
8868 * name="_id",
8869 * in="query",
8870 * description="The uuid for the DiagnosticReport resource.",
8871 * required=false,
8872 * @OA\Schema(
8873 * type="string"
8874 * )
8875 * ),
8876 * @OA\Parameter(
8877 * name="_lastUpdated",
8878 * in="query",
8879 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
8880 * required=false,
8881 * @OA\Schema(
8882 * type="string"
8883 * )
8884 * ),
8885 * @OA\Parameter(
8886 * name="patient",
8887 * in="query",
8888 * description="The uuid for the patient.",
8889 * required=false,
8890 * @OA\Schema(
8891 * type="string"
8892 * )
8893 * ),
8894 * @OA\Parameter(
8895 * name="code",
8896 * in="query",
8897 * description="The code of the DiagnosticReport resource.",
8898 * required=false,
8899 * @OA\Schema(
8900 * type="string"
8901 * )
8902 * ),
8903 * @OA\Parameter(
8904 * name="category",
8905 * in="query",
8906 * description="The category of the DiagnosticReport resource.",
8907 * required=false,
8908 * @OA\Schema(
8909 * type="string"
8910 * )
8911 * ),
8912 * @OA\Parameter(
8913 * name="date",
8914 * in="query",
8915 * description="The datetime of the DiagnosticReport resource.",
8916 * required=false,
8917 * @OA\Schema(
8918 * type="string"
8919 * )
8920 * ),
8921 * @OA\Response(
8922 * response="200",
8923 * description="Standard Response",
8924 * @OA\MediaType(
8925 * mediaType="application/json",
8926 * @OA\Schema(
8927 * @OA\Property(
8928 * property="json object",
8929 * description="FHIR Json object.",
8930 * type="object"
8931 * ),
8932 * example={
8933 * "meta": {
8934 * "lastUpdated": "2021-09-14T09:13:51"
8935 * },
8936 * "resourceType": "Bundle",
8937 * "type": "collection",
8938 * "total": 0,
8939 * "link": {
8940 * {
8941 * "relation": "self",
8942 * "url": "https://localhost:9300/apis/default/fhir/DiagnosticReport"
8943 * }
8944 * }
8945 * }
8946 * )
8947 * )
8948 * ),
8949 * @OA\Response(
8950 * response="400",
8951 * ref="#/components/responses/badrequest"
8952 * ),
8953 * @OA\Response(
8954 * response="401",
8955 * ref="#/components/responses/unauthorized"
8956 * ),
8957 * security={{"openemr_auth":{}}}
8958 * )
8959 */
8960 "GET /fhir/DiagnosticReport" => function (HttpRestRequest $request) {
8961 $getParams = $request->getQueryParams();
8962 if ($request->isPatientRequest()) {
8963 // only allow access to data of binded patient
8964 $return = (new FhirDiagnosticReportRestController())->getAll($getParams, $request->getPatientUUIDString());
8965 } else {
8966 RestConfig::authorization_check("admin", "super");
8967 $return = (new FhirDiagnosticReportRestController())->getAll($getParams);
8968 }
8969 RestConfig::apiLog($return);
8970 return $return;
8971 },
8972
8973 /**
8974 * @OA\Get(
8975 * path="/fhir/DiagnosticReport/{uuid}",
8976 * description="Returns a single DiagnosticReport resource.",
8977 * tags={"fhir"},
8978 * @OA\Parameter(
8979 * name="uuid",
8980 * in="path",
8981 * description="The uuid for the DiagnosticReport resource.",
8982 * required=true,
8983 * @OA\Schema(
8984 * type="string"
8985 * )
8986 * ),
8987 * @OA\Response(
8988 * response="200",
8989 * description="Standard Response",
8990 * @OA\MediaType(
8991 * mediaType="application/json",
8992 * @OA\Schema(
8993 * @OA\Property(
8994 * property="json object",
8995 * description="FHIR Json object.",
8996 * type="object"
8997 * ),
8998 * example={
8999 * "id": "93fb2d6a-77ac-48ca-a12d-1a17e40007e3",
9000 * "meta": {
9001 * "versionId": "1",
9002 * "lastUpdated": "2021-09-18T20:52:34+00:00"
9003 * },
9004 * "resourceType": "DiagnosticReport",
9005 * "status": "final",
9006 * "category": {
9007 * {
9008 * "coding": {
9009 * {
9010 * "system": "http://loinc.org",
9011 * "code": "LP7839-6",
9012 * "display": "Pathology"
9013 * }
9014 * }
9015 * }
9016 * },
9017 * "code": {
9018 * "coding": {
9019 * {
9020 * "system": "http://loinc.org",
9021 * "code": "11502-2",
9022 * "display": "Laboratory report"
9023 * }
9024 * }
9025 * },
9026 * "subject": {
9027 * "reference": "Patient/9353b8f5-0a87-4e2a-afd4-25341fdb0fbc",
9028 * "type": "Patient"
9029 * },
9030 * "encounter": {
9031 * "reference": "Encounter/93540818-cb5f-49df-b73b-83901bb793b6",
9032 * "type": "Encounter"
9033 * },
9034 * "effectiveDateTime": "2015-06-22T00:00:00+00:00",
9035 * "issued": "2015-06-22T00:00:00+00:00",
9036 * "performer": {
9037 * {
9038 * "reference": "Organization/935249b5-0ba6-4b5b-8863-a7a27d4c6350",
9039 * "type": "Organization"
9040 * }
9041 * },
9042 * "presentedForm": {
9043 * {
9044 * "contentType": "text/plain",
9045 * "data": "TXMgQWxpY2UgTmV3bWFuIHdhcyB0ZXN0ZWQgZm9yIHRoZSBVcmluYW5hbHlzaXMgbWFjcm8gcGFuZWwgYW5kIHRoZSByZXN1bHRzIGhhdmUgYmVlbiBmb3VuZCB0byBiZSANCm5vcm1hbC4="
9046 * }
9047 * }
9048 * }
9049 * )
9050 * )
9051 * ),
9052 * @OA\Response(
9053 * response="400",
9054 * ref="#/components/responses/badrequest"
9055 * ),
9056 * @OA\Response(
9057 * response="401",
9058 * ref="#/components/responses/unauthorized"
9059 * ),
9060 * @OA\Response(
9061 * response="404",
9062 * ref="#/components/responses/uuidnotfound"
9063 * ),
9064 * security={{"openemr_auth":{}}}
9065 * )
9066 */
9067 "GET /fhir/DiagnosticReport/:uuid" => function ($uuid, HttpRestRequest $request) {
9068 $getParams = $request->getQueryParams();
9069 if ($request->isPatientRequest()) {
9070 // only allow access to data of binded patient
9071 $return = (new FhirDiagnosticReportRestController())->getOne($uuid, $request->getPatientUUIDString());
9072 } else {
9073 RestConfig::authorization_check("admin", "super");
9074 $return = (new FhirDiagnosticReportRestController())->getOne($uuid);
9075 }
9076 RestConfig::apiLog($return);
9077 return $return;
9078 },
9079
9080 /**
9081 * @OA\Get(
9082 * path="/fhir/DocumentReference",
9083 * description="Returns a list of DocumentReference resources.",
9084 * tags={"fhir"},
9085 * @OA\Parameter(
9086 * name="_id",
9087 * in="query",
9088 * description="The uuid for the DocumentReference resource.",
9089 * required=false,
9090 * @OA\Schema(
9091 * type="string"
9092 * )
9093 * ),
9094 * @OA\Parameter(
9095 * name="_lastUpdated",
9096 * in="query",
9097 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9098 * required=false,
9099 * @OA\Schema(
9100 * type="string"
9101 * )
9102 * ),
9103 * @OA\Parameter(
9104 * name="patient",
9105 * in="query",
9106 * description="The uuid for the patient.",
9107 * required=false,
9108 * @OA\Schema(
9109 * type="string"
9110 * )
9111 * ),
9112 * @OA\Parameter(
9113 * name="type",
9114 * in="query",
9115 * description="The type of the DocumentReference resource.",
9116 * required=false,
9117 * @OA\Schema(
9118 * type="string"
9119 * )
9120 * ),
9121 * @OA\Parameter(
9122 * name="category",
9123 * in="query",
9124 * description="The category of the DocumentReference resource.",
9125 * required=false,
9126 * @OA\Schema(
9127 * type="string"
9128 * )
9129 * ),
9130 * @OA\Parameter(
9131 * name="date",
9132 * in="query",
9133 * description="The datetime of the DocumentReference resource.",
9134 * required=false,
9135 * @OA\Schema(
9136 * type="string"
9137 * )
9138 * ),
9139 * @OA\Response(
9140 * response="200",
9141 * description="Standard Response",
9142 * @OA\MediaType(
9143 * mediaType="application/json",
9144 * @OA\Schema(
9145 * @OA\Property(
9146 * property="json object",
9147 * description="FHIR Json object.",
9148 * type="object"
9149 * ),
9150 * example={
9151 * "meta": {
9152 * "lastUpdated": "2021-09-14T09:13:51"
9153 * },
9154 * "resourceType": "Bundle",
9155 * "type": "collection",
9156 * "total": 0,
9157 * "link": {
9158 * {
9159 * "relation": "self",
9160 * "url": "https://localhost:9300/apis/default/fhir/DocumentReference"
9161 * }
9162 * }
9163 * }
9164 * )
9165 * )
9166 * ),
9167 * @OA\Response(
9168 * response="400",
9169 * ref="#/components/responses/badrequest"
9170 * ),
9171 * @OA\Response(
9172 * response="401",
9173 * ref="#/components/responses/unauthorized"
9174 * ),
9175 * security={{"openemr_auth":{}}}
9176 * )
9177 */
9178 'GET /fhir/DocumentReference' => function (HttpRestRequest $request) {
9179 $getParams = $request->getQueryParams();
9180 if ($request->isPatientRequest()) {
9181 // only allow access to data of binded patient
9182 $return = (new FhirDocumentReferenceRestController($request))->getAll($getParams, $request->getPatientUUIDString());
9183 } else {
9184 RestConfig::authorization_check("admin", "super");
9185 $return = (new FhirDocumentReferenceRestController($request))->getAll($getParams);
9186 }
9187 RestConfig::apiLog($return);
9188 return $return;
9189 },
9190
9191 /**
9192 * @OA\POST(
9193 * path="/fhir/DocumentReference/$docref",
9194 * description="The $docref operation is used to request the server generates a document based on the specified parameters. If no additional parameters are specified then a DocumentReference to the patient's most current Clinical Summary of Care Document (CCD) is returned. The document itself is retrieved using the DocumentReference.content.attachment.url element. See <a href='http://hl7.org/fhir/us/core/OperationDefinition-docref.html' target='_blank' rel='noopener'>http://hl7.org/fhir/us/core/OperationDefinition-docref.html</a> for more details.",
9195 * tags={"fhir"},
9196 * @OA\ExternalDocumentation(description="Detailed documentation on this operation", url="https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API"),
9197 * @OA\Parameter(
9198 * name="patient",
9199 * in="query",
9200 * description="The uuid for the patient.",
9201 * required=true,
9202 * @OA\Schema(
9203 * type="string"
9204 * )
9205 * ),
9206 * @OA\Parameter(
9207 * name="start",
9208 * in="query",
9209 * description="The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no start date is provided then all documents prior to the end date are in scope. If no start and end date are provided, the most recent or current document is in scope.",
9210 * required=false,
9211 * @OA\Schema(
9212 * type="string"
9213 * )
9214 * ),
9215 * @OA\Parameter(
9216 * name="end",
9217 * in="query",
9218 * description="The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no end date is provided then all documents subsequent to the start date are in scope. If no start and end date are provided, the most recent or current document is in scope.",
9219 * required=false,
9220 * @OA\Schema(
9221 * type="string"
9222 * )
9223 * ),
9224 * @OA\Parameter(
9225 * name="type",
9226 * in="query",
9227 * description="The type refers to the document type. This is a LOINC code from the valueset of <a href='http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html' target='_blank' rel='noopener'>http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html</a>. The server currently only supports the LOINC code of 34133-9 (Summary of episode node).",
9228 * required=false,
9229 * @OA\Schema(
9230 * type="string"
9231 * )
9232 * ),
9233 * @OA\Response(
9234 * response="200",
9235 * description="A search bundle of DocumentReferences is returned"
9236 * ),
9237 * @OA\Response(
9238 * response="400",
9239 * ref="#/components/responses/badrequest"
9240 * ),
9241 * @OA\Response(
9242 * response="401",
9243 * ref="#/components/responses/unauthorized"
9244 * ),
9245 * security={{"openemr_auth":{}}}
9246 * )
9247 */
9248 'POST /fhir/DocumentReference/$docref' => function (HttpRestRequest $request) {
9249
9250 // NOTE: The order of this route is IMPORTANT as it needs to come before the DocumentReference single request.
9251 if ($request->isPatientRequest()) {
9252 // only allow access to data of binded patient
9253 $return = (new FhirOperationDocRefRestController($request))->getAll($request->getQueryParams(), $request->getPatientUUIDString());
9254 } else {
9255 // TODO: it seems like regular users should be able to grab authorship / provenance information
9256 RestConfig::authorization_check("patients", "demo");
9257 $return = (new FhirOperationDocRefRestController($request))->getAll($request->getQueryParams());
9258 }
9259 RestConfig::apiLog($return);
9260 return $return;
9261 },
9262
9263 /**
9264 * @OA\Get(
9265 * path="/fhir/DocumentReference/{uuid}",
9266 * description="Returns a single DocumentReference resource.",
9267 * tags={"fhir"},
9268 * @OA\Parameter(
9269 * name="uuid",
9270 * in="path",
9271 * description="The uuid for the DocumentReference resource.",
9272 * required=true,
9273 * @OA\Schema(
9274 * type="string"
9275 * )
9276 * ),
9277 * @OA\Response(
9278 * response="200",
9279 * description="Standard Response",
9280 * @OA\MediaType(
9281 * mediaType="application/json",
9282 * @OA\Schema(
9283 * @OA\Property(
9284 * property="json object",
9285 * description="FHIR Json object.",
9286 * type="object"
9287 * ),
9288 * example={
9289 * "id": "946e7553-1aaa-49f8-8f81-ae15ccaa9165",
9290 * "meta": {
9291 * "versionId": "1",
9292 * "lastUpdated": "2021-09-19T03:17:51+00:00"
9293 * },
9294 * "resourceType": "DocumentReference",
9295 * "identifier": {
9296 * {
9297 * "value": "946e7553-1aaa-49f8-8f81-ae15ccaa9165"
9298 * }
9299 * },
9300 * "status": "current",
9301 * "type": {
9302 * "coding": {
9303 * {
9304 * "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
9305 * "code": "UNK",
9306 * "display": "unknown"
9307 * }
9308 * }
9309 * },
9310 * "category": {
9311 * {
9312 * "coding": {
9313 * {
9314 * "system": "https://localhost:9300/apis/default/fhir/ValueSet/openemr-document-types",
9315 * "code": "openemr-document",
9316 * "display": "OpenEMR Document"
9317 * }
9318 * }
9319 * }
9320 * },
9321 * "subject": {
9322 * "reference": "Patient/946da619-c631-431a-a282-487cd6fb7802",
9323 * "type": "Patient"
9324 * },
9325 * "date": "2021-09-19T03:15:56+00:00",
9326 * "author": {
9327 * null
9328 * },
9329 * "content": {
9330 * {
9331 * "attachment": {
9332 * "contentType": "image/gif",
9333 * "url": "https://localhost:9300/apis/default/fhir/Binary/7"
9334 * },
9335 * "format": {
9336 * "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
9337 * "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
9338 * "display": "mimeType Sufficient"
9339 * }
9340 * }
9341 * }
9342 * }
9343 * )
9344 * )
9345 * ),
9346 * @OA\Response(
9347 * response="400",
9348 * ref="#/components/responses/badrequest"
9349 * ),
9350 * @OA\Response(
9351 * response="401",
9352 * ref="#/components/responses/unauthorized"
9353 * ),
9354 * @OA\Response(
9355 * response="404",
9356 * ref="#/components/responses/uuidnotfound"
9357 * ),
9358 * security={{"openemr_auth":{}}}
9359 * )
9360 */
9361 "GET /fhir/DocumentReference/:uuid" => function ($uuid, HttpRestRequest $request) {
9362 $getParams = $request->getQueryParams();
9363 if ($request->isPatientRequest()) {
9364 // only allow access to data of binded patient
9365 $return = (new FhirDocumentReferenceRestController($request))->getOne($uuid, $request->getPatientUUIDString());
9366 } else {
9367 RestConfig::authorization_check("admin", "super");
9368 $return = (new FhirDocumentReferenceRestController($request))->getOne($uuid);
9369 }
9370 RestConfig::apiLog($return);
9371 return $return;
9372 },
9373
9374 /**
9375 * @OA\Get(
9376 * path="/fhir/Binary/{id}",
9377 * description="Used for downloading binary documents generated either with BULK FHIR Export or with the $docref CCD export operation. Documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
9378 * tags={"fhir"},
9379 * @OA\Parameter(
9380 * name="id",
9381 * in="path",
9382 * description="The id for the Document.",
9383 * required=true,
9384 * @OA\Schema(
9385 * type="string"
9386 * )
9387 * ),
9388 * @OA\Response(
9389 * response="200",
9390 * description="The documentation for working with BULK FHIR or $docref document exports can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
9391 * ),
9392 * @OA\Response(
9393 * response="400",
9394 * ref="#/components/responses/badrequest"
9395 * ),
9396 * @OA\Response(
9397 * response="401",
9398 * ref="#/components/responses/unauthorized"
9399 * ),
9400 * security={{"openemr_auth":{}}}
9401 * )
9402 */
9403 'GET /fhir/Binary/:id' => function ($documentId, HttpRestRequest $request) {
9404 $docController = new \OpenEMR\RestControllers\FHIR\FhirDocumentRestController($request);
9405
9406 if ($request->isPatientRequest()) {
9407 $response = $docController->downloadDocument($documentId, $request->getPatientUUIDString());
9408 } else {
9409 RestConfig::authorization_check("admin", "users");
9410 $response = $docController->downloadDocument($documentId);
9411 }
9412
9413 return $response;
9414 },
9415
9416 /**
9417 * @OA\Get(
9418 * path="/fhir/Encounter",
9419 * description="Returns a list of Encounter resources.",
9420 * tags={"fhir"},
9421 * @OA\Parameter(
9422 * name="_id",
9423 * in="query",
9424 * description="The uuid for the Encounter resource.",
9425 * required=false,
9426 * @OA\Schema(
9427 * type="string"
9428 * )
9429 * ),
9430 * @OA\Parameter(
9431 * name="_lastUpdated",
9432 * in="query",
9433 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9434 * required=false,
9435 * @OA\Schema(
9436 * type="string"
9437 * )
9438 * ),
9439 * @OA\Parameter(
9440 * name="patient",
9441 * in="query",
9442 * description="The uuid for the patient.",
9443 * required=false,
9444 * @OA\Schema(
9445 * type="string"
9446 * )
9447 * ),
9448 * @OA\Parameter(
9449 * name="date",
9450 * in="query",
9451 * description="The datetime of the Encounter resource.",
9452 * required=false,
9453 * @OA\Schema(
9454 * type="string"
9455 * )
9456 * ),
9457 * @OA\Response(
9458 * response="200",
9459 * description="Standard Response",
9460 * @OA\MediaType(
9461 * mediaType="application/json",
9462 * @OA\Schema(
9463 * @OA\Property(
9464 * property="json object",
9465 * description="FHIR Json object.",
9466 * type="object"
9467 * ),
9468 * example={
9469 * "meta": {
9470 * "lastUpdated": "2021-09-14T09:13:51"
9471 * },
9472 * "resourceType": "Bundle",
9473 * "type": "collection",
9474 * "total": 0,
9475 * "link": {
9476 * {
9477 * "relation": "self",
9478 * "url": "https://localhost:9300/apis/default/fhir/Encounter"
9479 * }
9480 * }
9481 * }
9482 * )
9483 * )
9484 * ),
9485 * @OA\Response(
9486 * response="400",
9487 * ref="#/components/responses/badrequest"
9488 * ),
9489 * @OA\Response(
9490 * response="401",
9491 * ref="#/components/responses/unauthorized"
9492 * ),
9493 * security={{"openemr_auth":{}}}
9494 * )
9495 */
9496 "GET /fhir/Encounter" => function (HttpRestRequest $request) {
9497 $getParams = $request->getQueryParams();
9498 if ($request->isPatientRequest()) {
9499 // only allow access to data of binded patient
9500 $return = (new FhirEncounterRestController())->getAll($getParams, $request->getPatientUUIDString());
9501 } else {
9502 RestConfig::authorization_check("encounters", "auth_a");
9503 $return = (new FhirEncounterRestController())->getAll($getParams);
9504 }
9505 RestConfig::apiLog($return);
9506 return $return;
9507 },
9508
9509 /**
9510 * @OA\Get(
9511 * path="/fhir/Encounter/{uuid}",
9512 * description="Returns a single Encounter resource.",
9513 * tags={"fhir"},
9514 * @OA\Parameter(
9515 * name="uuid",
9516 * in="path",
9517 * description="The uuid for the Encounter resource.",
9518 * required=true,
9519 * @OA\Schema(
9520 * type="string"
9521 * )
9522 * ),
9523 * @OA\Response(
9524 * response="200",
9525 * description="Standard Response",
9526 * @OA\MediaType(
9527 * mediaType="application/json",
9528 * @OA\Schema(
9529 * @OA\Property(
9530 * property="json object",
9531 * description="FHIR Json object.",
9532 * type="object"
9533 * ),
9534 * example={
9535 * "id": "946da61d-6b95-4f8e-abe5-534a25913b71",
9536 * "meta": {
9537 * "versionId": "1",
9538 * "lastUpdated": "2021-09-19T06:27:41+00:00"
9539 * },
9540 * "resourceType": "Encounter",
9541 * "identifier": {
9542 * {
9543 * "system": "urn:ietf:rfc:3986",
9544 * "value": "946da61d-6b95-4f8e-abe5-534a25913b71"
9545 * }
9546 * },
9547 * "status": "finished",
9548 * "class": {
9549 * "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
9550 * "code": "AMB",
9551 * "display": "ambulatory"
9552 * },
9553 * "type": {
9554 * {
9555 * "coding": {
9556 * {
9557 * "system": "http://snomed.info/sct",
9558 * "code": "185349003",
9559 * "display": "Encounter for check up (procedure)"
9560 * }
9561 * }
9562 * }
9563 * },
9564 * "subject": {
9565 * "reference": "Patient/946da61b-626b-4f88-81e2-adfb88f4f0fe",
9566 * "type": "Patient"
9567 * },
9568 * "participant": {
9569 * {
9570 * "type": {
9571 * {
9572 * "coding": {
9573 * {
9574 * "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
9575 * "code": "PPRF",
9576 * "display": "Primary Performer"
9577 * }
9578 * }
9579 * }
9580 * },
9581 * "period": {
9582 * "start": "2012-08-13T00:00:00+00:00"
9583 * },
9584 * "individual": {
9585 * "reference": "Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b",
9586 * "type": "Practitioner"
9587 * }
9588 * }
9589 * },
9590 * "period": {
9591 * "start": "2012-08-13T00:00:00+00:00"
9592 * }
9593 * }
9594 * )
9595 * )
9596 * ),
9597 * @OA\Response(
9598 * response="400",
9599 * ref="#/components/responses/badrequest"
9600 * ),
9601 * @OA\Response(
9602 * response="401",
9603 * ref="#/components/responses/unauthorized"
9604 * ),
9605 * @OA\Response(
9606 * response="404",
9607 * ref="#/components/responses/uuidnotfound"
9608 * ),
9609 * security={{"openemr_auth":{}}}
9610 * )
9611 */
9612 "GET /fhir/Encounter/:uuid" => function ($uuid, HttpRestRequest $request) {
9613 if ($request->isPatientRequest()) {
9614 // only allow access to data of binded patient
9615 $return = (new FhirEncounterRestController())->getOne($uuid, $request->getPatientUUIDString());
9616 } else {
9617 RestConfig::authorization_check("admin", "super");
9618 $return = (new FhirEncounterRestController())->getOne($uuid);
9619 }
9620 RestConfig::apiLog($return);
9621 return $return;
9622 },
9623
9624 /**
9625 * @OA\Get(
9626 * path="/fhir/Goal",
9627 * description="Returns a list of Condition resources.",
9628 * tags={"fhir"},
9629 * @OA\Parameter(
9630 * name="_id",
9631 * in="query",
9632 * description="The uuid for the Goal resource.",
9633 * required=false,
9634 * @OA\Schema(
9635 * type="string"
9636 * )
9637 * ),
9638 * @OA\Parameter(
9639 * name="_lastUpdated",
9640 * in="query",
9641 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9642 * required=false,
9643 * @OA\Schema(
9644 * type="string"
9645 * )
9646 * ),
9647 * @OA\Parameter(
9648 * name="patient",
9649 * in="query",
9650 * description="The uuid for the patient.",
9651 * required=false,
9652 * @OA\Schema(
9653 * type="string"
9654 * )
9655 * ),
9656 * @OA\Response(
9657 * response="200",
9658 * description="Standard Response",
9659 * @OA\MediaType(
9660 * mediaType="application/json",
9661 * @OA\Schema(
9662 * @OA\Property(
9663 * property="json object",
9664 * description="FHIR Json object.",
9665 * type="object"
9666 * ),
9667 * example={
9668 * "meta": {
9669 * "lastUpdated": "2021-09-14T09:13:51"
9670 * },
9671 * "resourceType": "Bundle",
9672 * "type": "collection",
9673 * "total": 0,
9674 * "link": {
9675 * {
9676 * "relation": "self",
9677 * "url": "https://localhost:9300/apis/default/fhir/Goal"
9678 * }
9679 * }
9680 * }
9681 * )
9682 * )
9683 * ),
9684 * @OA\Response(
9685 * response="400",
9686 * ref="#/components/responses/badrequest"
9687 * ),
9688 * @OA\Response(
9689 * response="401",
9690 * ref="#/components/responses/unauthorized"
9691 * ),
9692 * security={{"openemr_auth":{}}}
9693 * )
9694 */
9695 "GET /fhir/Goal" => function (HttpRestRequest $request) {
9696 $getParams = $request->getQueryParams();
9697 if ($request->isPatientRequest()) {
9698 // only allow access to data of binded patient
9699 $return = (new FhirGoalRestController())->getAll($getParams, $request->getPatientUUIDString());
9700 } else {
9701 RestConfig::authorization_check("admin", "super");
9702 $return = (new FhirGoalRestController())->getAll($getParams);
9703 }
9704 RestConfig::apiLog($return);
9705 return $return;
9706 },
9707
9708 /**
9709 * @OA\Get(
9710 * path="/fhir/Goal/{uuid}",
9711 * description="Returns a single Goal resource.",
9712 * tags={"fhir"},
9713 * @OA\Parameter(
9714 * name="uuid",
9715 * in="path",
9716 * description="The uuid for the Goal resource.",
9717 * required=true,
9718 * @OA\Schema(
9719 * type="string"
9720 * )
9721 * ),
9722 * @OA\Response(
9723 * response="200",
9724 * description="Standard Response",
9725 * @OA\MediaType(
9726 * mediaType="application/json",
9727 * @OA\Schema(
9728 * @OA\Property(
9729 * property="json object",
9730 * description="FHIR Json object.",
9731 * type="object"
9732 * ),
9733 * example={
9734 * "id": "946da61d-6b88-4d54-bdd6-4029e2ad9e3f_1",
9735 * "meta": {
9736 * "versionId": "1",
9737 * "lastUpdated": "2021-09-19T06:45:58+00:00"
9738 * },
9739 * "resourceType": "Goal",
9740 * "lifecycleStatus": "active",
9741 * "description": {
9742 * "text": "Eating more vegetables."
9743 * },
9744 * "subject": {
9745 * "reference": "Patient/946da619-c631-431a-a282-487cd6fb7802",
9746 * "type": "Patient"
9747 * },
9748 * "target": {
9749 * {
9750 * "measure": {
9751 * "extension": {
9752 * {
9753 * "valueCode": "unknown",
9754 * "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
9755 * }
9756 * }
9757 * },
9758 * "detailString": "Eating more vegetables.",
9759 * "dueDate": "2021-09-09"
9760 * }
9761 * }
9762 * }
9763 * )
9764 * )
9765 * ),
9766 * @OA\Response(
9767 * response="400",
9768 * ref="#/components/responses/badrequest"
9769 * ),
9770 * @OA\Response(
9771 * response="401",
9772 * ref="#/components/responses/unauthorized"
9773 * ),
9774 * @OA\Response(
9775 * response="404",
9776 * ref="#/components/responses/uuidnotfound"
9777 * ),
9778 * security={{"openemr_auth":{}}}
9779 * )
9780 */
9781 "GET /fhir/Goal/:uuid" => function ($uuid, HttpRestRequest $request) {
9782 if ($request->isPatientRequest()) {
9783 // only allow access to data of binded patient
9784 $return = (new FhirGoalRestController())->getOne($uuid, $request->getPatientUUIDString());
9785 } else {
9786 RestConfig::authorization_check("admin", "super");
9787 $return = (new FhirGoalRestController())->getOne($uuid);
9788 }
9789 RestConfig::apiLog($return);
9790 return $return;
9791 },
9792
9793 /**
9794 * @OA\Get(
9795 * path="/fhir/Group",
9796 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
9797 * tags={"fhir"},
9798 * @OA\Parameter(
9799 * name="_id",
9800 * in="query",
9801 * description="The uuid for the Group resource.",
9802 * required=false,
9803 * @OA\Schema(
9804 * type="string"
9805 * )
9806 * ),
9807 * @OA\Parameter(
9808 * name="_lastUpdated",
9809 * in="query",
9810 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9811 * required=false,
9812 * @OA\Schema(
9813 * type="string"
9814 * )
9815 * ),
9816 * @OA\Parameter(
9817 * name="patient",
9818 * in="query",
9819 * description="The uuid for the patient.",
9820 * required=false,
9821 * @OA\Schema(
9822 * type="string"
9823 * )
9824 * ),
9825 * @OA\Response(
9826 * response="200",
9827 * description="Standard Response",
9828 * @OA\MediaType(
9829 * mediaType="application/json",
9830 * @OA\Schema(
9831 * @OA\Property(
9832 * property="json object",
9833 * description="FHIR Json object.",
9834 * type="object"
9835 * ),
9836 * example={
9837 * "meta": {
9838 * "lastUpdated": "2021-09-14T09:13:51"
9839 * },
9840 * "resourceType": "Bundle",
9841 * "type": "collection",
9842 * "total": 0,
9843 * "link": {
9844 * {
9845 * "relation": "self",
9846 * "url": "https://localhost:9300/apis/default/fhir/Group"
9847 * }
9848 * }
9849 * }
9850 * )
9851 * )
9852 * ),
9853 * @OA\Response(
9854 * response="400",
9855 * ref="#/components/responses/badrequest"
9856 * ),
9857 * @OA\Response(
9858 * response="401",
9859 * ref="#/components/responses/unauthorized"
9860 * ),
9861 * security={{"openemr_auth":{}}}
9862 * )
9863 */
9864 'GET /fhir/Group' => function (HttpRestRequest $request) {
9865 RestConfig::authorization_check("admin", "users");
9866 $getParams = $request->getQueryParams();
9867 if ($request->isPatientRequest()) {
9868 // only allow access to data of binded patient
9869 $return = (new FhirGroupRestController())->getAll($getParams, $request->getPatientUUIDString());
9870 } else {
9871 $return = (new FhirGroupRestController())->getAll($getParams);
9872 }
9873 RestConfig::apiLog($return);
9874 return $return;
9875 },
9876
9877 /**
9878 * @OA\Get(
9879 * path="/fhir/Group/{uuid}",
9880 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
9881 * tags={"fhir"},
9882 * @OA\Parameter(
9883 * name="uuid",
9884 * in="path",
9885 * description="The uuid for the Group resource.",
9886 * required=true,
9887 * @OA\Schema(
9888 * type="string"
9889 * )
9890 * ),
9891 * @OA\Response(
9892 * response="200",
9893 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
9894 * ),
9895 * @OA\Response(
9896 * response="400",
9897 * ref="#/components/responses/badrequest"
9898 * ),
9899 * @OA\Response(
9900 * response="401",
9901 * ref="#/components/responses/unauthorized"
9902 * ),
9903 * @OA\Response(
9904 * response="404",
9905 * ref="#/components/responses/uuidnotfound"
9906 * ),
9907 * security={{"openemr_auth":{}}}
9908 * )
9909 */
9910 "GET /fhir/Group/:uuid" => function ($uuid, HttpRestRequest $request) {
9911 RestConfig::authorization_check("admin", "users");
9912 if ($request->isPatientRequest()) {
9913 // only allow access to data of binded patient
9914 $return = (new FhirGroupRestController())->getOne($uuid, $request->getPatientUUIDString());
9915 } else {
9916 $return = (new FhirGroupRestController())->getOne($uuid);
9917 }
9918 RestConfig::apiLog($return);
9919 return $return;
9920 },
9921
9922 /**
9923 * @OA\Get(
9924 * path="/fhir/Group/{id}/$export",
9925 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
9926 * tags={"fhir"},
9927 * @OA\Parameter(
9928 * name="id",
9929 * in="path",
9930 * description="The id for the Group resource.",
9931 * required=true,
9932 * @OA\Schema(
9933 * type="string"
9934 * )
9935 * ),
9936 * @OA\Response(
9937 * response="200",
9938 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
9939 * ),
9940 * @OA\Response(
9941 * response="400",
9942 * ref="#/components/responses/badrequest"
9943 * ),
9944 * @OA\Response(
9945 * response="401",
9946 * ref="#/components/responses/unauthorized"
9947 * ),
9948 * security={{"openemr_auth":{}}}
9949 * )
9950 */
9951 'GET /fhir/Group/:id/$export' => function ($groupId, HttpRestRequest $request) {
9952 RestConfig::authorization_check("admin", "users");
9953 $fhirExportService = new FhirOperationExportRestController($request);
9954 $exportParams = $request->getQueryParams();
9955 $exportParams['groupId'] = $groupId;
9956 $return = $fhirExportService->processExport(
9957 $exportParams,
9958 'Group',
9959 $request->getHeader('Accept')[0] ?? '',
9960 $request->getHeader('Prefer')[0] ?? ''
9961 );
9962 RestConfig::apiLog($return);
9963 return $return;
9964 },
9965
9966 /**
9967 * @OA\Get(
9968 * path="/fhir/Immunization",
9969 * description="Returns a list of Immunization resources.",
9970 * tags={"fhir"},
9971 * @OA\Parameter(
9972 * name="_id",
9973 * in="query",
9974 * description="The uuid for the Immunization resource.",
9975 * required=false,
9976 * @OA\Schema(
9977 * type="string"
9978 * )
9979 * ),
9980 * @OA\Parameter(
9981 * name="_lastUpdated",
9982 * in="query",
9983 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9984 * required=false,
9985 * @OA\Schema(
9986 * type="string"
9987 * )
9988 * ),
9989 * @OA\Parameter(
9990 * name="_lastUpdated",
9991 * in="query",
9992 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
9993 * required=false,
9994 * @OA\Schema(
9995 * type="string"
9996 * )
9997 * ),
9998 * @OA\Parameter(
9999 * name="patient",
10000 * in="query",
10001 * description="The uuid for the patient.",
10002 * required=false,
10003 * @OA\Schema(
10004 * type="string"
10005 * )
10006 * ),
10007 * @OA\Response(
10008 * response="200",
10009 * description="Standard Response",
10010 * @OA\MediaType(
10011 * mediaType="application/json",
10012 * @OA\Schema(
10013 * @OA\Property(
10014 * property="json object",
10015 * description="FHIR Json object.",
10016 * type="object"
10017 * ),
10018 * example={
10019 * "meta": {
10020 * "lastUpdated": "2021-09-14T09:13:51"
10021 * },
10022 * "resourceType": "Bundle",
10023 * "type": "collection",
10024 * "total": 0,
10025 * "link": {
10026 * {
10027 * "relation": "self",
10028 * "url": "https://localhost:9300/apis/default/fhir/Immunization"
10029 * }
10030 * }
10031 * }
10032 * )
10033 * )
10034 * ),
10035 * @OA\Response(
10036 * response="400",
10037 * ref="#/components/responses/badrequest"
10038 * ),
10039 * @OA\Response(
10040 * response="401",
10041 * ref="#/components/responses/unauthorized"
10042 * ),
10043 * security={{"openemr_auth":{}}}
10044 * )
10045 */
10046 "GET /fhir/Immunization" => function (HttpRestRequest $request) {
10047 $getParams = $request->getQueryParams();
10048 if ($request->isPatientRequest()) {
10049 // only allow access to data of binded patient
10050 $return = (new FhirImmunizationRestController())->getAll($getParams, $request->getPatientUUIDString());
10051 } else {
10052 RestConfig::authorization_check("patients", "med");
10053 $return = (new FhirImmunizationRestController())->getAll($getParams);
10054 }
10055 RestConfig::apiLog($return);
10056 return $return;
10057 },
10058
10059 /**
10060 * @OA\Get(
10061 * path="/fhir/Immunization/{uuid}",
10062 * description="Returns a single Immunization resource.",
10063 * tags={"fhir"},
10064 * @OA\Parameter(
10065 * name="uuid",
10066 * in="path",
10067 * description="The uuid for the Immunization resource.",
10068 * required=true,
10069 * @OA\Schema(
10070 * type="string"
10071 * )
10072 * ),
10073 * @OA\Response(
10074 * response="200",
10075 * description="Standard Response",
10076 * @OA\MediaType(
10077 * mediaType="application/json",
10078 * @OA\Schema(
10079 * @OA\Property(
10080 * property="json object",
10081 * description="FHIR Json object.",
10082 * type="object"
10083 * ),
10084 * example={
10085 * "id": "95e8d8b7-e3e2-4e03-8eb1-31e1d9097d8f",
10086 * "meta": {
10087 * "versionId": "1",
10088 * "lastUpdated": "2022-03-26T05:42:59+00:00"
10089 * },
10090 * "resourceType": "Immunization",
10091 * "status": "completed",
10092 * "vaccineCode": {
10093 * "coding": {
10094 * {
10095 * "system": "http://hl7.org/fhir/sid/cvx",
10096 * "code": "207",
10097 * "display": "SARS-COV-2 (COVID-19) vaccine, mRNA, spike protein, LNP, preservative free, 100 mcg/0.5mL dose"
10098 * }
10099 * }
10100 * },
10101 * "patient": {
10102 * "reference": "Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf"
10103 * },
10104 * "occurrenceDateTime": "2022-03-26T05:35:00+00:00",
10105 * "recorded": "2022-03-26T05:42:26+00:00",
10106 * "primarySource": false
10107 * }
10108 * )
10109 * )
10110 * ),
10111 * @OA\Response(
10112 * response="400",
10113 * ref="#/components/responses/badrequest"
10114 * ),
10115 * @OA\Response(
10116 * response="401",
10117 * ref="#/components/responses/unauthorized"
10118 * ),
10119 * @OA\Response(
10120 * response="404",
10121 * ref="#/components/responses/uuidnotfound"
10122 * ),
10123 * security={{"openemr_auth":{}}}
10124 * )
10125 */
10126 "GET /fhir/Immunization/:uuid" => function ($uuid, HttpRestRequest $request) {
10127 if ($request->isPatientRequest()) {
10128 // only allow access to data of binded patient
10129 $return = (new FhirImmunizationRestController())->getOne($uuid, $request->getPatientUUIDString());
10130 } else {
10131 RestConfig::authorization_check("patients", "med");
10132 $return = (new FhirImmunizationRestController())->getOne($uuid);
10133 }
10134 RestConfig::apiLog($return);
10135 return $return;
10136 },
10137
10138 /**
10139 * @OA\Get(
10140 * path="/fhir/Location",
10141 * description="Returns a list of Location resources.",
10142 * tags={"fhir"},
10143 * @OA\Parameter(
10144 * name="_id",
10145 * in="query",
10146 * description="The uuid for the Location resource.",
10147 * required=false,
10148 * @OA\Schema(
10149 * type="string"
10150 * )
10151 * ),
10152 * @OA\Parameter(
10153 * name="_lastUpdated",
10154 * in="query",
10155 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
10156 * required=false,
10157 * @OA\Schema(
10158 * type="string"
10159 * )
10160 * ),
10161 * @OA\Response(
10162 * response="200",
10163 * description="Standard Response",
10164 * @OA\MediaType(
10165 * mediaType="application/json",
10166 * @OA\Schema(
10167 * @OA\Property(
10168 * property="json object",
10169 * description="FHIR Json object.",
10170 * type="object"
10171 * ),
10172 * example={
10173 * "meta": {
10174 * "lastUpdated": "2021-09-14T09:13:51"
10175 * },
10176 * "resourceType": "Bundle",
10177 * "type": "collection",
10178 * "total": 0,
10179 * "link": {
10180 * {
10181 * "relation": "self",
10182 * "url": "https://localhost:9300/apis/default/fhir/Location"
10183 * }
10184 * }
10185 * }
10186 * )
10187 * )
10188 * ),
10189 * @OA\Response(
10190 * response="400",
10191 * ref="#/components/responses/badrequest"
10192 * ),
10193 * @OA\Response(
10194 * response="401",
10195 * ref="#/components/responses/unauthorized"
10196 * ),
10197 * security={{"openemr_auth":{}}}
10198 * )
10199 */
10200 "GET /fhir/Location" => function (HttpRestRequest $request) {
10201 $return = (new FhirLocationRestController())->getAll($request->getQueryParams(), $request->getPatientUUIDString());
10202 RestConfig::apiLog($return);
10203 return $return;
10204 },
10205
10206 /**
10207 * @OA\Get(
10208 * path="/fhir/Location/{uuid}",
10209 * description="Returns a single Location resource.",
10210 * tags={"fhir"},
10211 * @OA\Parameter(
10212 * name="uuid",
10213 * in="path",
10214 * description="The uuid for the Location resource.",
10215 * required=true,
10216 * @OA\Schema(
10217 * type="string"
10218 * )
10219 * ),
10220 * @OA\Response(
10221 * response="200",
10222 * description="Standard Response",
10223 * @OA\MediaType(
10224 * mediaType="application/json",
10225 * @OA\Schema(
10226 * @OA\Property(
10227 * property="json object",
10228 * description="FHIR Json object.",
10229 * type="object"
10230 * ),
10231 * example={
10232 * "id": "946da61d-c4f2-4f03-a2a7-b571f6a24b65",
10233 * "meta": {
10234 * "versionId": "1",
10235 * "lastUpdated": "2021-09-19T08:14:58+00:00"
10236 * },
10237 * "resourceType": "Location",
10238 * "status": "active",
10239 * "name": "Your Clinic Name Here",
10240 * "telecom": {
10241 * {
10242 * "system": "phone",
10243 * "value": "000-000-0000"
10244 * },
10245 * {
10246 * "system": "fax",
10247 * "value": "000-000-0000"
10248 * }
10249 * }
10250 * }
10251 * )
10252 * )
10253 * ),
10254 * @OA\Response(
10255 * response="400",
10256 * ref="#/components/responses/badrequest"
10257 * ),
10258 * @OA\Response(
10259 * response="401",
10260 * ref="#/components/responses/unauthorized"
10261 * ),
10262 * @OA\Response(
10263 * response="404",
10264 * ref="#/components/responses/uuidnotfound"
10265 * ),
10266 * security={{"openemr_auth":{}}}
10267 * )
10268 */
10269 "GET /fhir/Location/:uuid" => function ($uuid, HttpRestRequest $request) {
10270 $return = (new FhirLocationRestController())->getOne($uuid, $request->getPatientUUIDString());
10271 RestConfig::apiLog($return);
10272 return $return;
10273 },
10274
10275 /**
10276 * @OA\Get(
10277 * path="/fhir/Medication",
10278 * description="Returns a list of Medication resources.",
10279 * tags={"fhir"},
10280 * @OA\Parameter(
10281 * name="_id",
10282 * in="query",
10283 * description="The uuid for the Medication resource.",
10284 * required=false,
10285 * @OA\Schema(
10286 * type="string"
10287 * )
10288 * ),
10289 * @OA\Parameter(
10290 * name="_lastUpdated",
10291 * in="query",
10292 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
10293 * required=false,
10294 * @OA\Schema(
10295 * type="string"
10296 * )
10297 * ),
10298 * @OA\Response(
10299 * response="200",
10300 * description="Standard Response",
10301 * @OA\MediaType(
10302 * mediaType="application/json",
10303 * @OA\Schema(
10304 * @OA\Property(
10305 * property="json object",
10306 * description="FHIR Json object.",
10307 * type="object"
10308 * ),
10309 * example={
10310 * "meta": {
10311 * "lastUpdated": "2021-09-14T09:13:51"
10312 * },
10313 * "resourceType": "Bundle",
10314 * "type": "collection",
10315 * "total": 0,
10316 * "link": {
10317 * {
10318 * "relation": "self",
10319 * "url": "https://localhost:9300/apis/default/fhir/Medication"
10320 * }
10321 * }
10322 * }
10323 * )
10324 * )
10325 * ),
10326 * @OA\Response(
10327 * response="400",
10328 * ref="#/components/responses/badrequest"
10329 * ),
10330 * @OA\Response(
10331 * response="401",
10332 * ref="#/components/responses/unauthorized"
10333 * ),
10334 * security={{"openemr_auth":{}}}
10335 * )
10336 */
10337 "GET /fhir/Medication" => function (HttpRestRequest $request) {
10338 RestConfig::authorization_check("patients", "med");
10339 $return = (new FhirMedicationRestController())->getAll($request->getQueryParams());
10340 RestConfig::apiLog($return);
10341 return $return;
10342 },
10343
10344 /**
10345 * @OA\Get(
10346 * path="/fhir/Medication/{uuid}",
10347 * description="Returns a single Medication resource.",
10348 * tags={"fhir"},
10349 * @OA\Parameter(
10350 * name="uuid",
10351 * in="path",
10352 * description="The uuid for the Medication resource.",
10353 * required=true,
10354 * @OA\Schema(
10355 * type="string"
10356 * )
10357 * ),
10358 * @OA\Response(
10359 * response="200",
10360 * description="Standard Response",
10361 * @OA\MediaType(
10362 * mediaType="application/json",
10363 * @OA\Schema(
10364 * @OA\Property(
10365 * property="json object",
10366 * description="FHIR Json object.",
10367 * type="object"
10368 * ),
10369 * example={
10370 * "id": "961aa334-9348-4145-8252-de665e3c4afa",
10371 * "meta": {
10372 * "versionId": "1",
10373 * "lastUpdated": "2022-04-19T23:42:14+00:00"
10374 * },
10375 * "resourceType": "Medication",
10376 * "code": {
10377 * "coding": {
10378 * {
10379 * "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
10380 * "code": 153165
10381 * }
10382 * }
10383 * },
10384 * "status": "active",
10385 * "batch": {
10386 * "lotNumber": "132",
10387 * "expirationDate": "0000-00-00"
10388 * }
10389 * }
10390 * )
10391 * )
10392 * ),
10393 * @OA\Response(
10394 * response="400",
10395 * ref="#/components/responses/badrequest"
10396 * ),
10397 * @OA\Response(
10398 * response="401",
10399 * ref="#/components/responses/unauthorized"
10400 * ),
10401 * @OA\Response(
10402 * response="404",
10403 * ref="#/components/responses/uuidnotfound"
10404 * ),
10405 * security={{"openemr_auth":{}}}
10406 * )
10407 */
10408 "GET /fhir/Medication/:uuid" => function ($uuid, HttpRestRequest $request) {
10409 if ($request->isPatientRequest()) {
10410 // only allow access to data of binded patient
10411 $return = (new FhirMedicationRestController())->getOne($uuid, $request->getPatientUUIDString());
10412 } else {
10413 RestConfig::authorization_check("patients", "med");
10414 $return = (new FhirMedicationRestController())->getOne($uuid);
10415 }
10416 RestConfig::apiLog($return);
10417 return $return;
10418 },
10419
10420 /**
10421 * @OA\Get(
10422 * path="/fhir/MedicationRequest",
10423 * description="Returns a list of MedicationRequest resources.",
10424 * tags={"fhir"},
10425 * @OA\Parameter(
10426 * name="_id",
10427 * in="query",
10428 * description="The uuid for the MedicationRequest resource.",
10429 * required=false,
10430 * @OA\Schema(
10431 * type="string"
10432 * )
10433 * ),
10434 * @OA\Parameter(
10435 * name="_lastUpdated",
10436 * in="query",
10437 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
10438 * required=false,
10439 * @OA\Schema(
10440 * type="string"
10441 * )
10442 * ),
10443 * @OA\Parameter(
10444 * name="patient",
10445 * in="query",
10446 * description="The uuid for the patient.",
10447 * required=false,
10448 * @OA\Schema(
10449 * type="string"
10450 * )
10451 * ),
10452 * @OA\Parameter(
10453 * name="intent",
10454 * in="query",
10455 * description="The intent of the MedicationRequest resource.",
10456 * required=false,
10457 * @OA\Schema(
10458 * type="string"
10459 * )
10460 * ),
10461 * @OA\Parameter(
10462 * name="status",
10463 * in="query",
10464 * description="The status of the MedicationRequest resource.",
10465 * required=false,
10466 * @OA\Schema(
10467 * type="string"
10468 * )
10469 * ),
10470 * @OA\Response(
10471 * response="200",
10472 * description="Standard Response",
10473 * @OA\MediaType(
10474 * mediaType="application/json",
10475 * @OA\Schema(
10476 * @OA\Property(
10477 * property="json object",
10478 * description="FHIR Json object.",
10479 * type="object"
10480 * ),
10481 * example={
10482 * "meta": {
10483 * "lastUpdated": "2021-09-14T09:13:51"
10484 * },
10485 * "resourceType": "Bundle",
10486 * "type": "collection",
10487 * "total": 0,
10488 * "link": {
10489 * {
10490 * "relation": "self",
10491 * "url": "https://localhost:9300/apis/default/fhir/MedicationRequest"
10492 * }
10493 * }
10494 * }
10495 * )
10496 * )
10497 * ),
10498 * @OA\Response(
10499 * response="400",
10500 * ref="#/components/responses/badrequest"
10501 * ),
10502 * @OA\Response(
10503 * response="401",
10504 * ref="#/components/responses/unauthorized"
10505 * ),
10506 * security={{"openemr_auth":{}}}
10507 * )
10508 */
10509 "GET /fhir/MedicationRequest" => function (HttpRestRequest $request) {
10510 $getParams = $request->getQueryParams();
10511 if ($request->isPatientRequest()) {
10512 // only allow access to data of binded patient
10513 $return = (new FhirMedicationRequestRestController())->getAll($getParams, $request->getPatientUUIDString());
10514 } else {
10515 RestConfig::authorization_check("patients", "med");
10516 $return = (new FhirMedicationRequestRestController())->getAll($getParams);
10517 }
10518 RestConfig::apiLog($return);
10519 return $return;
10520 },
10521
10522 /**
10523 * @OA\Get(
10524 * path="/fhir/MedicationRequest/{uuid}",
10525 * description="Returns a single MedicationRequest resource.",
10526 * tags={"fhir"},
10527 * @OA\Parameter(
10528 * name="uuid",
10529 * in="path",
10530 * description="The uuid for the MedicationRequest resource.",
10531 * required=true,
10532 * @OA\Schema(
10533 * type="string"
10534 * )
10535 * ),
10536 * @OA\Response(
10537 * response="200",
10538 * description="Standard Response",
10539 * @OA\MediaType(
10540 * mediaType="application/json",
10541 * @OA\Schema(
10542 * @OA\Property(
10543 * property="json object",
10544 * description="FHIR Json object.",
10545 * type="object"
10546 * ),
10547 * example={
10548 * "id": "946da61d-9cff-4416-8d27-805f19f9d7d8",
10549 * "meta": {
10550 * "versionId": "1",
10551 * "lastUpdated": "2021-09-20T04:03:14+00:00"
10552 * },
10553 * "resourceType": "MedicationRequest",
10554 * "status": "active",
10555 * "intent": "order",
10556 * "category": {
10557 * {
10558 * "coding": {
10559 * {
10560 * "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
10561 * "code": "community",
10562 * "display": "Home/Community"
10563 * }
10564 * }
10565 * }
10566 * },
10567 * "reportedBoolean": false,
10568 * "medicationCodeableConcept": {
10569 * "coding": {
10570 * {
10571 * "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
10572 * "code": "1738139",
10573 * "display": "Acetaminophen 325 MG Oral Tablet"
10574 * }
10575 * }
10576 * },
10577 * "subject": {
10578 * "reference": "Patient/946da617-1a4a-4b2c-ae66-93b84377cb1e",
10579 * "type": "Patient"
10580 * },
10581 * "authoredOn": "2021-09-18T00:00:00+00:00",
10582 * "requester": {
10583 * "reference": "Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b",
10584 * "type": "Practitioner"
10585 * }
10586 * }
10587 * )
10588 * )
10589 * ),
10590 * @OA\Response(
10591 * response="400",
10592 * ref="#/components/responses/badrequest"
10593 * ),
10594 * @OA\Response(
10595 * response="401",
10596 * ref="#/components/responses/unauthorized"
10597 * ),
10598 * @OA\Response(
10599 * response="404",
10600 * ref="#/components/responses/uuidnotfound"
10601 * ),
10602 * security={{"openemr_auth":{}}}
10603 * )
10604 */
10605 "GET /fhir/MedicationRequest/:uuid" => function ($uuid, HttpRestRequest $request) {
10606 if ($request->isPatientRequest()) {
10607 // only allow access to data of binded patient
10608 $return = (new FhirMedicationRequestRestController())->getOne($uuid, $request->getPatientUUIDString());
10609 } else {
10610 RestConfig::authorization_check("patients", "med");
10611 $return = (new FhirMedicationRequestRestController())->getOne($uuid);
10612 }
10613 RestConfig::apiLog($return);
10614 return $return;
10615 },
10616
10617 /**
10618 * @OA\Get(
10619 * path="/fhir/Observation",
10620 * description="Returns a list of Observation resources.",
10621 * tags={"fhir"},
10622 * @OA\Parameter(
10623 * name="_id",
10624 * in="query",
10625 * description="The uuid for the Observation resource.",
10626 * required=false,
10627 * @OA\Schema(
10628 * type="string"
10629 * )
10630 * ),
10631 * @OA\Parameter(
10632 * name="_lastUpdated",
10633 * in="query",
10634 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
10635 * required=false,
10636 * @OA\Schema(
10637 * type="string"
10638 * )
10639 * ),
10640 * @OA\Parameter(
10641 * name="patient",
10642 * in="query",
10643 * description="The uuid for the patient.",
10644 * required=false,
10645 * @OA\Schema(
10646 * type="string"
10647 * )
10648 * ),
10649 * @OA\Parameter(
10650 * name="code",
10651 * in="query",
10652 * description="The code of the Observation resource.",
10653 * required=false,
10654 * @OA\Schema(
10655 * type="string"
10656 * )
10657 * ),
10658 * @OA\Parameter(
10659 * name="category",
10660 * in="query",
10661 * description="The category of the Observation resource.",
10662 * required=false,
10663 * @OA\Schema(
10664 * type="string"
10665 * )
10666 * ),
10667 * @OA\Parameter(
10668 * name="date",
10669 * in="query",
10670 * description="The datetime of the Observation resource.",
10671 * required=false,
10672 * @OA\Schema(
10673 * type="string"
10674 * )
10675 * ),
10676 * @OA\Response(
10677 * response="200",
10678 * description="Standard Response",
10679 * @OA\MediaType(
10680 * mediaType="application/json",
10681 * @OA\Schema(
10682 * @OA\Property(
10683 * property="json object",
10684 * description="FHIR Json object.",
10685 * type="object"
10686 * ),
10687 * example={
10688 * "meta": {
10689 * "lastUpdated": "2021-09-14T09:13:51"
10690 * },
10691 * "resourceType": "Bundle",
10692 * "type": "collection",
10693 * "total": 0,
10694 * "link": {
10695 * {
10696 * "relation": "self",
10697 * "url": "https://localhost:9300/apis/default/fhir/Observation"
10698 * }
10699 * }
10700 * }
10701 * )
10702 * )
10703 * ),
10704 * @OA\Response(
10705 * response="400",
10706 * ref="#/components/responses/badrequest"
10707 * ),
10708 * @OA\Response(
10709 * response="401",
10710 * ref="#/components/responses/unauthorized"
10711 * ),
10712 * security={{"openemr_auth":{}}}
10713 * )
10714 */
10715 "GET /fhir/Observation" => function (HttpRestRequest $request) {
10716 $getParams = $request->getQueryParams();
10717 if ($request->isPatientRequest()) {
10718 // only allow access to data of binded patient
10719 $return = (new FhirObservationRestController())->getAll($getParams, $request->getPatientUUIDString());
10720 } else {
10721 RestConfig::authorization_check("patients", "med");
10722 $return = (new FhirObservationRestController())->getAll($getParams);
10723 }
10724 RestConfig::apiLog($return);
10725 return $return;
10726 },
10727
10728 /**
10729 * @OA\Get(
10730 * path="/fhir/Observation/{uuid}",
10731 * description="Returns a single Observation resource.",
10732 * tags={"fhir"},
10733 * @OA\Parameter(
10734 * name="uuid",
10735 * in="path",
10736 * description="The uuid for the Observation resource.",
10737 * required=true,
10738 * @OA\Schema(
10739 * type="string"
10740 * )
10741 * ),
10742 * @OA\Response(
10743 * response="200",
10744 * description="Standard Response",
10745 * @OA\MediaType(
10746 * mediaType="application/json",
10747 * @OA\Schema(
10748 * @OA\Property(
10749 * property="json object",
10750 * description="FHIR Json object.",
10751 * type="object"
10752 * ),
10753 * example={
10754 * "id": "946da61e-0597-485e-9dfd-a87205ea56b3",
10755 * "meta": {
10756 * "versionId": "1",
10757 * "lastUpdated": "2021-09-20T04:12:16+00:00"
10758 * },
10759 * "resourceType": "Observation",
10760 * "status": "final",
10761 * "category": {
10762 * {
10763 * "coding": {
10764 * {
10765 * "system": "http://terminology.hl7.org/CodeSystem/observation-category",
10766 * "code": "vital-signs"
10767 * }
10768 * }
10769 * }
10770 * },
10771 * "code": {
10772 * "coding": {
10773 * {
10774 * "system": "http://loinc.org",
10775 * "code": "85354-9",
10776 * "display": "Blood pressure systolic and diastolic"
10777 * }
10778 * }
10779 * },
10780 * "subject": {
10781 * "reference": "Patient/946da619-c631-431a-a282-487cd6fb7802",
10782 * "type": "Patient"
10783 * },
10784 * "effectiveDateTime": "2015-08-31T00:00:00+00:00",
10785 * "component": {
10786 * {
10787 * "code": {
10788 * "coding": {
10789 * {
10790 * "system": "http://loinc.org",
10791 * "code": "8480-6",
10792 * "display": "Systolic blood pressure"
10793 * }
10794 * }
10795 * },
10796 * "valueQuantity": {
10797 * "value": 122,
10798 * "unit": "mm[Hg]",
10799 * "system": "http://unitsofmeasure.org",
10800 * "code": "mm[Hg]"
10801 * }
10802 * },
10803 * {
10804 * "code": {
10805 * "coding": {
10806 * {
10807 * "system": "http://loinc.org",
10808 * "code": "8462-4",
10809 * "display": "Diastolic blood pressure"
10810 * }
10811 * }
10812 * },
10813 * "valueQuantity": {
10814 * "value": 77,
10815 * "unit": "mm[Hg]",
10816 * "system": "http://unitsofmeasure.org",
10817 * "code": "mm[Hg]"
10818 * }
10819 * }
10820 * }
10821 * }
10822 * )
10823 * )
10824 * ),
10825 * @OA\Response(
10826 * response="400",
10827 * ref="#/components/responses/badrequest"
10828 * ),
10829 * @OA\Response(
10830 * response="401",
10831 * ref="#/components/responses/unauthorized"
10832 * ),
10833 * @OA\Response(
10834 * response="404",
10835 * ref="#/components/responses/uuidnotfound"
10836 * ),
10837 * security={{"openemr_auth":{}}}
10838 * )
10839 */
10840 "GET /fhir/Observation/:uuid" => function ($uuid, HttpRestRequest $request) {
10841 if ($request->isPatientRequest()) {
10842 // only allow access to data of binded patient
10843 $return = (new FhirObservationRestController())->getOne($uuid, $request->getPatientUUIDString());
10844 } else {
10845 RestConfig::authorization_check("patients", "med");
10846 $return = (new FhirObservationRestController())->getOne($uuid);
10847 }
10848 RestConfig::apiLog($return);
10849 return $return;
10850 },
10851
10852 /**
10853 * @OA\Get(
10854 * path="/fhir/Organization",
10855 * description="Returns a list of Organization resources.",
10856 * tags={"fhir"},
10857 * @OA\Parameter(
10858 * name="_id",
10859 * in="query",
10860 * description="The uuid for the Organization resource.",
10861 * required=false,
10862 * @OA\Schema(
10863 * type="string"
10864 * )
10865 * ),
10866 * @OA\Parameter(
10867 * name="_lastUpdated",
10868 * in="query",
10869 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
10870 * required=false,
10871 * @OA\Schema(
10872 * type="string"
10873 * )
10874 * ),
10875 * @OA\Parameter(
10876 * name="name",
10877 * in="query",
10878 * description="The name of the Organization resource.",
10879 * required=false,
10880 * @OA\Schema(
10881 * type="string"
10882 * )
10883 * ),
10884 * @OA\Parameter(
10885 * name="email",
10886 * in="query",
10887 * description="The email of the Organization resource.",
10888 * required=false,
10889 * @OA\Schema(
10890 * type="string"
10891 * )
10892 * ),
10893 * @OA\Parameter(
10894 * name="phone",
10895 * in="query",
10896 * description="The phone of the Organization resource.",
10897 * required=false,
10898 * @OA\Schema(
10899 * type="string"
10900 * )
10901 * ),
10902 * @OA\Parameter(
10903 * name="telecom",
10904 * in="query",
10905 * description="The telecom of the Organization resource.",
10906 * required=false,
10907 * @OA\Schema(
10908 * type="string"
10909 * )
10910 * ),
10911 * @OA\Parameter(
10912 * name="address",
10913 * in="query",
10914 * description="The address of the Organization resource.",
10915 * required=false,
10916 * @OA\Schema(
10917 * type="string"
10918 * )
10919 * ),
10920 * @OA\Parameter(
10921 * name="address-city",
10922 * in="query",
10923 * description="The address-city of the Organization resource.",
10924 * required=false,
10925 * @OA\Schema(
10926 * type="string"
10927 * )
10928 * ),
10929 * @OA\Parameter(
10930 * name="address-postalcode",
10931 * in="query",
10932 * description="The address-postalcode of the Organization resource.",
10933 * required=false,
10934 * @OA\Schema(
10935 * type="string"
10936 * )
10937 * ),
10938 * @OA\Parameter(
10939 * name="address-state",
10940 * in="query",
10941 * description="The address-state of the Organization resource.",
10942 * required=false,
10943 * @OA\Schema(
10944 * type="string"
10945 * )
10946 * ),
10947 * @OA\Response(
10948 * response="200",
10949 * description="Standard Response",
10950 * @OA\MediaType(
10951 * mediaType="application/json",
10952 * @OA\Schema(
10953 * @OA\Property(
10954 * property="json object",
10955 * description="FHIR Json object.",
10956 * type="object"
10957 * ),
10958 * example={
10959 * "meta": {
10960 * "lastUpdated": "2021-09-14T09:13:51"
10961 * },
10962 * "resourceType": "Bundle",
10963 * "type": "collection",
10964 * "total": 0,
10965 * "link": {
10966 * {
10967 * "relation": "self",
10968 * "url": "https://localhost:9300/apis/default/fhir/Organization"
10969 * }
10970 * }
10971 * }
10972 * )
10973 * )
10974 * ),
10975 * @OA\Response(
10976 * response="400",
10977 * ref="#/components/responses/badrequest"
10978 * ),
10979 * @OA\Response(
10980 * response="401",
10981 * ref="#/components/responses/unauthorized"
10982 * ),
10983 * security={{"openemr_auth":{}}}
10984 * )
10985 */
10986 "GET /fhir/Organization" => function (HttpRestRequest $request) {
10987 if (!$request->isPatientRequest()) {
10988 RestConfig::authorization_check("admin", "users");
10989 }
10990 $return = (new FhirOrganizationRestController())->getAll($request->getQueryParams());
10991 RestConfig::apiLog($return);
10992 return $return;
10993 },
10994
10995 /**
10996 * @OA\Get(
10997 * path="/fhir/Organization/{uuid}",
10998 * description="Returns a single Organization resource.",
10999 * tags={"fhir"},
11000 * @OA\Parameter(
11001 * name="uuid",
11002 * in="path",
11003 * description="The uuid for the Organization resource.",
11004 * required=true,
11005 * @OA\Schema(
11006 * type="string"
11007 * )
11008 * ),
11009 * @OA\Response(
11010 * response="200",
11011 * description="Standard Response",
11012 * @OA\MediaType(
11013 * mediaType="application/json",
11014 * @OA\Schema(
11015 * @OA\Property(
11016 * property="json object",
11017 * description="FHIR Json object.",
11018 * type="object"
11019 * ),
11020 * example={
11021 * "id": "95f0e672-be37-4c73-95c9-649c2d200018",
11022 * "meta": {
11023 * "versionId": "1",
11024 * "lastUpdated": "2022-03-30T07:43:23+00:00"
11025 * },
11026 * "resourceType": "Organization",
11027 * "text": {
11028 * "status": "generated",
11029 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Your Clinic Name Here</p></div>"
11030 * },
11031 * "identifier": {
11032 * {
11033 * "system": "http://hl7.org/fhir/sid/us-npi",
11034 * "value": "1234567890"
11035 * }
11036 * },
11037 * "active": true,
11038 * "type": {
11039 * {
11040 * "coding": {
11041 * {
11042 * "system": "http://terminology.hl7.org/CodeSystem/organization-type",
11043 * "code": "prov",
11044 * "display": "Healthcare Provider"
11045 * }
11046 * }
11047 * }
11048 * },
11049 * "name": "Your Clinic Name Here",
11050 * "telecom": {
11051 * {
11052 * "system": "phone",
11053 * "value": "000-000-0000",
11054 * "use": "work"
11055 * },
11056 * {
11057 * "system": "fax",
11058 * "value": "000-000-0000",
11059 * "use": "work"
11060 * }
11061 * },
11062 * "address": {
11063 * null
11064 * }
11065 * }
11066 * )
11067 * )
11068 * ),
11069 * @OA\Response(
11070 * response="400",
11071 * ref="#/components/responses/badrequest"
11072 * ),
11073 * @OA\Response(
11074 * response="401",
11075 * ref="#/components/responses/unauthorized"
11076 * ),
11077 * @OA\Response(
11078 * response="404",
11079 * ref="#/components/responses/uuidnotfound"
11080 * ),
11081 * security={{"openemr_auth":{}}}
11082 * )
11083 */
11084 "GET /fhir/Organization/:uuid" => function ($uuid, HttpRestRequest $request) {
11085 $patientUUID = null;
11086 if (!$request->isPatientRequest()) {
11087 RestConfig::authorization_check("admin", "users");
11088 } else {
11089 $patientUUID = $request->getPatientUUIDString();
11090 }
11091 $return = (new FhirOrganizationRestController())->getOne($uuid, $patientUUID);
11092
11093 RestConfig::apiLog($return);
11094 return $return;
11095 },
11096
11097 /**
11098 * @OA\Post(
11099 * path="/fhir/Organization",
11100 * description="Adds a Organization resource.",
11101 * tags={"fhir"},
11102 * @OA\RequestBody(
11103 * required=true,
11104 * @OA\MediaType(
11105 * mediaType="application/json",
11106 * @OA\Schema(
11107 * description="The json object for the Organization resource.",
11108 * type="object"
11109 * ),
11110 * example={
11111 * "id": "95f0e672-be37-4c73-95c9-649c2d200018",
11112 * "meta": {
11113 * "versionId": "1",
11114 * "lastUpdated": "2022-03-30T07:43:23+00:00"
11115 * },
11116 * "resourceType": "Organization",
11117 * "text": {
11118 * "status": "generated",
11119 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Your Clinic Name Here</p></div>"
11120 * },
11121 * "identifier": {
11122 * {
11123 * "system": "http://hl7.org/fhir/sid/us-npi",
11124 * "value": "1234567890"
11125 * }
11126 * },
11127 * "active": true,
11128 * "type": {
11129 * {
11130 * "coding": {
11131 * {
11132 * "system": "http://terminology.hl7.org/CodeSystem/organization-type",
11133 * "code": "prov",
11134 * "display": "Healthcare Provider"
11135 * }
11136 * }
11137 * }
11138 * },
11139 * "name": "Your Clinic Name Here Hey",
11140 * "telecom": {
11141 * {
11142 * "system": "phone",
11143 * "value": "000-000-0000",
11144 * "use": "work"
11145 * },
11146 * {
11147 * "system": "fax",
11148 * "value": "000-000-0000",
11149 * "use": "work"
11150 * }
11151 * },
11152 * "address": {
11153 * null
11154 * }
11155 * }
11156 * )
11157 * ),
11158 * @OA\Response(
11159 * response="200",
11160 * description="Standard Response",
11161 * @OA\MediaType(
11162 * mediaType="application/json",
11163 * @OA\Schema(
11164 * @OA\Property(
11165 * property="json object",
11166 * description="FHIR Json object.",
11167 * type="object"
11168 * ),
11169 * example={
11170 * "id": "95f0e672-be37-4c73-95c9-649c2d200018",
11171 * "meta": {
11172 * "versionId": "1",
11173 * "lastUpdated": "2022-03-30T07:43:23+00:00"
11174 * },
11175 * "resourceType": "Organization",
11176 * "text": {
11177 * "status": "generated",
11178 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Your Clinic Name Here</p></div>"
11179 * },
11180 * "identifier": {
11181 * {
11182 * "system": "http://hl7.org/fhir/sid/us-npi",
11183 * "value": "1234567890"
11184 * }
11185 * },
11186 * "active": true,
11187 * "type": {
11188 * {
11189 * "coding": {
11190 * {
11191 * "system": "http://terminology.hl7.org/CodeSystem/organization-type",
11192 * "code": "prov",
11193 * "display": "Healthcare Provider"
11194 * }
11195 * }
11196 * }
11197 * },
11198 * "name": "Your Clinic Name Here Now",
11199 * "telecom": {
11200 * {
11201 * "system": "phone",
11202 * "value": "000-000-0000",
11203 * "use": "work"
11204 * },
11205 * {
11206 * "system": "fax",
11207 * "value": "000-000-0000",
11208 * "use": "work"
11209 * }
11210 * },
11211 * "address": {
11212 * null
11213 * }
11214 * }
11215 * )
11216 * )
11217 * ),
11218 * @OA\Response(
11219 * response="400",
11220 * ref="#/components/responses/badrequest"
11221 * ),
11222 * @OA\Response(
11223 * response="401",
11224 * ref="#/components/responses/unauthorized"
11225 * ),
11226 * security={{"openemr_auth":{}}}
11227 * )
11228 */
11229 "POST /fhir/Organization" => function (HttpRestRequest $request) {
11230 RestConfig::authorization_check("admin", "super");
11231 $data = (array) (json_decode(file_get_contents("php://input"), true));
11232 $return = (new FhirOrganizationRestController())->post($data);
11233 RestConfig::apiLog($return, $data);
11234 return $return;
11235 },
11236
11237 /**
11238 * @OA\Put(
11239 * path="/fhir/Organization/{uuid}",
11240 * description="Modifies a Organization resource.",
11241 * tags={"fhir"},
11242 * @OA\Parameter(
11243 * name="uuid",
11244 * in="path",
11245 * description="The uuid for the organization.",
11246 * required=true,
11247 * @OA\Schema(
11248 * type="string"
11249 * )
11250 * ),
11251 * @OA\RequestBody(
11252 * required=true,
11253 * @OA\MediaType(
11254 * mediaType="application/json",
11255 * @OA\Schema(
11256 * description="The json object for the Organization resource.",
11257 * type="object"
11258 * ),
11259 * example={
11260 * "id": "95f0e672-be37-4c73-95c9-649c2d200018",
11261 * "meta": {
11262 * "versionId": "1",
11263 * "lastUpdated": "2022-03-30T07:43:23+00:00"
11264 * },
11265 * "resourceType": "Organization",
11266 * "text": {
11267 * "status": "generated",
11268 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Your Clinic Name Here</p></div>"
11269 * },
11270 * "identifier": {
11271 * {
11272 * "system": "http://hl7.org/fhir/sid/us-npi",
11273 * "value": "1234567890"
11274 * }
11275 * },
11276 * "active": true,
11277 * "type": {
11278 * {
11279 * "coding": {
11280 * {
11281 * "system": "http://terminology.hl7.org/CodeSystem/organization-type",
11282 * "code": "prov",
11283 * "display": "Healthcare Provider"
11284 * }
11285 * }
11286 * }
11287 * },
11288 * "name": "Your Clinic Name Here",
11289 * "telecom": {
11290 * {
11291 * "system": "phone",
11292 * "value": "000-000-0000",
11293 * "use": "work"
11294 * },
11295 * {
11296 * "system": "fax",
11297 * "value": "000-000-0000",
11298 * "use": "work"
11299 * }
11300 * },
11301 * "address": {
11302 * null
11303 * }
11304 * }
11305 * )
11306 * ),
11307 * @OA\Response(
11308 * response="201",
11309 * description="Standard Response",
11310 * @OA\MediaType(
11311 * mediaType="application/json",
11312 * @OA\Schema(
11313 * example={
11314 * "id": 14,
11315 * "uuid": "95f217c1-258c-44ca-bf11-909dce369574"
11316 * }
11317 * )
11318 * )
11319 * ),
11320 * @OA\Response(
11321 * response="400",
11322 * ref="#/components/responses/badrequest"
11323 * ),
11324 * @OA\Response(
11325 * response="401",
11326 * ref="#/components/responses/unauthorized"
11327 * ),
11328 * security={{"openemr_auth":{}}}
11329 * )
11330 */
11331 "PUT /fhir/Organization/:uuid" => function ($uuid, HttpRestRequest $request) {
11332 RestConfig::authorization_check("admin", "super");
11333 $data = (array) (json_decode(file_get_contents("php://input"), true));
11334 $return = (new FhirOrganizationRestController())->patch($uuid, $data);
11335 RestConfig::apiLog($return, $data);
11336 return $return;
11337 },
11338
11339 /**
11340 * @OA\Post(
11341 * path="/fhir/Patient",
11342 * description="Adds a Patient resource.",
11343 * tags={"fhir"},
11344 * @OA\RequestBody(
11345 * required=true,
11346 * @OA\MediaType(
11347 * mediaType="application/json",
11348 * @OA\Schema(
11349 * description="The json object for the Patient resource.",
11350 * type="object"
11351 * ),
11352 * example={
11353 * "id": "95f22ff4-dd25-4290-8b52-1dd2fedf8e54",
11354 * "meta": {
11355 * "versionId": "1",
11356 * "lastUpdated": "2022-03-31T02:48:28+00:00"
11357 * },
11358 * "resourceType": "Patient",
11359 * "text": {
11360 * "status": "generated",
11361 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Brenda Smith</p></div>"
11362 * },
11363 * "extension": {
11364 * {
11365 * "valueCode": "F",
11366 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
11367 * },
11368 * {
11369 * "extension": {
11370 * {
11371 * "valueCoding": {
11372 * "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
11373 * "code": "UNK",
11374 * "display": "Unknown"
11375 * },
11376 * "url": "ombCategory"
11377 * },
11378 * {
11379 * "valueString": "Unknown",
11380 * "url": "text"
11381 * }
11382 * },
11383 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
11384 * }
11385 * },
11386 * "identifier": {
11387 * {
11388 * "use": "official",
11389 * "type": {
11390 * "coding": {
11391 * {
11392 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11393 * "code": "PT"
11394 * }
11395 * }
11396 * },
11397 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11398 * "value": "1"
11399 * }
11400 * },
11401 * "active": true,
11402 * "name": {
11403 * {
11404 * "use": "official",
11405 * "family": "Smith",
11406 * "given": {
11407 * "Brenda"
11408 * }
11409 * }
11410 * },
11411 * "gender": "female",
11412 * "birthDate": "2017-03-10",
11413 * "communication": {
11414 * {
11415 * "language": {
11416 * "coding": {
11417 * {
11418 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
11419 * "code": "unknown",
11420 * "display": "Unknown"
11421 * }
11422 * }
11423 * }
11424 * }
11425 * }
11426 * }
11427 * )
11428 * ),
11429 * @OA\Response(
11430 * response="200",
11431 * description="Standard Response",
11432 * @OA\MediaType(
11433 * mediaType="application/json",
11434 * @OA\Schema(
11435 * @OA\Property(
11436 * property="json object",
11437 * description="FHIR Json object.",
11438 * type="object"
11439 * ),
11440 * example={
11441 * "id": "95f22ff4-dd25-4290-8b52-1dd2fedf8e54",
11442 * "meta": {
11443 * "versionId": "1",
11444 * "lastUpdated": "2022-03-31T02:48:28+00:00"
11445 * },
11446 * "resourceType": "Patient",
11447 * "text": {
11448 * "status": "generated",
11449 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Brenda Smith</p></div>"
11450 * },
11451 * "extension": {
11452 * {
11453 * "valueCode": "F",
11454 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
11455 * },
11456 * {
11457 * "extension": {
11458 * {
11459 * "valueCoding": {
11460 * "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
11461 * "code": "UNK",
11462 * "display": "Unknown"
11463 * },
11464 * "url": "ombCategory"
11465 * },
11466 * {
11467 * "valueString": "Unknown",
11468 * "url": "text"
11469 * }
11470 * },
11471 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
11472 * }
11473 * },
11474 * "identifier": {
11475 * {
11476 * "use": "official",
11477 * "type": {
11478 * "coding": {
11479 * {
11480 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11481 * "code": "PT"
11482 * }
11483 * }
11484 * },
11485 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11486 * "value": "1"
11487 * }
11488 * },
11489 * "active": true,
11490 * "name": {
11491 * {
11492 * "use": "official",
11493 * "family": "Smith",
11494 * "given": {
11495 * "Brenda"
11496 * }
11497 * }
11498 * },
11499 * "gender": "female",
11500 * "birthDate": "2017-03-10",
11501 * "communication": {
11502 * {
11503 * "language": {
11504 * "coding": {
11505 * {
11506 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
11507 * "code": "unknown",
11508 * "display": "Unknown"
11509 * }
11510 * }
11511 * }
11512 * }
11513 * }
11514 * }
11515 * )
11516 * )
11517 * ),
11518 * @OA\Response(
11519 * response="400",
11520 * ref="#/components/responses/badrequest"
11521 * ),
11522 * @OA\Response(
11523 * response="401",
11524 * ref="#/components/responses/unauthorized"
11525 * ),
11526 * security={{"openemr_auth":{}}}
11527 * )
11528 */
11529 "POST /fhir/Patient" => function (HttpRestRequest $request) {
11530 RestConfig::authorization_check("patients", "demo");
11531 $data = (array) (json_decode(file_get_contents("php://input"), true));
11532 $return = (new FhirPatientRestController())->post($data);
11533 RestConfig::apiLog($return, $data);
11534 return $return;
11535 },
11536
11537 /**
11538 * @OA\Put(
11539 * path="/fhir/Patient/{uuid}",
11540 * description="Modifies a Patient resource.",
11541 * tags={"fhir"},
11542 * @OA\Parameter(
11543 * name="uuid",
11544 * in="path",
11545 * description="The uuid for the Patient resource.",
11546 * required=true,
11547 * @OA\Schema(
11548 * type="string"
11549 * )
11550 * ),
11551 * @OA\RequestBody(
11552 * required=true,
11553 * @OA\MediaType(
11554 * mediaType="application/json",
11555 * @OA\Schema(
11556 * description="The json object for the Patient resource.",
11557 * type="object"
11558 * ),
11559 * example={
11560 * "id": "95f22ff4-dd25-4290-8b52-1dd2fedf8e54",
11561 * "meta": {
11562 * "versionId": "1",
11563 * "lastUpdated": "2022-03-31T02:48:28+00:00"
11564 * },
11565 * "resourceType": "Patient",
11566 * "text": {
11567 * "status": "generated",
11568 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Brenda Smith</p></div>"
11569 * },
11570 * "extension": {
11571 * {
11572 * "valueCode": "F",
11573 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
11574 * },
11575 * {
11576 * "extension": {
11577 * {
11578 * "valueCoding": {
11579 * "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
11580 * "code": "UNK",
11581 * "display": "Unknown"
11582 * },
11583 * "url": "ombCategory"
11584 * },
11585 * {
11586 * "valueString": "Unknown",
11587 * "url": "text"
11588 * }
11589 * },
11590 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
11591 * }
11592 * },
11593 * "identifier": {
11594 * {
11595 * "use": "official",
11596 * "type": {
11597 * "coding": {
11598 * {
11599 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11600 * "code": "PT"
11601 * }
11602 * }
11603 * },
11604 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11605 * "value": "1"
11606 * }
11607 * },
11608 * "active": true,
11609 * "name": {
11610 * {
11611 * "use": "official",
11612 * "family": "Smith",
11613 * "given": {
11614 * "Brenda"
11615 * }
11616 * }
11617 * },
11618 * "gender": "female",
11619 * "birthDate": "2017-03-10",
11620 * "communication": {
11621 * {
11622 * "language": {
11623 * "coding": {
11624 * {
11625 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
11626 * "code": "unknown",
11627 * "display": "Unknown"
11628 * }
11629 * }
11630 * }
11631 * }
11632 * }
11633 * }
11634 * )
11635 * ),
11636 * @OA\Response(
11637 * response="201",
11638 * description="Standard Response",
11639 * @OA\MediaType(
11640 * mediaType="application/json",
11641 * @OA\Schema(
11642 * example={
11643 * "id": 2,
11644 * "uuid": "95f2ad04-5834-4243-8838-e396a7faadbf"
11645 * }
11646 * )
11647 * )
11648 * ),
11649 * @OA\Response(
11650 * response="400",
11651 * ref="#/components/responses/badrequest"
11652 * ),
11653 * @OA\Response(
11654 * response="401",
11655 * ref="#/components/responses/unauthorized"
11656 * ),
11657 * security={{"openemr_auth":{}}}
11658 * )
11659 */
11660 "PUT /fhir/Patient/:uuid" => function ($uuid, HttpRestRequest $request) {
11661 RestConfig::authorization_check("patients", "demo");
11662 $data = (array) (json_decode(file_get_contents("php://input"), true));
11663 $return = (new FhirPatientRestController())->put($uuid, $data);
11664 RestConfig::apiLog($return, $data);
11665 return $return;
11666 },
11667
11668 /**
11669 * @OA\Get(
11670 * path="/fhir/Patient",
11671 * description="Returns a list of Patient resources.",
11672 * tags={"fhir"},
11673 * @OA\Parameter(
11674 * name="_id",
11675 * in="query",
11676 * description="The uuid for the Patient resource.",
11677 * required=false,
11678 * @OA\Schema(
11679 * type="string"
11680 * )
11681 * ),
11682 * @OA\Parameter(
11683 * name="_lastUpdated",
11684 * in="query",
11685 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
11686 * required=false,
11687 * @OA\Schema(
11688 * type="string"
11689 * )
11690 * ),
11691 * @OA\Parameter(
11692 * name="identifier",
11693 * in="query",
11694 * description="The identifier of the Patient resource.",
11695 * required=false,
11696 * @OA\Schema(
11697 * type="string"
11698 * )
11699 * ),
11700 * @OA\Parameter(
11701 * name="name",
11702 * in="query",
11703 * description="The name of the Patient resource.",
11704 * required=false,
11705 * @OA\Schema(
11706 * type="string"
11707 * )
11708 * ),
11709 * @OA\Parameter(
11710 * name="birthdate",
11711 * in="query",
11712 * description="The birthdate of the Patient resource.",
11713 * required=false,
11714 * @OA\Schema(
11715 * type="string"
11716 * )
11717 * ),
11718 * @OA\Parameter(
11719 * name="gender",
11720 * in="query",
11721 * description="The gender of the Patient resource.",
11722 * required=false,
11723 * @OA\Schema(
11724 * type="string"
11725 * )
11726 * ),
11727 * @OA\Parameter(
11728 * name="address",
11729 * in="query",
11730 * description="The address of the Patient resource.",
11731 * required=false,
11732 * @OA\Schema(
11733 * type="string"
11734 * )
11735 * ),
11736 * @OA\Parameter(
11737 * name="address-city",
11738 * in="query",
11739 * description="The address-city of the Patient resource.",
11740 * required=false,
11741 * @OA\Schema(
11742 * type="string"
11743 * )
11744 * ),
11745 * @OA\Parameter(
11746 * name="address-postalcode",
11747 * in="query",
11748 * description="The address-postalcode of the Patient resource.",
11749 * required=false,
11750 * @OA\Schema(
11751 * type="string"
11752 * )
11753 * ),
11754 * @OA\Parameter(
11755 * name="address-state",
11756 * in="query",
11757 * description="The address-state of the Patient resource.",
11758 * required=false,
11759 * @OA\Schema(
11760 * type="string"
11761 * )
11762 * ),
11763 * @OA\Parameter(
11764 * name="email",
11765 * in="query",
11766 * description="The email of the Patient resource.",
11767 * required=false,
11768 * @OA\Schema(
11769 * type="string"
11770 * )
11771 * ),
11772 * @OA\Parameter(
11773 * name="family",
11774 * in="query",
11775 * description="The family name of the Patient resource.",
11776 * required=false,
11777 * @OA\Schema(
11778 * type="string"
11779 * )
11780 * ),
11781 * @OA\Parameter(
11782 * name="given",
11783 * in="query",
11784 * description="The given name of the Patient resource.",
11785 * required=false,
11786 * @OA\Schema(
11787 * type="string"
11788 * )
11789 * ),
11790 * @OA\Parameter(
11791 * name="phone",
11792 * in="query",
11793 * description="The phone number of the Patient resource.",
11794 * required=false,
11795 * @OA\Schema(
11796 * type="string"
11797 * )
11798 * ),
11799 * @OA\Parameter(
11800 * name="telecom",
11801 * in="query",
11802 * description="The fax number of the Patient resource.",
11803 * required=false,
11804 * @OA\Schema(
11805 * type="string"
11806 * )
11807 * ),
11808 * @OA\Parameter(
11809 * ref="#/components/parameters/_lastUpdated"
11810 * ),
11811 * @OA\Response(
11812 * response="200",
11813 * description="Standard Response",
11814 * @OA\MediaType(
11815 * mediaType="application/json",
11816 * @OA\Schema(
11817 * @OA\Property(
11818 * property="json object",
11819 * description="FHIR Json object.",
11820 * type="object"
11821 * ),
11822 * example={
11823 * "meta": {
11824 * "lastUpdated": "2021-09-14T09:13:51"
11825 * },
11826 * "resourceType": "Bundle",
11827 * "type": "collection",
11828 * "total": 0,
11829 * "link": {
11830 * {
11831 * "relation": "self",
11832 * "url": "https://localhost:9300/apis/default/fhir/Patient"
11833 * }
11834 * }
11835 * }
11836 * )
11837 * )
11838 * ),
11839 * @OA\Response(
11840 * response="400",
11841 * ref="#/components/responses/badrequest"
11842 * ),
11843 * @OA\Response(
11844 * response="401",
11845 * ref="#/components/responses/unauthorized"
11846 * ),
11847 * security={{"openemr_auth":{}}}
11848 * )
11849 */
11850 "GET /fhir/Patient" => function (HttpRestRequest $request) {
11851 $params = $request->getQueryParams();
11852 if ($request->isPatientRequest()) {
11853 // only allow access to data of binded patient
11854 // Note in Patient context still have to return a bundle even if it is just one resource. (ie.
11855 // need to use getAll rather than getOne)
11856 $params['_id'] = $request->getPatientUUIDString();
11857 $return = (new FhirPatientRestController())->getAll($params, $request->getPatientUUIDString());
11858 } else {
11859 RestConfig::authorization_check("patients", "demo");
11860 $return = (new FhirPatientRestController())->getAll($params);
11861 }
11862 RestConfig::apiLog($return);
11863 return $return;
11864 },
11865
11866 /**
11867 * @OA\Get(
11868 * path="/fhir/Patient/$export",
11869 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
11870 * tags={"fhir"},
11871 * @OA\Response(
11872 * response="200",
11873 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
11874 * ),
11875 * @OA\Response(
11876 * response="400",
11877 * ref="#/components/responses/badrequest"
11878 * ),
11879 * @OA\Response(
11880 * response="401",
11881 * ref="#/components/responses/unauthorized"
11882 * ),
11883 * security={{"openemr_auth":{}}}
11884 * )
11885 */
11886 // we have to have the bulk fhir export operation here otherwise it will match $export to the patient $id
11887 'GET /fhir/Patient/$export' => function (HttpRestRequest $request) {
11888 RestConfig::authorization_check("admin", "users");
11889 $fhirExportService = new FhirOperationExportRestController($request);
11890 $return = $fhirExportService->processExport(
11891 $request->getQueryParams(),
11892 'Patient',
11893 $request->getHeader('Accept')[0] ?? '',
11894 $request->getHeader('Prefer')[0] ?? ''
11895 );
11896 RestConfig::apiLog($return);
11897 return $return;
11898 },
11899
11900 /**
11901 * @OA\Get(
11902 * path="/fhir/Patient/{uuid}",
11903 * description="Returns a single Patient resource.",
11904 * tags={"fhir"},
11905 * @OA\Parameter(
11906 * name="uuid",
11907 * in="path",
11908 * description="The uuid for the Patient resource.",
11909 * required=true,
11910 * @OA\Schema(
11911 * type="string"
11912 * )
11913 * ),
11914 * @OA\Response(
11915 * response="200",
11916 * description="Standard Response",
11917 * @OA\MediaType(
11918 * mediaType="application/json",
11919 * @OA\Schema(
11920 * @OA\Property(
11921 * property="json object",
11922 * description="FHIR Json object.",
11923 * type="object"
11924 * ),
11925 * example={
11926 * "id": "946da617-1a4a-4b2c-ae66-93b84377cb1e",
11927 * "meta": {
11928 * "versionId": "1",
11929 * "lastUpdated": "2021-09-21T17:08:03+00:00"
11930 * },
11931 * "resourceType": "Patient",
11932 * "text": {
11933 * "status": "generated",
11934 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""> <p>Aurore252 Von197</p></div>"
11935 * },
11936 * "extension": {
11937 * {
11938 * "valueCode": "F",
11939 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
11940 * },
11941 * {
11942 * "extension": {
11943 * {
11944 * "valueCoding": {
11945 * "system": "urn:oid:2.16.840.1.113883.6.238",
11946 * "code": "1006-6",
11947 * "display": "Abenaki"
11948 * },
11949 * "url": "ombCategory"
11950 * },
11951 * {
11952 * "valueString": "Abenaki",
11953 * "url": "text"
11954 * }
11955 * },
11956 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
11957 * },
11958 * {
11959 * "extension": {
11960 * {
11961 * "valueString": "Declined To Specify",
11962 * "url": "text"
11963 * }
11964 * },
11965 * "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
11966 * }
11967 * },
11968 * "identifier": {
11969 * {
11970 * "use": "official",
11971 * "type": {
11972 * "coding": {
11973 * {
11974 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11975 * "code": "PT"
11976 * }
11977 * }
11978 * },
11979 * "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
11980 * "value": "1"
11981 * }
11982 * },
11983 * "active": true,
11984 * "name": {
11985 * {
11986 * "use": "official",
11987 * "family": "Von197",
11988 * "given": {
11989 * "Aurore252"
11990 * }
11991 * }
11992 * },
11993 * "gender": "female",
11994 * "birthDate": "1970-07-03",
11995 * "address": {
11996 * {
11997 * "line": {
11998 * "245 Crona Wall"
11999 * },
12000 * "city": "Boston",
12001 * "state": "Massachusetts",
12002 * "postalCode": "02215",
12003 * "period": {
12004 * "start": "2020-09-21T17:08:03.532+00:00"
12005 * }
12006 * }
12007 * },
12008 * "communication": {
12009 * {
12010 * "language": {
12011 * "coding": {
12012 * {
12013 * "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
12014 * "code": "unknown",
12015 * "display": "Unknown"
12016 * }
12017 * }
12018 * }
12019 * }
12020 * }
12021 * }
12022 * )
12023 * )
12024 * ),
12025 * @OA\Response(
12026 * response="400",
12027 * ref="#/components/responses/badrequest"
12028 * ),
12029 * @OA\Response(
12030 * response="401",
12031 * ref="#/components/responses/unauthorized"
12032 * ),
12033 * @OA\Response(
12034 * response="404",
12035 * ref="#/components/responses/uuidnotfound"
12036 * ),
12037 * security={{"openemr_auth":{}}}
12038 * )
12039 */
12040 "GET /fhir/Patient/:uuid" => function ($uuid, HttpRestRequest $request) {
12041 if ($request->isPatientRequest()) {
12042 // only allow access to data of binded patient
12043 if (empty($uuid) || ($uuid != $request->getPatientUUIDString())) {
12044 throw new AccessDeniedException("patients", "demo", "patient id invalid");
12045 }
12046 $uuid = $request->getPatientUUIDString();
12047 } else {
12048 RestConfig::authorization_check("patients", "demo");
12049 }
12050 $return = (new FhirPatientRestController())->getOne($uuid);
12051 RestConfig::apiLog($return);
12052 return $return;
12053 },
12054
12055 /**
12056 * @OA\Get(
12057 * path="/fhir/Person",
12058 * description="Returns a list of Person resources.",
12059 * tags={"fhir"},
12060 * @OA\Parameter(
12061 * name="_id",
12062 * in="query",
12063 * description="The uuid for the Person resource.",
12064 * required=false,
12065 * @OA\Schema(
12066 * type="string"
12067 * )
12068 * ),
12069 * @OA\Parameter(
12070 * name="_lastUpdated",
12071 * in="query",
12072 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
12073 * required=false,
12074 * @OA\Schema(
12075 * type="string"
12076 * )
12077 * ),
12078 * @OA\Parameter(
12079 * name="name",
12080 * in="query",
12081 * description="The name of the Person resource.",
12082 * required=false,
12083 * @OA\Schema(
12084 * type="string"
12085 * )
12086 * ),
12087 * @OA\Parameter(
12088 * name="active",
12089 * in="query",
12090 * description="The active status of the Person resource.",
12091 * required=false,
12092 * @OA\Schema(
12093 * type="string"
12094 * )
12095 * ),
12096 * @OA\Parameter(
12097 * name="address",
12098 * in="query",
12099 * description="The address of the Person resource.",
12100 * required=false,
12101 * @OA\Schema(
12102 * type="string"
12103 * )
12104 * ),
12105 * @OA\Parameter(
12106 * name="address-city",
12107 * in="query",
12108 * description="The address-city of the Person resource.",
12109 * required=false,
12110 * @OA\Schema(
12111 * type="string"
12112 * )
12113 * ),
12114 * @OA\Parameter(
12115 * name="address-postalcode",
12116 * in="query",
12117 * description="The address-postalcode of the Person resource.",
12118 * required=false,
12119 * @OA\Schema(
12120 * type="string"
12121 * )
12122 * ),
12123 * @OA\Parameter(
12124 * name="address-state",
12125 * in="query",
12126 * description="The address-state of the Person resource.",
12127 * required=false,
12128 * @OA\Schema(
12129 * type="string"
12130 * )
12131 * ),
12132 * @OA\Parameter(
12133 * name="email",
12134 * in="query",
12135 * description="The email of the Person resource.",
12136 * required=false,
12137 * @OA\Schema(
12138 * type="string"
12139 * )
12140 * ),
12141 * @OA\Parameter(
12142 * name="family",
12143 * in="query",
12144 * description="The family name of the Person resource.",
12145 * required=false,
12146 * @OA\Schema(
12147 * type="string"
12148 * )
12149 * ),
12150 * @OA\Parameter(
12151 * name="given",
12152 * in="query",
12153 * description="The given name of the Person resource.",
12154 * required=false,
12155 * @OA\Schema(
12156 * type="string"
12157 * )
12158 * ),
12159 * @OA\Parameter(
12160 * name="phone",
12161 * in="query",
12162 * description="The phone number of the Person resource.",
12163 * required=false,
12164 * @OA\Schema(
12165 * type="string"
12166 * )
12167 * ),
12168 * @OA\Parameter(
12169 * name="telecom",
12170 * in="query",
12171 * description="The fax number of the Person resource.",
12172 * required=false,
12173 * @OA\Schema(
12174 * type="string"
12175 * )
12176 * ),
12177 * @OA\Response(
12178 * response="200",
12179 * description="Standard Response",
12180 * @OA\MediaType(
12181 * mediaType="application/json",
12182 * @OA\Schema(
12183 * @OA\Property(
12184 * property="json object",
12185 * description="FHIR Json object.",
12186 * type="object"
12187 * ),
12188 * example={
12189 * "meta": {
12190 * "lastUpdated": "2021-09-14T09:13:51"
12191 * },
12192 * "resourceType": "Bundle",
12193 * "type": "collection",
12194 * "total": 0,
12195 * "link": {
12196 * {
12197 * "relation": "self",
12198 * "url": "https://localhost:9300/apis/default/fhir/Person"
12199 * }
12200 * }
12201 * }
12202 * )
12203 * )
12204 * ),
12205 * @OA\Response(
12206 * response="400",
12207 * ref="#/components/responses/badrequest"
12208 * ),
12209 * @OA\Response(
12210 * response="401",
12211 * ref="#/components/responses/unauthorized"
12212 * ),
12213 * security={{"openemr_auth":{}}}
12214 * )
12215 */
12216 "GET /fhir/Person" => function (HttpRestRequest $request) {
12217 RestConfig::authorization_check("admin", "users");
12218 $return = (new FhirPersonRestController())->getAll($request->getQueryParams());
12219 RestConfig::apiLog($return);
12220 return $return;
12221 },
12222
12223 /**
12224 * @OA\Get(
12225 * path="/fhir/Person/{uuid}",
12226 * description="Returns a single Person resource.",
12227 * tags={"fhir"},
12228 * @OA\Parameter(
12229 * name="uuid",
12230 * in="path",
12231 * description="The uuid for the Person resource.",
12232 * required=true,
12233 * @OA\Schema(
12234 * type="string"
12235 * )
12236 * ),
12237 * @OA\Response(
12238 * response="200",
12239 * description="Standard Response",
12240 * @OA\MediaType(
12241 * mediaType="application/json",
12242 * @OA\Schema(
12243 * @OA\Property(
12244 * property="json object",
12245 * description="FHIR Json object.",
12246 * type="object"
12247 * ),
12248 * example={
12249 * "id": "960c7cd6-187a-4119-8cd4-85389d80efb9",
12250 * "meta": {
12251 * "versionId": "1",
12252 * "lastUpdated": "2022-04-13T08:57:32+00:00"
12253 * },
12254 * "resourceType": "Person",
12255 * "text": {
12256 * "status": "generated",
12257 * "div": "<div xmlns='http://www.w3.org/1999/xhtml'> <p>Administrator Administrator</p></div>"
12258 * },
12259 * "name": {
12260 * {
12261 * "use": "official",
12262 * "family": "Administrator",
12263 * "given": {
12264 * "Administrator",
12265 * "Larry"
12266 * }
12267 * }
12268 * },
12269 * "telecom": {
12270 * {
12271 * "system": "phone",
12272 * "value": "1234567890",
12273 * "use": "home"
12274 * },
12275 * {
12276 * "system": "phone",
12277 * "value": "1234567890",
12278 * "use": "work"
12279 * },
12280 * {
12281 * "system": "phone",
12282 * "value": "1234567890",
12283 * "use": "mobile"
12284 * },
12285 * {
12286 * "system": "email",
12287 * "value": "hey@hey.com",
12288 * "use": "home"
12289 * }
12290 * },
12291 * "address": {
12292 * {
12293 * "line": {
12294 * "123 Lane Street"
12295 * },
12296 * "city": "Bellevue",
12297 * "state": "WA",
12298 * "period": {
12299 * "start": "2021-04-13T08:57:32.146+00:00"
12300 * }
12301 * }
12302 * },
12303 * "active": true
12304 * }
12305 * )
12306 * )
12307 * ),
12308 * @OA\Response(
12309 * response="400",
12310 * ref="#/components/responses/badrequest"
12311 * ),
12312 * @OA\Response(
12313 * response="401",
12314 * ref="#/components/responses/unauthorized"
12315 * ),
12316 * @OA\Response(
12317 * response="404",
12318 * ref="#/components/responses/uuidnotfound"
12319 * ),
12320 * security={{"openemr_auth":{}}}
12321 * )
12322 */
12323 "GET /fhir/Person/:uuid" => function ($uuid, HttpRestRequest $request) {
12324 // if the api user is requesting their own user we need to let it through
12325 // this is because the /Person endpoint needs to be responsive to the fhirUser return value
12326 // for the currently logged in user
12327 if ($request->getRequestUserUUIDString() == $uuid) {
12328 $return = (new FhirPersonRestController())->getOne($uuid);
12329 } elseif (!$request->isPatientRequest()) {
12330 // not a patient ,make sure we have access to the users ACL
12331 RestConfig::authorization_check("admin", "users");
12332 $return = (new FhirPersonRestController())->getOne($uuid);
12333 } else {
12334 // if we are a patient bound request we need to make sure we are only bound to the patient
12335 $return = (new FhirPersonRestController())->getOne($uuid, $request->getPatientUUIDString());
12336 }
12337
12338 RestConfig::apiLog($return);
12339 return $return;
12340 },
12341
12342 /**
12343 * @OA\Get(
12344 * path="/fhir/Practitioner",
12345 * description="Returns a list of Practitioner resources.",
12346 * tags={"fhir"},
12347 * @OA\Parameter(
12348 * name="_id",
12349 * in="query",
12350 * description="The uuid for the Practitioner resource.",
12351 * required=false,
12352 * @OA\Schema(
12353 * type="string"
12354 * )
12355 * ),
12356 * @OA\Parameter(
12357 * name="_lastUpdated",
12358 * in="query",
12359 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
12360 * required=false,
12361 * @OA\Schema(
12362 * type="string"
12363 * )
12364 * ),
12365 * @OA\Parameter(
12366 * name="name",
12367 * in="query",
12368 * description="The name of the Practitioner resource.",
12369 * required=false,
12370 * @OA\Schema(
12371 * type="string"
12372 * )
12373 * ),
12374 * @OA\Parameter(
12375 * name="active",
12376 * in="query",
12377 * description="The active status of the Practitioner resource.",
12378 * required=false,
12379 * @OA\Schema(
12380 * type="string"
12381 * )
12382 * ),
12383 * @OA\Parameter(
12384 * name="address",
12385 * in="query",
12386 * description="The address of the Practitioner resource.",
12387 * required=false,
12388 * @OA\Schema(
12389 * type="string"
12390 * )
12391 * ),
12392 * @OA\Parameter(
12393 * name="address-city",
12394 * in="query",
12395 * description="The address-city of the Practitioner resource.",
12396 * required=false,
12397 * @OA\Schema(
12398 * type="string"
12399 * )
12400 * ),
12401 * @OA\Parameter(
12402 * name="address-postalcode",
12403 * in="query",
12404 * description="The address-postalcode of the Practitioner resource.",
12405 * required=false,
12406 * @OA\Schema(
12407 * type="string"
12408 * )
12409 * ),
12410 * @OA\Parameter(
12411 * name="address-state",
12412 * in="query",
12413 * description="The address-state of the Practitioner resource.",
12414 * required=false,
12415 * @OA\Schema(
12416 * type="string"
12417 * )
12418 * ),
12419 * @OA\Parameter(
12420 * name="email",
12421 * in="query",
12422 * description="The email of the Practitioner resource.",
12423 * required=false,
12424 * @OA\Schema(
12425 * type="string"
12426 * )
12427 * ),
12428 * @OA\Parameter(
12429 * name="family",
12430 * in="query",
12431 * description="The family name of the Practitioner resource.",
12432 * required=false,
12433 * @OA\Schema(
12434 * type="string"
12435 * )
12436 * ),
12437 * @OA\Parameter(
12438 * name="given",
12439 * in="query",
12440 * description="The given name of the Practitioner resource.",
12441 * required=false,
12442 * @OA\Schema(
12443 * type="string"
12444 * )
12445 * ),
12446 * @OA\Parameter(
12447 * name="phone",
12448 * in="query",
12449 * description="The phone number of the Practitioner resource.",
12450 * required=false,
12451 * @OA\Schema(
12452 * type="string"
12453 * )
12454 * ),
12455 * @OA\Parameter(
12456 * name="telecom",
12457 * in="query",
12458 * description="The fax number of the Practitioner resource.",
12459 * required=false,
12460 * @OA\Schema(
12461 * type="string"
12462 * )
12463 * ),
12464 * @OA\Response(
12465 * response="200",
12466 * description="Standard Response",
12467 * @OA\MediaType(
12468 * mediaType="application/json",
12469 * @OA\Schema(
12470 * @OA\Property(
12471 * property="json object",
12472 * description="FHIR Json object.",
12473 * type="object"
12474 * ),
12475 * example={
12476 * "meta": {
12477 * "lastUpdated": "2021-09-14T09:13:51"
12478 * },
12479 * "resourceType": "Bundle",
12480 * "type": "collection",
12481 * "total": 0,
12482 * "link": {
12483 * {
12484 * "relation": "self",
12485 * "url": "https://localhost:9300/apis/default/fhir/Practitioner"
12486 * }
12487 * }
12488 * }
12489 * )
12490 * )
12491 * ),
12492 * @OA\Response(
12493 * response="400",
12494 * ref="#/components/responses/badrequest"
12495 * ),
12496 * @OA\Response(
12497 * response="401",
12498 * ref="#/components/responses/unauthorized"
12499 * ),
12500 * security={{"openemr_auth":{}}}
12501 * )
12502 */
12503 "GET /fhir/Practitioner" => function (HttpRestRequest $request) {
12504
12505 // TODO: @adunsulag talk with brady.miller about patients needing access to any practitioner resource
12506 // that is referenced in connected patient resources -- such as AllergyIntollerance.
12507 // I don't believe patients are assigned to a particular practitioner
12508 // should we allow just open api access to admin information? Should we restrict particular pieces
12509 // of data in the practitioner side (phone number, address information) based on a permission set?
12510 if (!$request->isPatientRequest()) {
12511 RestConfig::authorization_check("admin", "users");
12512 }
12513 $return = (new FhirPractitionerRestController())->getAll($request->getQueryParams());
12514 RestConfig::apiLog($return);
12515 return $return;
12516 },
12517
12518 /**
12519 * @OA\Get(
12520 * path="/fhir/Practitioner/{uuid}",
12521 * description="Returns a single Practitioner resource.",
12522 * tags={"fhir"},
12523 * @OA\Parameter(
12524 * name="uuid",
12525 * in="path",
12526 * description="The uuid for the Practitioner resource.",
12527 * required=true,
12528 * @OA\Schema(
12529 * type="string"
12530 * )
12531 * ),
12532 * @OA\Response(
12533 * response="200",
12534 * description="Standard Response",
12535 * @OA\MediaType(
12536 * mediaType="application/json",
12537 * @OA\Schema(
12538 * @OA\Property(
12539 * property="json object",
12540 * description="FHIR Json object.",
12541 * type="object"
12542 * ),
12543 * example={
12544 * "id": "9473b0cf-e969-4eaa-8044-51037767fa4f",
12545 * "meta": {
12546 * "versionId": "1",
12547 * "lastUpdated": "2021-09-21T17:41:57+00:00"
12548 * },
12549 * "resourceType": "Practitioner",
12550 * "text": {
12551 * "status": "generated",
12552 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""> <p>Billy Smith</p></div>"
12553 * },
12554 * "identifier": {
12555 * {
12556 * "system": "http://hl7.org/fhir/sid/us-npi",
12557 * "value": "11223344554543"
12558 * }
12559 * },
12560 * "active": true,
12561 * "name": {
12562 * {
12563 * "use": "official",
12564 * "family": "Smith",
12565 * "given": {
12566 * "Billy"
12567 * }
12568 * }
12569 * }
12570 * }
12571 * )
12572 * )
12573 * ),
12574 * @OA\Response(
12575 * response="400",
12576 * ref="#/components/responses/badrequest"
12577 * ),
12578 * @OA\Response(
12579 * response="401",
12580 * ref="#/components/responses/unauthorized"
12581 * ),
12582 * @OA\Response(
12583 * response="404",
12584 * ref="#/components/responses/uuidnotfound"
12585 * ),
12586 * security={{"openemr_auth":{}}}
12587 * )
12588 */
12589 "GET /fhir/Practitioner/:uuid" => function ($uuid, HttpRestRequest $request) {
12590 // TODO: @adunsulag talk with brady.miller about patients needing access to any practitioner resource
12591 // that is referenced in connected patient resources -- such as AllergyIntollerance.
12592 // I don't believe patients are assigned to a particular practitioner
12593 // should we allow just open api access to admin information? Should we restrict particular pieces
12594 // of data in the practitioner side (phone number, address information) based on a permission set?
12595 if (!$request->isPatientRequest()) {
12596 RestConfig::authorization_check("admin", "users");
12597 }
12598 $return = (new FhirPractitionerRestController())->getOne($uuid);
12599 RestConfig::apiLog($return);
12600 return $return;
12601 },
12602
12603 /**
12604 * @OA\Post(
12605 * path="/fhir/Practitioner",
12606 * description="Adds a Practitioner resources.",
12607 * tags={"fhir"},
12608 * @OA\RequestBody(
12609 * required=true,
12610 * @OA\MediaType(
12611 * mediaType="application/json",
12612 * @OA\Schema(
12613 * description="The json object for the Practitioner resource.",
12614 * type="object"
12615 * ),
12616 * example={
12617 * "id": "9473b0cf-e969-4eaa-8044-51037767fa4f",
12618 * "meta": {
12619 * "versionId": "1",
12620 * "lastUpdated": "2021-09-21T17:41:57+00:00"
12621 * },
12622 * "resourceType": "Practitioner",
12623 * "text": {
12624 * "status": "generated",
12625 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""> <p>Billy Smith</p></div>"
12626 * },
12627 * "identifier": {
12628 * {
12629 * "system": "http://hl7.org/fhir/sid/us-npi",
12630 * "value": "11223344554543"
12631 * }
12632 * },
12633 * "active": true,
12634 * "name": {
12635 * {
12636 * "use": "official",
12637 * "family": "Smith",
12638 * "given": {
12639 * "Danny"
12640 * }
12641 * }
12642 * }
12643 * }
12644 * )
12645 * ),
12646 * @OA\Response(
12647 * response="200",
12648 * description="Standard Response",
12649 * @OA\MediaType(
12650 * mediaType="application/json",
12651 * @OA\Schema(
12652 * @OA\Property(
12653 * property="json object",
12654 * description="FHIR Json object.",
12655 * type="object"
12656 * ),
12657 * example={
12658 * "id": "9473b0cf-e969-4eaa-8044-51037767fa4f",
12659 * "meta": {
12660 * "versionId": "1",
12661 * "lastUpdated": "2021-09-21T17:41:57+00:00"
12662 * },
12663 * "resourceType": "Practitioner",
12664 * "text": {
12665 * "status": "generated",
12666 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""> <p>Billy Smith</p></div>"
12667 * },
12668 * "identifier": {
12669 * {
12670 * "system": "http://hl7.org/fhir/sid/us-npi",
12671 * "value": "11223344554543"
12672 * }
12673 * },
12674 * "active": true,
12675 * "name": {
12676 * {
12677 * "use": "official",
12678 * "family": "Smith",
12679 * "given": {
12680 * "Danny"
12681 * }
12682 * }
12683 * }
12684 * }
12685 * )
12686 * )
12687 * ),
12688 * @OA\Response(
12689 * response="400",
12690 * ref="#/components/responses/badrequest"
12691 * ),
12692 * @OA\Response(
12693 * response="401",
12694 * ref="#/components/responses/unauthorized"
12695 * ),
12696 * security={{"openemr_auth":{}}}
12697 * )
12698 */
12699 "POST /fhir/Practitioner" => function (HttpRestRequest $request) {
12700 RestConfig::authorization_check("admin", "users");
12701 $data = (array) (json_decode(file_get_contents("php://input"), true));
12702 $return = (new FhirPractitionerRestController())->post($data);
12703 RestConfig::apiLog($return, $data);
12704 return $return;
12705 },
12706
12707 /**
12708 * @OA\Put(
12709 * path="/fhir/Practitioner/{uuid}",
12710 * description="Modify a Practitioner resource.",
12711 * tags={"fhir"},
12712 * @OA\Parameter(
12713 * name="uuid",
12714 * in="path",
12715 * description="The uuid for the Practitioner resource.",
12716 * required=true,
12717 * @OA\Schema(
12718 * type="string"
12719 * )
12720 * ),
12721 * @OA\RequestBody(
12722 * required=true,
12723 * @OA\MediaType(
12724 * mediaType="application/json",
12725 * @OA\Schema(
12726 * description="The json object for the Practitioner resource.",
12727 * type="object"
12728 * ),
12729 * example={
12730 * "id": "9473b0cf-e969-4eaa-8044-51037767fa4f",
12731 * "meta": {
12732 * "versionId": "1",
12733 * "lastUpdated": "2021-09-21T17:41:57+00:00"
12734 * },
12735 * "resourceType": "Practitioner",
12736 * "text": {
12737 * "status": "generated",
12738 * "div": "<div xmlns=""http://www.w3.org/1999/xhtml""> <p>Billy Smith</p></div>"
12739 * },
12740 * "identifier": {
12741 * {
12742 * "system": "http://hl7.org/fhir/sid/us-npi",
12743 * "value": "11223344554543"
12744 * }
12745 * },
12746 * "active": true,
12747 * "name": {
12748 * {
12749 * "use": "official",
12750 * "family": "Smith",
12751 * "given": {
12752 * "Billy"
12753 * }
12754 * }
12755 * }
12756 * }
12757 * )
12758 * ),
12759 * @OA\Response(
12760 * response="201",
12761 * description="Standard Response",
12762 * @OA\MediaType(
12763 * mediaType="application/json",
12764 * @OA\Schema(
12765 * example={
12766 * "id": 5,
12767 * "uuid": "95f294d7-e14c-441d-81a6-309fe369ee21"
12768 * }
12769 * )
12770 * )
12771 * ),
12772 * @OA\Response(
12773 * response="400",
12774 * ref="#/components/responses/badrequest"
12775 * ),
12776 * @OA\Response(
12777 * response="401",
12778 * ref="#/components/responses/unauthorized"
12779 * ),
12780 * security={{"openemr_auth":{}}}
12781 * )
12782 */
12783 "PUT /fhir/Practitioner/:uuid" => function ($uuid, HttpRestRequest $request) {
12784 RestConfig::authorization_check("admin", "users");
12785 $data = (array) (json_decode(file_get_contents("php://input"), true));
12786 $return = (new FhirPractitionerRestController())->patch($uuid, $data);
12787 RestConfig::apiLog($return, $data);
12788 return $return;
12789 },
12790
12791 /**
12792 * @OA\Get(
12793 * path="/fhir/PractitionerRole",
12794 * description="Returns a list of PractitionerRole resources.",
12795 * tags={"fhir"},
12796 * @OA\Parameter(
12797 * name="_id",
12798 * in="query",
12799 * description="The uuid for the PractitionerRole resource.",
12800 * required=false,
12801 * @OA\Schema(
12802 * type="string"
12803 * )
12804 * ),
12805 * @OA\Parameter(
12806 * name="_lastUpdated",
12807 * in="query",
12808 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
12809 * required=false,
12810 * @OA\Schema(
12811 * type="string"
12812 * )
12813 * ),
12814 * @OA\Parameter(
12815 * name="specialty",
12816 * in="query",
12817 * description="The specialty of the PractitionerRole resource.",
12818 * required=false,
12819 * @OA\Schema(
12820 * type="string"
12821 * )
12822 * ),
12823 * @OA\Parameter(
12824 * name="practitioner",
12825 * in="query",
12826 * description="The practitioner of the PractitionerRole resource.",
12827 * required=false,
12828 * @OA\Schema(
12829 * type="string"
12830 * )
12831 * ),
12832 * @OA\Response(
12833 * response="200",
12834 * description="Standard Response",
12835 * @OA\MediaType(
12836 * mediaType="application/json",
12837 * @OA\Schema(
12838 * @OA\Property(
12839 * property="json object",
12840 * description="FHIR Json object.",
12841 * type="object"
12842 * ),
12843 * example={
12844 * "meta": {
12845 * "lastUpdated": "2021-09-14T09:13:51"
12846 * },
12847 * "resourceType": "Bundle",
12848 * "type": "collection",
12849 * "total": 0,
12850 * "link": {
12851 * {
12852 * "relation": "self",
12853 * "url": "https://localhost:9300/apis/default/fhir/PractitionerRole"
12854 * }
12855 * }
12856 * }
12857 * )
12858 * )
12859 * ),
12860 * @OA\Response(
12861 * response="400",
12862 * ref="#/components/responses/badrequest"
12863 * ),
12864 * @OA\Response(
12865 * response="401",
12866 * ref="#/components/responses/unauthorized"
12867 * ),
12868 * security={{"openemr_auth":{}}}
12869 * )
12870 */
12871 "GET /fhir/PractitionerRole" => function (HttpRestRequest $request) {
12872 RestConfig::authorization_check("admin", "users");
12873 $return = (new FhirPractitionerRoleRestController())->getAll($request->getQueryParams());
12874 RestConfig::apiLog($return);
12875 return $return;
12876 },
12877
12878 /**
12879 * @OA\Get(
12880 * path="/fhir/PractitionerRole/{uuid}",
12881 * description="Returns a single PractitionerRole resource.",
12882 * tags={"fhir"},
12883 * @OA\Parameter(
12884 * name="uuid",
12885 * in="path",
12886 * description="The uuid for the PractitionerRole resource.",
12887 * required=true,
12888 * @OA\Schema(
12889 * type="string"
12890 * )
12891 * ),
12892 * @OA\Response(
12893 * response="200",
12894 * description="Standard Response",
12895 * @OA\MediaType(
12896 * mediaType="application/json",
12897 * @OA\Schema(
12898 * @OA\Property(
12899 * property="json object",
12900 * description="FHIR Json object.",
12901 * type="object"
12902 * ),
12903 * example={
12904 * "id": "960c806f-9463-482e-b228-67b5be1fed55",
12905 * "meta": {
12906 * "versionId": "1",
12907 * "lastUpdated": "2022-04-13T06:18:17+00:00"
12908 * },
12909 * "resourceType": "PractitionerRole",
12910 * "practitioner": {
12911 * "reference": "Practitioner/960c7cd6-187a-4119-8cd4-85389d80efb9",
12912 * "display": "Administrator Administrator"
12913 * },
12914 * "organization": {
12915 * "reference": "Organization/960c7cc6-b4ae-49bc-877b-1a2913271c43",
12916 * "display": "Your Clinic Name Here"
12917 * },
12918 * "code": {
12919 * {
12920 * "coding": {
12921 * "102L00000X"
12922 * },
12923 * "text": "Psychoanalyst"
12924 * },
12925 * {
12926 * "coding": {
12927 * "101Y00000X"
12928 * },
12929 * "text": "Counselor"
12930 * }
12931 * }
12932 * }
12933 * )
12934 * )
12935 * ),
12936 * @OA\Response(
12937 * response="400",
12938 * ref="#/components/responses/badrequest"
12939 * ),
12940 * @OA\Response(
12941 * response="401",
12942 * ref="#/components/responses/unauthorized"
12943 * ),
12944 * @OA\Response(
12945 * response="404",
12946 * ref="#/components/responses/uuidnotfound"
12947 * ),
12948 * security={{"openemr_auth":{}}}
12949 * )
12950 */
12951 "GET /fhir/PractitionerRole/:uuid" => function ($uuid, HttpRestRequest $request) {
12952 RestConfig::authorization_check("admin", "users");
12953 $return = (new FhirPractitionerRoleRestController())->getOne($uuid);
12954 RestConfig::apiLog($return);
12955 return $return;
12956 },
12957
12958 /**
12959 * @OA\Get(
12960 * path="/fhir/Procedure",
12961 * description="Returns a list of Procedure resources.",
12962 * tags={"fhir"},
12963 * @OA\Parameter(
12964 * name="_id",
12965 * in="query",
12966 * description="The uuid for the Procedure resource.",
12967 * required=false,
12968 * @OA\Schema(
12969 * type="string"
12970 * )
12971 * ),
12972 * @OA\Parameter(
12973 * name="_lastUpdated",
12974 * in="query",
12975 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
12976 * required=false,
12977 * @OA\Schema(
12978 * type="string"
12979 * )
12980 * ),
12981 * @OA\Parameter(
12982 * name="patient",
12983 * in="query",
12984 * description="The uuid for the patient.",
12985 * required=false,
12986 * @OA\Schema(
12987 * type="string"
12988 * )
12989 * ),
12990 * @OA\Parameter(
12991 * name="date",
12992 * in="query",
12993 * description="The datetime of the Procedure resource.",
12994 * required=false,
12995 * @OA\Schema(
12996 * type="string"
12997 * )
12998 * ),
12999 * @OA\Response(
13000 * response="200",
13001 * description="Standard Response",
13002 * @OA\MediaType(
13003 * mediaType="application/json",
13004 * @OA\Schema(
13005 * @OA\Property(
13006 * property="json object",
13007 * description="FHIR Json object.",
13008 * type="object"
13009 * ),
13010 * example={
13011 * "meta": {
13012 * "lastUpdated": "2021-09-14T09:13:51"
13013 * },
13014 * "resourceType": "Bundle",
13015 * "type": "collection",
13016 * "total": 0,
13017 * "link": {
13018 * {
13019 * "relation": "self",
13020 * "url": "https://localhost:9300/apis/default/fhir/Procedure"
13021 * }
13022 * }
13023 * }
13024 * )
13025 * )
13026 * ),
13027 * @OA\Response(
13028 * response="400",
13029 * ref="#/components/responses/badrequest"
13030 * ),
13031 * @OA\Response(
13032 * response="401",
13033 * ref="#/components/responses/unauthorized"
13034 * ),
13035 * security={{"openemr_auth":{}}}
13036 * )
13037 */
13038 "GET /fhir/Procedure" => function (HttpRestRequest $request) {
13039 if ($request->isPatientRequest()) {
13040 // only allow access to data of binded patient
13041 $return = (new FhirProcedureRestController())->getAll($request->getQueryParams(), $request->getPatientUUIDString());
13042 } else {
13043 RestConfig::authorization_check("patients", "med");
13044 $return = (new FhirProcedureRestController())->getAll($request->getQueryParams());
13045 }
13046 RestConfig::apiLog($return);
13047 return $return;
13048 },
13049
13050 /**
13051 * @OA\Get(
13052 * path="/fhir/Procedure/{uuid}",
13053 * description="Returns a single Procedure resource.",
13054 * tags={"fhir"},
13055 * @OA\Parameter(
13056 * name="uuid",
13057 * in="path",
13058 * description="The uuid for the Procedure resource.",
13059 * required=true,
13060 * @OA\Schema(
13061 * type="string"
13062 * )
13063 * ),
13064 * @OA\Response(
13065 * response="200",
13066 * description="Standard Response",
13067 * @OA\MediaType(
13068 * mediaType="application/json",
13069 * @OA\Schema(
13070 * @OA\Property(
13071 * property="json object",
13072 * description="FHIR Json object.",
13073 * type="object"
13074 * ),
13075 * example={
13076 * "id": "95e9d3fb-fe7b-448a-aa60-d40b11b486a5",
13077 * "meta": {
13078 * "versionId": "1",
13079 * "lastUpdated": "2022-03-26T17:20:14+00:00"
13080 * },
13081 * "resourceType": "Procedure",
13082 * "status": "in-progress",
13083 * "subject": {
13084 * "reference": "Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf",
13085 * "type": "Patient"
13086 * }
13087 * }
13088 * )
13089 * )
13090 * ),
13091 * @OA\Response(
13092 * response="400",
13093 * ref="#/components/responses/badrequest"
13094 * ),
13095 * @OA\Response(
13096 * response="401",
13097 * ref="#/components/responses/unauthorized"
13098 * ),
13099 * @OA\Response(
13100 * response="404",
13101 * ref="#/components/responses/uuidnotfound"
13102 * ),
13103 * security={{"openemr_auth":{}}}
13104 * )
13105 */
13106 "GET /fhir/Procedure/:uuid" => function ($uuid, HttpRestRequest $request) {
13107 if ($request->isPatientRequest()) {
13108 // only allow access to data of binded patient
13109 $return = (new FhirProcedureRestController())->getOne($uuid, $request->getPatientUUIDString());
13110 } else {
13111 RestConfig::authorization_check("patients", "med");
13112 $return = (new FhirProcedureRestController())->getOne($uuid);
13113 }
13114 RestConfig::apiLog($return);
13115 return $return;
13116 },
13117
13118 /**
13119 * @OA\Get(
13120 * path="/fhir/Provenance/{uuid}",
13121 * description="Returns a single Provenance resource.",
13122 * tags={"fhir"},
13123 * @OA\Parameter(
13124 * name="uuid",
13125 * in="path",
13126 * description="The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).",
13127 * required=true,
13128 * @OA\Schema(
13129 * type="string"
13130 * )
13131 * ),
13132 * @OA\Response(
13133 * response="200",
13134 * description="Standard Response",
13135 * @OA\MediaType(
13136 * mediaType="application/json",
13137 * @OA\Schema(
13138 * @OA\Property(
13139 * property="json object",
13140 * description="FHIR Json object.",
13141 * type="object"
13142 * ),
13143 * example={
13144 * "id": "AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145",
13145 * "resourceType": "Provenance",
13146 * "target": {
13147 * {
13148 * "reference": "AllergyIntolerance/95ea43f3-1066-4bc7-b224-6c23b985f145",
13149 * "type": "AllergyIntolerance"
13150 * }
13151 * },
13152 * "recorded": "2022-03-26T22:43:30+00:00",
13153 * "agent": {
13154 * {
13155 * "type": {
13156 * "coding": {
13157 * {
13158 * "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
13159 * "code": "author",
13160 * "display": "Author"
13161 * }
13162 * }
13163 * },
13164 * "who": {
13165 * "reference": "Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7",
13166 * "type": "Organization"
13167 * },
13168 * "onBehalfOf": {
13169 * "reference": "Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7",
13170 * "type": "Organization"
13171 * }
13172 * },
13173 * {
13174 * "type": {
13175 * "coding": {
13176 * {
13177 * "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
13178 * "code": "transmitter",
13179 * "display": "Transmitter"
13180 * }
13181 * }
13182 * }
13183 * },
13184 * "who": {
13185 * "reference": "Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7",
13186 * "type": "Organization"
13187 * },
13188 * "onBehalfOf": {
13189 * "reference": "Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7",
13190 * "type": "Organization"
13191 * }
13192 * }
13193 * }
13194 * )
13195 * )
13196 * ),
13197 * @OA\Response(
13198 * response="400",
13199 * ref="#/components/responses/badrequest"
13200 * ),
13201 * @OA\Response(
13202 * response="401",
13203 * ref="#/components/responses/unauthorized"
13204 * ),
13205 * @OA\Response(
13206 * response="404",
13207 * ref="#/components/responses/uuidnotfound"
13208 * ),
13209 * security={{"openemr_auth":{}}}
13210 * )
13211 */
13212 "GET /fhir/Provenance/:uuid" => function ($uuid, HttpRestRequest $request) {
13213 if ($request->isPatientRequest()) {
13214 // only allow access to data of binded patient
13215 $return = (new FhirProvenanceRestController($request))->getOne($uuid, $request->getPatientUUIDString());
13216 } else {
13217 RestConfig::authorization_check("admin", "super");
13218 $return = (new FhirProvenanceRestController($request))->getOne($uuid);
13219 }
13220 RestConfig::apiLog($return);
13221 return $return;
13222 },
13223
13224 /**
13225 * @OA\Get(
13226 * path="/fhir/Provenance",
13227 * description="Returns a list of Provenance resources.",
13228 * tags={"fhir"},
13229 * @OA\Parameter(
13230 * name="_id",
13231 * in="query",
13232 * description="The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).",
13233 * required=false,
13234 * @OA\Schema(
13235 * type="string"
13236 * )
13237 * ),
13238 * @OA\Response(
13239 * response="200",
13240 * description="Standard Response",
13241 * @OA\MediaType(
13242 * mediaType="application/json",
13243 * @OA\Schema(
13244 * @OA\Property(
13245 * property="json object",
13246 * description="FHIR Json object.",
13247 * type="object"
13248 * ),
13249 * example={
13250 * "meta": {
13251 * "lastUpdated": "2021-09-14T09:13:51"
13252 * },
13253 * "resourceType": "Bundle",
13254 * "type": "collection",
13255 * "total": 0,
13256 * "link": {
13257 * {
13258 * "relation": "self",
13259 * "url": "https://localhost:9300/apis/default/fhir/Provenance"
13260 * }
13261 * }
13262 * }
13263 * )
13264 * )
13265 * ),
13266 * @OA\Response(
13267 * response="400",
13268 * ref="#/components/responses/badrequest"
13269 * ),
13270 * @OA\Response(
13271 * response="401",
13272 * ref="#/components/responses/unauthorized"
13273 * ),
13274 * security={{"openemr_auth":{}}}
13275 * )
13276 */
13277 // NOTE: this GET request only supports requests with an _id parameter. FHIR inferno test tool requires the 'search'
13278 // property to support which is why this endpoint exists.
13279 "GET /fhir/Provenance" => function (HttpRestRequest $request) {
13280 if ($request->isPatientRequest()) {
13281 // only allow access to data of binded patient
13282 $return = (new FhirProvenanceRestController($request))->getAll($request->getQueryParams(), $request->getPatientUUIDString());
13283 } else {
13284 // TODO: it seems like regular users should be able to grab authorship / provenance information
13285 RestConfig::authorization_check("admin", "super");
13286 $return = (new FhirProvenanceRestController($request))->getAll($request->getQueryParams());
13287 }
13288 RestConfig::apiLog($return);
13289 return $return;
13290 },
13291
13292 /**
13293 * @OA\Get(
13294 * path="/fhir/ValueSet",
13295 * description="Returns a list of ValueSet resources.",
13296 * tags={"fhir"},
13297 * @OA\Parameter(
13298 * name="_id",
13299 * in="query",
13300 * description="The uuid for the ValueSet resource.",
13301 * required=false,
13302 * @OA\Schema(
13303 * type="string"
13304 * )
13305 * ),
13306 * @OA\Parameter(
13307 * name="_lastUpdated",
13308 * in="query",
13309 * description="Allows filtering resources by the _lastUpdated field. A FHIR Instant value in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. See FHIR date/time modifiers for filtering options (ge,gt,le, etc)",
13310 * required=false,
13311 * @OA\Schema(
13312 * type="string"
13313 * )
13314 * ),
13315 * @OA\Response(
13316 * response="200",
13317 * description="Standard Response",
13318 * @OA\MediaType(
13319 * mediaType="application/json",
13320 * @OA\Schema(
13321 * @OA\Property(
13322 * property="json object",
13323 * description="FHIR Json object.",
13324 * type="object"
13325 * ),
13326 * example={
13327 * "meta": {
13328 * "lastUpdated": "2021-09-14T09:13:51"
13329 * },
13330 * "resourceType": "Bundle",
13331 * "type": "collection",
13332 * "total": 0,
13333 * "link": {
13334 * {
13335 * "relation": "self",
13336 * "url": "https://localhost:9300/apis/default/fhir/ValueSet"
13337 * }
13338 * }
13339 * }
13340 * )
13341 * )
13342 * ),
13343 * @OA\Response(
13344 * response="400",
13345 * ref="#/components/responses/badrequest"
13346 * ),
13347 * @OA\Response(
13348 * response="401",
13349 * ref="#/components/responses/unauthorized"
13350 * ),
13351 * security={{"openemr_auth":{}}}
13352 * )
13353 */
13354 "GET /fhir/ValueSet" => function (HttpRestRequest $request) {
13355 RestConfig::authorization_check("admin", "super");
13356 $return = (new FhirValueSetRestController())->getAll($request->getQueryParams());
13357 RestConfig::apiLog($return);
13358 return $return;
13359 },
13360
13361 /**
13362 * @OA\Get(
13363 * path="/fhir/ValueSet/{uuid}",
13364 * description="Returns a single ValueSet resource.",
13365 * tags={"fhir"},
13366 * @OA\Parameter(
13367 * name="uuid",
13368 * in="path",
13369 * description="The uuid for the ValueSet resource.",
13370 * required=true,
13371 * @OA\Schema(
13372 * type="string"
13373 * )
13374 * ),
13375 * @OA\Response(
13376 * response="200",
13377 * description="Standard Response",
13378 * @OA\MediaType(
13379 * mediaType="application/json",
13380 * @OA\Schema(
13381 * @OA\Property(
13382 * property="json object",
13383 * description="FHIR Json object.",
13384 * type="object"
13385 * ),
13386 * example={
13387 * "resourceType": "ValueSet",
13388 * "id": "appointment-type",
13389 * "compose": {
13390 * "include": {
13391 * {
13392 * "concept": {
13393 * {
13394 * "code": "no_show",
13395 * "display": "No Show"
13396 * },
13397 * {
13398 * "code": "office_visit",
13399 * "display": "Office Visit"
13400 * },
13401 * {
13402 * "code": "established_patient",
13403 * "display": "Established Patient"
13404 * },
13405 * {
13406 * "code": "new_patient",
13407 * "display": "New Patient"
13408 * },
13409 * {
13410 * "code": "health_and_behavioral_assessment",
13411 * "display": "Health and Behavioral Assessment"
13412 * },
13413 * {
13414 * "code": "preventive_care_services",
13415 * "display": "Preventive Care Services"
13416 * },
13417 * {
13418 * "code": "ophthalmological_services",
13419 * "display": "Ophthalmological Services"
13420 * }
13421 * }
13422 * }
13423 * }
13424 * }
13425 * }
13426 * )
13427 * )
13428 * ),
13429 * @OA\Response(
13430 * response="400",
13431 * ref="#/components/responses/badrequest"
13432 * ),
13433 * @OA\Response(
13434 * response="401",
13435 * ref="#/components/responses/unauthorized"
13436 * ),
13437 * @OA\Response(
13438 * response="404",
13439 * ref="#/components/responses/uuidnotfound"
13440 * ),
13441 * security={{"openemr_auth":{}}}
13442 * )
13443 */
13444 "GET /fhir/ValueSet/:uuid" => function ($uuid, HttpRestRequest $request) {
13445 RestConfig::authorization_check("admin", "super");
13446 $return = (new FhirValueSetRestController())->getOne($uuid);
13447 RestConfig::apiLog($return);
13448 return $return;
13449 },
13450
13451 // other endpoints
13452
13453 /**
13454 * @OA\Get(
13455 * path="/fhir/metadata",
13456 * description="Returns metadata (ie. CapabilityStatement resource) of the fhir server.",
13457 * tags={"fhir"},
13458 * @OA\Response(
13459 * response="200",
13460 * description="Return CapabilityStatement resource of the fhir server"
13461 * )
13462 * )
13463 */
13464 "GET /fhir/metadata" => function () {
13465 $return = (new FhirMetaDataRestController())->getMetaData();
13466 RestConfig::apiLog($return);
13467 return $return;
13468 },
13469
13470 /**
13471 * @OA\Get(
13472 * path="/fhir/.well-known/smart-configuration",
13473 * description="Returns smart configuration of the fhir server.",
13474 * tags={"fhir"},
13475 * @OA\Response(
13476 * response="200",
13477 * description="Return smart configuration of the fhir server"
13478 * )
13479 * )
13480 */
13481 "GET /fhir/.well-known/smart-configuration" => function () {
13482 $authController = new \OpenEMR\RestControllers\AuthorizationController();
13483 $return = (new \OpenEMR\RestControllers\SMART\SMARTConfigurationController($authController))->getConfig();
13484 RestConfig::apiLog($return);
13485 return $return;
13486 },
13487
13488 /**
13489 * @OA\Get(
13490 * path="/fhir/OperationDefinition",
13491 * description="Returns a list of the OperationDefinition resources that are specific to this OpenEMR installation",
13492 * tags={"fhir"},
13493 * @OA\Response(
13494 * response="200",
13495 * description="Return list of OperationDefinition resources"
13496 * )
13497 * )
13498 */
13499 "GET /fhir/OperationDefinition" => function (HttpRestRequest $request) {
13500 // for now we will just hard code the custom resources
13501 $operationDefinitionController = new FhirOperationDefinitionRestController();
13502 $return = $operationDefinitionController->getAll($request->getQueryParams());
13503 RestConfig::apiLog($return);
13504 return $return;
13505 },
13506
13507 /**
13508 * @OA\Get(
13509 * path="/fhir/OperationDefinition/{operation}",
13510 * description="Returns a single OperationDefinition resource that is specific to this OpenEMR installation",
13511 * tags={"fhir"},
13512 * @OA\Parameter(
13513 * name="operation",
13514 * in="path",
13515 * description="The name of the operation to query. For example $bulkdata-status",
13516 * required=true,
13517 * @OA\Schema(
13518 * type="string"
13519 * )
13520 * ),
13521 * @OA\Response(
13522 * response="200",
13523 * description="Standard Response",
13524 * @OA\MediaType(
13525 * mediaType="application/json",
13526 * @OA\Schema(
13527 * @OA\Property(
13528 * property="json object",
13529 * description="FHIR Json object.",
13530 * type="object"
13531 * ),
13532 * example={
13533 * "resourceType": "OperationDefinition",
13534 * "name": "$bulkdata-status",
13535 * "status": "active",
13536 * "kind": "operation",
13537 * "parameter": {
13538 * {
13539 * "name": "job",
13540 * "use": "in",
13541 * "min": 1,
13542 * "max": 1,
13543 * "type": {
13544 * "system": "http://hl7.org/fhir/data-types",
13545 * "code": "string",
13546 * "display": "string"
13547 * },
13548 * "searchType": {
13549 * "system": "http://hl7.org/fhir/ValueSet/search-param-type",
13550 * "code": "string",
13551 * "display": "string"
13552 * }
13553 * }
13554 * }
13555 * }
13556 * )
13557 * )
13558 * ),
13559 * )
13560 */
13561 "GET /fhir/OperationDefinition/:operation" => function ($operation, HttpRestRequest $request) {
13562 // for now we will just hard code the custom resources
13563 $operationDefinitionController = new FhirOperationDefinitionRestController();
13564 $return = $operationDefinitionController->getOne($operation);
13565 RestConfig::apiLog($return);
13566 return $return;
13567 },
13568
13569 // FHIR root level operations
13570
13571 /**
13572 * @OA\Get(
13573 * path="/fhir/$export",
13574 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
13575 * tags={"fhir"},
13576 * @OA\Response(
13577 * response="200",
13578 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
13579 * ),
13580 * @OA\Response(
13581 * response="400",
13582 * ref="#/components/responses/badrequest"
13583 * ),
13584 * @OA\Response(
13585 * response="401",
13586 * ref="#/components/responses/unauthorized"
13587 * ),
13588 * security={{"openemr_auth":{}}}
13589 * )
13590 */
13591 'GET /fhir/$export' => function (HttpRestRequest $request) {
13592 RestConfig::authorization_check("admin", "users");
13593 $fhirExportService = new FhirOperationExportRestController($request);
13594 $return = $fhirExportService->processExport(
13595 $request->getQueryParams(),
13596 'System',
13597 $request->getHeader('Accept')[0] ?? '',
13598 $request->getHeader('Prefer')[0] ?? ''
13599 );
13600 RestConfig::apiLog($return);
13601 return $return;
13602 },
13603
13604 // these two operations are adopted based on the documentation used in the IBM FHIR Server
13605 // we'd reference cerner or epic but we couldn't find any documentation about those (Jan 30th 2021)
13606 // @see https://ibm.github.io/FHIR/guides/FHIRBulkOperations/
13607
13608 /**
13609 * @OA\Get(
13610 * path="/fhir/$bulkdata-status",
13611 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
13612 * tags={"fhir"},
13613 * @OA\Response(
13614 * response="200",
13615 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
13616 * ),
13617 * @OA\Response(
13618 * response="400",
13619 * ref="#/components/responses/badrequest"
13620 * ),
13621 * @OA\Response(
13622 * response="401",
13623 * ref="#/components/responses/unauthorized"
13624 * ),
13625 * security={{"openemr_auth":{}}}
13626 * )
13627 */
13628 'GET /fhir/$bulkdata-status' => function (HttpRestRequest $request) {
13629 RestConfig::authorization_check("admin", "users");
13630 $jobUuidString = $request->getQueryParam('job');
13631 // if we were truly async we would return 202 here to say we are in progress with a JSON response
13632 // since OpenEMR data is so small we just return the JSON from the database
13633 $fhirExportService = new FhirOperationExportRestController($request);
13634 $return = $fhirExportService->processExportStatusRequestForJob($jobUuidString);
13635 RestConfig::apiLog($return);
13636 return $return;
13637 },
13638
13639 /**
13640 * @OA\Delete(
13641 * path="/fhir/$bulkdata-status",
13642 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>",
13643 * tags={"fhir"},
13644 * @OA\Response(
13645 * response="200",
13646 * description="The BULK FHIR Exports documentation can be found at <a href='https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API' target='_blank' rel='noopener'>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>"
13647 * ),
13648 * @OA\Response(
13649 * response="400",
13650 * ref="#/components/responses/badrequest"
13651 * ),
13652 * @OA\Response(
13653 * response="401",
13654 * ref="#/components/responses/unauthorized"
13655 * ),
13656 * security={{"openemr_auth":{}}}
13657 * )
13658 */
13659 'DELETE /fhir/$bulkdata-status' => function (HttpRestRequest $request) {
13660 RestConfig::authorization_check("admin", "users");
13661 $job = $request->getQueryParam('job');
13662 $fhirExportService = new FhirOperationExportRestController($request);
13663 $return = $fhirExportService->processDeleteExportForJob($job);
13664 RestConfig::apiLog($return);
13665 return $return;
13666 },
13667 );
13668
13669 // Note that the portal (api) route is only for patient role
13670 // (there is a mechanism in place to ensure only patient role can access the portal (api) route)
13671 RestConfig::$PORTAL_ROUTE_MAP = array(
13672 /**
13673 * @OA\Get(
13674 * path="/portal/patient",
13675 * description="Returns the patient.",
13676 * tags={"standard-patient"},
13677 * @OA\Response(
13678 * response="200",
13679 * description="Standard response",
13680 * @OA\MediaType(
13681 * mediaType="application/json",
13682 * @OA\Schema(ref="#/components/schemas/api_patient_response")
13683 * )
13684 * ),
13685 * @OA\Response(
13686 * response="401",
13687 * ref="#/components/responses/unauthorized"
13688 * ),
13689 * security={{"openemr_auth":{}}}
13690 * )
13691 */
13692 "GET /portal/patient" => function (HttpRestRequest $request) {
13693 $return = (new PatientRestController())->getOne($request->getPatientUUIDString());
13694 RestConfig::apiLog($return);
13695 return $return;
13696 },
13697
13698 /**
13699 * @OA\Get(
13700 * path="/portal/patient/encounter",
13701 * description="Returns encounters for the patient.",
13702 * tags={"standard-patient"},
13703 * @OA\Response(
13704 * response="200",
13705 * ref="#/components/responses/standard"
13706 * ),
13707 * @OA\Response(
13708 * response="400",
13709 * ref="#/components/responses/badrequest"
13710 * ),
13711 * @OA\Response(
13712 * response="401",
13713 * ref="#/components/responses/unauthorized"
13714 * ),
13715 * security={{"openemr_auth":{}}}
13716 * )
13717 */
13718 "GET /portal/patient/encounter" => function (HttpRestRequest $request) {
13719 $return = (new EncounterRestController())->getAll($request->getPatientUUIDString());
13720 RestConfig::apiLog($return);
13721 return $return;
13722 },
13723
13724 /**
13725 * @OA\Get(
13726 * path="/portal/patient/encounter/{euuid}",
13727 * description="Returns a selected encounter by its uuid.",
13728 * tags={"standard-patient"},
13729 * @OA\Parameter(
13730 * name="euuid",
13731 * in="path",
13732 * description="The uuid for the encounter.",
13733 * required=true,
13734 * @OA\Schema(
13735 * type="string"
13736 * )
13737 * ),
13738 * @OA\Response(
13739 * response="200",
13740 * ref="#/components/responses/standard"
13741 * ),
13742 * @OA\Response(
13743 * response="400",
13744 * ref="#/components/responses/badrequest"
13745 * ),
13746 * @OA\Response(
13747 * response="401",
13748 * ref="#/components/responses/unauthorized"
13749 * ),
13750 * security={{"openemr_auth":{}}}
13751 * )
13752 */
13753 "GET /portal/patient/encounter/:euuid" => function ($euuid, HttpRestRequest $request) {
13754 $return = (new EncounterRestController())->getOne($request->getPatientUUIDString(), $euuid);
13755 RestConfig::apiLog($return);
13756 return $return;
13757 },
13758
13759 /**
13760 * @OA\Get(
13761 * path="/portal/patient/appointment",
13762 * description="Retrieves all appointments for a patient",
13763 * tags={"standard-patient"},
13764 * @OA\Response(
13765 * response="200",
13766 * ref="#/components/responses/standard"
13767 * ),
13768 * @OA\Response(
13769 * response="400",
13770 * ref="#/components/responses/badrequest"
13771 * ),
13772 * @OA\Response(
13773 * response="401",
13774 * ref="#/components/responses/unauthorized"
13775 * ),
13776 * security={{"openemr_auth":{}}}
13777 * )
13778 */
13779 "GET /portal/patient/appointment" => function (HttpRestRequest $request) {
13780 $return = (new AppointmentRestController())->getAllForPatientByUuid($request->getPatientUUIDString());
13781 RestConfig::apiLog($return);
13782 return $return;
13783 },
13784
13785
13786 /**
13787 * @OA\Get(
13788 * path="/portal/patient/appointment/{auuid}",
13789 * description="Returns a selected appointment by its uuid.",
13790 * tags={"standard-patient"},
13791 * @OA\Parameter(
13792 * name="auuid",
13793 * in="path",
13794 * description="The uuid for the appointment.",
13795 * required=true,
13796 * @OA\Schema(
13797 * type="string"
13798 * )
13799 * ),
13800 * @OA\Response(
13801 * response="200",
13802 * ref="#/components/responses/standard"
13803 * ),
13804 * @OA\Response(
13805 * response="400",
13806 * ref="#/components/responses/badrequest"
13807 * ),
13808 * @OA\Response(
13809 * response="401",
13810 * ref="#/components/responses/unauthorized"
13811 * ),
13812 * security={{"openemr_auth":{}}}
13813 * )
13814 */
13815 "GET /portal/patient/appointment/:auuid" => function ($auuid, HttpRestRequest $request) {
13816 $return = (new AppointmentRestController())->getOneForPatient($auuid, $request->getPatientUUIDString());
13817 RestConfig::apiLog($return);
13818 return $return;
13819 }
13820 );
Mirror of official OpenEMR Sourceforge repository