forked from openemr/openemr
-
Notifications
You must be signed in to change notification settings - Fork 13
/
_rest_routes.inc.php
13820 lines (13638 loc) · 513 KB
/
_rest_routes.inc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Routes
* (All REST routes)
*
* @package OpenEMR
* @link http://www.open-emr.org
* @author Matthew Vita <[email protected]>
* @author Jerry Padgett <[email protected]>
* @author Brady Miller <[email protected]>
* @author Yash Raj Bothra <[email protected]>
* @author Stephen Nielson <[email protected]>
* @copyright Copyright (c) 2018 Matthew Vita <[email protected]>
* @copyright Copyright (c) 2018-2020 Jerry Padgett <[email protected]>
* @copyright Copyright (c) 2019-2021 Brady Miller <[email protected]>
* @copyright Copyright (c) 2020 Yash Raj Bothra <[email protected]>
* @copyright Copyright (c) 2024 Care Management Solutions, Inc. <[email protected]>
* @license https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
*/
/**
* @OA\Info(title="OpenEMR API", version="7.0.3")
* @OA\Server(url="/apis/default/")
* @OA\SecurityScheme(
* securityScheme="openemr_auth",
* type="oauth2",
* @OA\Flow(
* authorizationUrl="/oauth2/default/authorize",
* tokenUrl="/oauth2/default/token",
* refreshUrl="/oauth2/default/token",
* flow="authorizationCode",
* scopes={
* "openid": "Generic mandatory scope",
* "offline_access": "Will signal server to provide a refresh token",
* "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)",
* "api:fhir": "FHIR R4 API",
* "patient/AllergyIntolerance.read": "Read allergy intolerance resources for the current patient (api:fhir)",
* "patient/Appointment.read": "Read appointment resources for the current patient (api:fhir)",
* "patient/Binary.read": "Read binary document resources for the current patient (api:fhir)",
* "patient/CarePlan.read": "Read care plan resources for the current patient (api:fhir)",
* "patient/CareTeam.read": "Read care team resources for the current patient (api:fhir)",
* "patient/Condition.read": "Read condition resources for the current patient (api:fhir)",
* "patient/Coverage.read": "Read coverage resources for the current patient (api:fhir)",
* "patient/Device.read": "Read device resources for the current patient (api:fhir)",
* "patient/DiagnosticReport.read": "Read diagnostic report resources for the current patient (api:fhir)",
* "patient/DocumentReference.read": "Read document reference resources for the current patient (api:fhir)",
* "patient/DocumentReference.$docref" : "Generate a document for the current patient or returns the most current Clinical Summary of Care Document (CCD)",
* "patient/Encounter.read": "Read encounter resources for the current patient (api:fhir)",
* "patient/Goal.read": "Read goal resources for the current patient (api:fhir)",
* "patient/Immunization.read": "Read immunization resources for the current patient (api:fhir)",
* "patient/Location.read": "Read location resources for the current patient (api:fhir)",
* "patient/Medication.read": "Read medication resources for the current patient (api:fhir)",
* "patient/MedicationRequest.read": "Read medication request resources for the current patient (api:fhir)",
* "patient/Observation.read": "Read observation resources for the current patient (api:fhir)",
* "patient/Organization.read": "Read organization resources for the current patient (api:fhir)",
* "patient/Patient.read": "Read patient resource for the current patient (api:fhir)",
* "patient/Person.read": "Read person resources for the current patient (api:fhir)",
* "patient/Practitioner.read": "Read practitioner resources for the current patient (api:fhir)",
* "patient/Procedure.read": "Read procedure resources for the current patient (api:fhir)",
* "patient/Provenance.read": "Read provenance resources for the current patient (api:fhir)",
* "system/AllergyIntolerance.read": "Read all allergy intolerance resources in the system (api:fhir)",
* "system/Binary.read": "Read all binary document resources in the system (api:fhir)",
* "system/CarePlan.read": "Read all care plan resources in the system (api:fhir)",
* "system/CareTeam.read": "Read all care team resources in the system (api:fhir)",
* "system/Condition.read": "Read all condition resources in the system (api:fhir)",
* "system/Coverage.read": "Read all coverage resources in the system (api:fhir)",
* "system/Device.read": "Read all device resources in the system (api:fhir)",
* "system/DiagnosticReport.read": "Read all diagnostic report resources in the system (api:fhir)",
* "system/DocumentReference.read": "Read all document reference resources in the system (api:fhir)",
* "system/DocumentReference.$docref" : "Generate a document for any patient in the system or returns the most current Clinical Summary of Care Document (CCD)",
* "system/Encounter.read": "Read all encounter resources in the system (api:fhir)",
* "system/Goal.read": "Read all goal resources in the system (api:fhir)",
* "system/Group.read": "Read all group resources in the system (api:fhir)",
* "system/Immunization.read": "Read all immunization resources in the system (api:fhir)",
* "system/Location.read": "Read all location resources in the system (api:fhir)",
* "system/Medication.read": "Read all medication resources in the system (api:fhir)",
* "system/MedicationRequest.read": "Read all medication request resources in the system (api:fhir)",
* "system/Observation.read": "Read all observation resources in the system (api:fhir)",
* "system/Organization.read": "Read all organization resources in the system (api:fhir)",
* "system/Patient.read": "Read all patient resources in the system (api:fhir)",
* "system/Person.read": "Read all person resources in the system (api:fhir)",
* "system/Practitioner.read": "Read all practitioner resources in the system (api:fhir)",
* "system/PractitionerRole.read": "Read all practitioner role resources in the system (api:fhir)",
* "system/Procedure.read": "Read all procedure resources in the system (api:fhir)",
* "system/Provenance.read": "Read all provenance resources in the system (api:fhir)",
* "system/ValueSet.read": "Read all valueSet resources in the system (api:fhir)",
* "user/AllergyIntolerance.read": "Read all allergy intolerance resources the user has access to (api:fhir)",
* "user/Binary.read" : "Read all binary documents the user has access to (api:fhir)",
* "user/CarePlan.read": "Read all care plan resources the user has access to (api:fhir)",
* "user/CareTeam.read": "Read all care team resources the user has access to (api:fhir)",
* "user/Condition.read": "Read all condition resources the user has access to (api:fhir)",
* "user/Coverage.read": "Read all coverage resources the user has access to (api:fhir)",
* "user/Device.read": "Read all device resources the user has access to (api:fhir)",
* "user/DiagnosticReport.read": "Read all diagnostic report resources the user has access to (api:fhir)",
* "user/DocumentReference.read": "Read all document reference resources the user has access to (api:fhir)",
* "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)",
* "user/Encounter.read": "Read all encounter resources the user has access to (api:fhir)",
* "user/Goal.read": "Read all goal resources the user has access to (api:fhir)",
* "user/Immunization.read": "Read all immunization resources the user has access to (api:fhir)",
* "user/Location.read": "Read all location resources the user has access to (api:fhir)",
* "user/Medication.read": "Read all medication resources the user has access to (api:fhir)",
* "user/MedicationRequest.read": "Read all medication request resources the user has access to (api:fhir)",
* "user/Observation.read": "Read all observation resources the user has access to (api:fhir)",
* "user/Organization.read": "Read all organization resources the user has access to (api:fhir)",
* "user/Organization.write": "Write all organization resources the user has access to (api:fhir)",
* "user/Patient.read": "Read all patient resources the user has access to (api:fhir)",
* "user/Patient.write": "Write all patient resources the user has access to (api:fhir)",
* "user/Person.read": "Read all person resources the user has access to (api:fhir)",
* "user/Practitioner.read": "Read all practitioner resources the user has access to (api:fhir)",
* "user/Practitioner.write": "Write all practitioner resources the user has access to (api:fhir)",
* "user/PractitionerRole.read": "Read all practitioner role resources the user has access to (api:fhir)",
* "user/Procedure.read": "Read all procedure resources the user has access to (api:fhir)",
* "user/Provenance.read": "Read all provenance resources the user has access to (api:fhir)",
* "user/ValueSet.read": "Read all valueSet resources the user has access to (api:fhir)",
* "api:oemr": "Standard OpenEMR API",
* "user/allergy.read": "Read allergies the user has access to (api:oemr)",
* "user/allergy.write": "Write allergies the user has access to for (api:oemr)",
* "user/appointment.read": "Read appointments the user has access to (api:oemr)",
* "user/appointment.write": "Write appointments the user has access to for (api:oemr)",
* "user/dental_issue.read": "Read dental issues the user has access to (api:oemr)",
* "user/dental_issue.write": "Write dental issues the user has access to (api:oemr)",
* "user/document.read": "Read documents the user has access to (api:oemr)",
* "user/document.write": "Write documents the user has access to (api:oemr)",
* "user/drug.read": "Read drugs the user has access to (api:oemr)",
* "user/encounter.read": "Read encounters the user has access to (api:oemr)",
* "user/encounter.write": "Write encounters the user has access to (api:oemr)",
* "user/facility.read": "Read facilities the user has access to (api:oemr)",
* "user/facility.write": "Write facilities the user has access to (api:oemr)",
* "user/immunization.read": "Read immunizations the user has access to (api:oemr)",
* "user/insurance.read": "Read insurances the user has access to (api:oemr)",
* "user/insurance.write": "Write insurances the user has access to (api:oemr)",
* "user/insurance_company.read": "Read insurance companies the user has access to (api:oemr)",
* "user/insurance_company.write": "Write insurance companies the user has access to (api:oemr)",
* "user/insurance_type.read": "Read insurance types the user has access to (api:oemr)",
* "user/list.read": "Read lists the user has access to (api:oemr)",
* "user/medical_problem.read": "Read medical problems the user has access to (api:oemr)",
* "user/medical_problem.write": "Write medical problems the user has access to (api:oemr)",
* "user/medication.read": "Read medications the user has access to (api:oemr)",
* "user/medication.write": "Write medications the user has access to (api:oemr)",
* "user/message.write": "Read messages the user has access to (api:oemr)",
* "user/patient.read": "Read patients the user has access to (api:oemr)",
* "user/patient.write": "Write patients the user has access to (api:oemr)",
* "user/practitioner.read": "Read practitioners the user has access to (api:oemr)",
* "user/practitioner.write": "Write practitioners the user has access to (api:oemr)",
* "user/prescription.read": "Read prescriptions the user has access to (api:oemr)",
* "user/procedure.read": "Read procedures the user has access to (api:oemr)",
* "user/soap_note.read": "Read soap notes the user has access to (api:oemr)",
* "user/soap_note.write": "Write soap notes the user has access to (api:oemr)",
* "user/surgery.read": "Read surgeries the user has access to (api:oemr)",
* "user/surgery.write": "Write surgeries the user has access to (api:oemr)",
* "user/transaction.read": "Read transactions the user has access to (api:oemr)",
* "user/transaction.write": "Write transactions the user has access to (api:oemr)",
* "user/user.read": "Read users the current user has access to (api:oemr)",
* "user/vital.read": "Read vitals the user has access to (api:oemr)",
* "user/vital.write": "Write vitals the user has access to (api:oemr)",
* "api:port": "Standard Patient Portal OpenEMR API",
* "patient/encounter.read": "Read encounters the patient has access to (api:port)",
* "patient/patient.read": "Write encounters the patient has access to (api:port)",
* "patient/appointment.read": "Read appointments the patient has access to (api:port)"
* }
* )
* )
* @OA\Tag(
* name="fhir",
* description="FHIR R4 API"
* )
* @OA\Tag(
* name="standard",
* description="Standard OpenEMR API"
* )
* @OA\Tag(
* name="standard-patient",
* description="Standard Patient Portal OpenEMR API"
* )
* @OA\Parameter(
* name="_sort",
* in="query",
* parameter="_sort",
* 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)",
* required=false,
* @OA\Schema(
* type="string"
* )
* )
* @OA\Parameter(
* name="_lastUpdated",
* in="query",
* parameter="_lastUpdated",
* description="The date the resource was last updated.",
* required=false,
* @OA\Schema(
* type="string"
* )
* )
* @OA\Response(
* response="standard",
* description="Standard Response",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="validationErrors",
* description="Validation errors.",
* type="array",
* @OA\Items(
* type="object",
* ),
* ),
* @OA\Property(
* property="internalErrors",
* description="Internal errors.",
* type="array",
* @OA\Items(
* type="object",
* ),
* ),
* @OA\Property(
* property="data",
* description="Returned data.",
* type="array",
* @OA\Items(
* type="object",
* ),
* ),
* example={
* "validationErrors": {},
* "error_description": {},
* "data": {}
* }
* )
* )
* )
* @OA\Response(
* response="badrequest",
* description="Bad Request",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="validationErrors",
* description="Validation errors.",
* type="object"
* ),
* example={
* "validationErrors":
* {
* "_id": "The search field argument was invalid, improperly formatted, or could not be parsed. Inner message: UUID columns must be a valid UUID string"
* }
* }
* )
* )
* )
* @OA\Response(
* response="unauthorized",
* description="Unauthorized",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="error",
* description="The error.",
* type="string"
* ),
* @OA\Property(
* property="error_description",
* description="The description of the error.",
* type="string"
* ),
* @OA\Property(
* property="hint",
* description="More specific information on the error.",
* type="string"
* ),
* @OA\Property(
* property="message",
* description="Message regarding the error.",
* type="string"
* ),
* example={
* "error": "access_denied",
* "error_description": "The resource owner or authorization server denied the request.",
* "hint": "Missing ""Authorization"" header",
* "message": "The resource owner or authorization server denied the request."
* }
* )
* )
* )
* @OA\Response(
* response="uuidnotfound",
* description="Not Found",
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="empty",
* description="empty",
* type="object"
* ),
* example={}
* )
* )
* )
*/
// Lets keep our controller classes with the routes.
//
use OpenEMR\Common\Acl\AccessDeniedException;
use OpenEMR\Common\Http\HttpRestRequest;
use OpenEMR\RestControllers\AllergyIntoleranceRestController;
use OpenEMR\RestControllers\FacilityRestController;
use OpenEMR\RestControllers\VersionRestController;
use OpenEMR\RestControllers\ProductRegistrationRestController;
use OpenEMR\RestControllers\PatientRestController;
use OpenEMR\RestControllers\EncounterRestController;
use OpenEMR\RestControllers\PractitionerRestController;
use OpenEMR\RestControllers\ListRestController;
use OpenEMR\RestControllers\InsuranceCompanyRestController;
use OpenEMR\RestControllers\AppointmentRestController;
use OpenEMR\RestControllers\ConditionRestController;
use OpenEMR\RestControllers\ONoteRestController;
use OpenEMR\RestControllers\DocumentRestController;
use OpenEMR\RestControllers\DrugRestController;
use OpenEMR\RestControllers\EmployerRestController;
use OpenEMR\RestControllers\ImmunizationRestController;
use OpenEMR\RestControllers\InsuranceRestController;
use OpenEMR\RestControllers\MessageRestController;
use OpenEMR\RestControllers\PrescriptionRestController;
use OpenEMR\RestControllers\ProcedureRestController;
use OpenEMR\RestControllers\TransactionRestController;
use OpenEMR\RestControllers\UserRestController;
use OpenEMR\Services\Search\SearchQueryConfig;
// Note some Http clients may not send auth as json so a function
// is implemented to determine and parse encoding on auth route's.
// Note that the api route is only for users role
// (there is a mechanism in place to ensure only user role can access the api route)
RestConfig::$ROUTE_MAP = array(
/**
* @OA\Get(
* path="/api/facility",
* description="Returns a single facility.",
* tags={"standard"},
* @OA\Parameter(
* name="name",
* in="query",
* description="The name for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="facility_npi",
* in="query",
* description="The facility_npi for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="phone",
* in="query",
* description="The phone for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="fax",
* in="query",
* description="The fax for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="street",
* in="query",
* description="The street for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="city",
* in="query",
* description="The city for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="state",
* in="query",
* description="The state for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="postal_code",
* in="query",
* description="The postal_code for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="country_code",
* in="query",
* description="The country_code for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="federal_ein",
* in="query",
* description="The federal_ein for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="website",
* in="query",
* description="The website for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="email",
* in="query",
* description="The email for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="domain_identifier",
* in="query",
* description="The domain_identifier for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="facility_taxonomy",
* in="query",
* description="The facility_taxonomy for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="facility_code",
* in="query",
* description="The facility_code for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="billing_location",
* in="query",
* description="The billing_location setting for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="accepts_assignment",
* in="query",
* description="The accepts_assignment setting for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="oid",
* in="query",
* description="The oid for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="service_location",
* in="query",
* description="The service_location setting for the facility.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Response(
* response="200",
* ref="#/components/responses/standard"
* ),
* @OA\Response(
* response="400",
* ref="#/components/responses/badrequest"
* ),
* @OA\Response(
* response="401",
* ref="#/components/responses/unauthorized"
* ),
* security={{"openemr_auth":{}}}
* )
*/
"GET /api/facility" => function () {
RestConfig::authorization_check("admin", "users");
$return = (new FacilityRestController())->getAll($_GET);
RestConfig::apiLog($return);
return $return;
},
/**
* @OA\Get(
* path="/api/facility/{fuuid}",
* description="Returns a single facility.",
* tags={"standard"},
* @OA\Parameter(
* name="fuuid",
* in="path",
* description="The uuid for the facility.",
* required=true,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Response(
* response="200",
* ref="#/components/responses/standard"
* ),
* @OA\Response(
* response="400",
* ref="#/components/responses/badrequest"
* ),
* @OA\Response(
* response="401",
* ref="#/components/responses/unauthorized"
* ),
* security={{"openemr_auth":{}}}
* )
*/
"GET /api/facility/:fuuid" => function ($fuuid) {
RestConfig::authorization_check("admin", "users");
$return = (new FacilityRestController())->getOne($fuuid);
RestConfig::apiLog($return);
return $return;
},
/**
* @OA\Post(
* path="/api/facility",
* description="Creates a facility in the system",
* tags={"standard"},
* @OA\RequestBody(
* required=true,
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="name",
* description="The name for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_npi",
* description="The facility_npi for the facility.",
* type="string"
* ),
* @OA\Property(
* property="phone",
* description="The phone for the facility.",
* type="string"
* ),
* @OA\Property(
* property="fax",
* description="The fax for the facility.",
* type="string"
* ),
* @OA\Property(
* property="street",
* description="The street for the facility.",
* type="string"
* ),
* @OA\Property(
* property="city",
* description="The city for the facility.",
* type="string"
* ),
* @OA\Property(
* property="state",
* description="The state for the facility.",
* type="string"
* ),
* @OA\Property(
* property="postal_code",
* description="The postal_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="country_code",
* description="The country_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="federal_ein",
* description="The federal_ein for the facility.",
* type="string"
* ),
* @OA\Property(
* property="website",
* description="The website for the facility.",
* type="string"
* ),
* @OA\Property(
* property="email",
* description="The email for the facility.",
* type="string"
* ),
* @OA\Property(
* property="domain_identifier",
* description="The domain_identifier for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_taxonomy",
* description="The facility_taxonomy for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_code",
* description="The facility_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="billing_location",
* description="The billing_location setting for the facility.",
* type="string"
* ),
* @OA\Property(
* property="accepts_assignment",
* description="The accepts_assignment setting for the facility.",
* type="string"
* ),
* @OA\Property(
* property="oid",
* description="The oid for the facility.",
* type="string"
* ),
* @OA\Property(
* property="service_location",
* description="The service_location setting for the facility.",
* type="string"
* ),
* required={"name", "facility_npi"},
* example={
* "name": "Aquaria",
* "facility_npi": "123456789123",
* "phone": "808-606-3030",
* "fax": "808-606-3031",
* "street": "1337 Bit Shifter Ln",
* "city": "San Lorenzo",
* "state": "ZZ",
* "postal_code": "54321",
* "country_code": "US",
* "federal_ein": "4343434",
* "website": "https://example.com",
* "email": "[email protected]",
* "domain_identifier": "",
* "facility_taxonomy": "",
* "facility_code": "",
* "billing_location": "1",
* "accepts_assignment": "1",
* "oid": "",
* "service_location": "1"
* }
* )
* )
* ),
* @OA\Response(
* response="200",
* ref="#/components/responses/standard"
* ),
* @OA\Response(
* response="400",
* ref="#/components/responses/badrequest"
* ),
* @OA\Response(
* response="401",
* ref="#/components/responses/unauthorized"
* ),
* security={{"openemr_auth":{}}}
* )
*/
"POST /api/facility" => function () {
RestConfig::authorization_check("admin", "super");
$data = (array) (json_decode(file_get_contents("php://input")));
$return = (new FacilityRestController())->post($data);
RestConfig::apiLog($return, $data);
return $return;
},
/**
* @OA\Put(
* path="/api/facility/{fuuid}",
* description="Updates a facility in the system",
* tags={"standard"},
* @OA\Parameter(
* name="fuuid",
* in="path",
* description="The uuid for the facility.",
* required=true,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\RequestBody(
* required=true,
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* @OA\Property(
* property="name",
* description="The name for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_npi",
* description="The facility_npi for the facility.",
* type="string"
* ),
* @OA\Property(
* property="phone",
* description="The phone for the facility.",
* type="string"
* ),
* @OA\Property(
* property="fax",
* description="The fax for the facility.",
* type="string"
* ),
* @OA\Property(
* property="street",
* description="The street for the facility.",
* type="string"
* ),
* @OA\Property(
* property="city",
* description="The city for the facility.",
* type="string"
* ),
* @OA\Property(
* property="state",
* description="The state for the facility.",
* type="string"
* ),
* @OA\Property(
* property="postal_code",
* description="The postal_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="country_code",
* description="The country_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="federal_ein",
* description="The federal_ein for the facility.",
* type="string"
* ),
* @OA\Property(
* property="website",
* description="The website for the facility.",
* type="string"
* ),
* @OA\Property(
* property="email",
* description="The email for the facility.",
* type="string"
* ),
* @OA\Property(
* property="domain_identifier",
* description="The domain_identifier for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_taxonomy",
* description="The facility_taxonomy for the facility.",
* type="string"
* ),
* @OA\Property(
* property="facility_code",
* description="The facility_code for the facility.",
* type="string"
* ),
* @OA\Property(
* property="billing_location",
* description="The billing_location setting for the facility.",
* type="string"
* ),
* @OA\Property(
* property="accepts_assignment",
* description="The accepts_assignment setting for the facility.",
* type="string"
* ),
* @OA\Property(
* property="oid",
* description="The oid for the facility.",
* type="string"
* ),
* @OA\Property(
* property="service_location",
* description="The service_location setting for the facility.",
* type="string"
* ),
* example={
* "name": "Aquaria",
* "facility_npi": "123456789123",
* "phone": "808-606-3030",
* "fax": "808-606-3031",
* "street": "1337 Bit Shifter Ln",
* "city": "San Lorenzo",
* "state": "ZZ",
* "postal_code": "54321",
* "country_code": "US",
* "federal_ein": "4343434",
* "website": "https://example.com",
* "email": "[email protected]",
* "domain_identifier": "",
* "facility_taxonomy": "",
* "facility_code": "",
* "billing_location": "1",
* "accepts_assignment": "1",
* "oid": "",
* "service_location": "1"
* }
* )
* )
* ),
* @OA\Response(
* response="200",
* ref="#/components/responses/standard"
* ),
* @OA\Response(
* response="400",
* ref="#/components/responses/badrequest"
* ),
* @OA\Response(
* response="401",
* ref="#/components/responses/unauthorized"
* ),
* security={{"openemr_auth":{}}}
* )
*/
"PUT /api/facility/:fuuid" => function ($fuuid) {
RestConfig::authorization_check("admin", "super");
$data = (array) (json_decode(file_get_contents("php://input")));
$return = (new FacilityRestController())->patch($fuuid, $data);
RestConfig::apiLog($return, $data);
return $return;
},
/**
* @OA\Get(
* path="/api/patient",
* description="Retrieves a list of patients",
* tags={"standard"},
* @OA\Parameter(
* ref="#/components/parameters/_sort"
* ),
* @OA\Parameter(
* name="fname",
* in="query",
* description="The first name for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="lname",
* in="query",
* description="The last name for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="ss",
* in="query",
* description="The social security number for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="street",
* in="query",
* description="The street for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="postal_code",
* in="query",
* description="The postal code for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="city",
* in="query",
* description="The city for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="state",
* in="query",
* description="The state for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="phone_home",
* in="query",
* description="The home phone for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="phone_biz",
* in="query",
* description="The business phone for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="phone_cell",
* in="query",
* description="The cell phone for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="postal_contact",
* in="query",
* description="The postal_contact for the patient.",
* required=false,
* @OA\Schema(
* type="string"
* )
* ),
* @OA\Parameter(
* name="sex",
* in="query",
* description="The gender for the patient.",
* required=false,
* @OA\Schema(