-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathFieldWorkerApp API Documentation_v2.yaml
1365 lines (1364 loc) · 31.9 KB
/
FieldWorkerApp API Documentation_v2.yaml
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
openapi: 3.0.1
info:
title: Atya Nidan
description: Documentation providing list of APIs created for the application
version: "1.0"
servers:
- url: http://localhost:9003
description: Development
tags:
- name: Authorization
description: Authentication API
- name: ICD10Code
description: API for fetching ICD10Codes
- name: Admin
description: APIs for implementing functionalities of Admin
- name: Specialization
description: API for handling functionalities of doctor specialization
- name: Doctor
description: APIs for implementing functionalities of Doctor
- name: Field Worker
description: APIs for implementing functionalities of Field workers
- name: Taluka
description: API for handling functionalities of talukas
- name: User
description: API for handling functionalities of all types of users
- name: Form Service
description: APIs part of the Form service
paths:
/atyanidan/auth/api/authenticate:
post:
tags:
- Authorization
summary: Authenticate User
description: Logs in a for a user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationRequest'
required: true
responses:
"200":
description: Successful login
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationResponse'
"400":
description: Invalid username or OTP
/api/fieldworkers/{fieldWorkerEmpId}:
put:
tags:
- Field Worker
summary: Update Availability of Fieldworker
description: Update the availability status of a fieldworker and assign a substitute
operationId: updateFieldWorkerAvailability
parameters:
- name: fieldWorkerEmpId
in: path
description: Fieldworker Emp ID
required: true
schema:
type: string
requestBody:
description: Fieldworker availability status and substitute
content:
application/json:
schema:
$ref: '#/components/schemas/FieldWorkerAvailabilityRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FieldWorker'
"500":
description: Could not update field worker availability
/api/talukas/{talukaId}/fieldworkers:
get:
tags:
- Field Worker
summary: Retrieve list of fieldworkers
description: Retrieve the list of all the fieldworkers of a given taluka
operationId: getFieldWorkersFromTalukaId
parameters:
- name: talukaId
in: path
description: Taluka ID
required: true
schema:
type: integer
format: int32
- name: available
in: query
description: Availability status of fieldworker
required: false
schema:
type: boolean
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FieldWorker'
"404":
description: No fieldworkers found
post:
tags:
- Field Worker
summary: Add a fieldworker
description: Add a fieldworker in a given taluka
operationId: addFieldWorker
parameters:
- name: talukaId
in: path
description: Taluka ID
required: true
schema:
type: integer
format: int32
requestBody:
description: Fieldworker to add
content:
application/json:
schema:
$ref: '#/components/schemas/FieldWorker'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FieldWorker'
"500":
description: Could not add field worker
/api/talukas/{talukaId}/doctors:
post:
tags:
- Doctor
summary: Add a doctor
description: Add a new doctor
operationId: addDoctor
parameters:
- name: talukaId
in: path
description: Taluka ID
required: true
schema:
type: integer
format: int32
requestBody:
description: Doctor to add
content:
application/json:
schema:
$ref: '#/components/schemas/Doctor'
required: true
responses:
"500":
description: Could not add doctor
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Doctor'
/api/prescription-responses:
post:
tags:
- prescription-response-controller
operationId: addPrescription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OlapPrescription'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PrescriptionResponse'
/api/pdfwriter:
post:
tags:
- pdf-storage-controller
operationId: generatePdf
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PdfStorage'
/api/users/{employeeId}:
get:
tags:
- User
summary: Retrieve user
description: Retrieve a user given the user's employee ID
operationId: getUserFromEmployeeId
parameters:
- name: employeeId
in: path
description: Employee ID of user to be retrieved
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
"404":
description: User not found
/api/stats/states/{stateId}:
get:
tags:
- stats-controller
operationId: getHealthCountByState
parameters:
- name: stateId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UnHealthyCountByDate'
/api/stats/districts/{districtId}:
get:
tags:
- stats-controller
operationId: getHealthCountByDistrict
parameters:
- name: districtId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UnHealthyCountByDate'
/api/states/{stateId}/admins:
get:
tags:
- Admin
summary: Retrieve list of admins
description: Retrieve the list of all the admins of a given state
operationId: getAdminsFromStateId
parameters:
- name: stateId
in: path
description: State ID
required: true
schema:
type: integer
format: int32
responses:
"404":
description: No fieldworkers found
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Admin'
/api/specialisations:
get:
tags:
- Specialization
summary: Retrieve Specialisations
description: Retrieve all the specialisations
operationId: getAllSpecialisations
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Specialisation'
"404":
description: No specializations found
/api/pdfwriter/{pdfId}:
get:
tags:
- pdf-storage-controller
operationId: getPdf
parameters:
- name: pdfId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PdfStorage'
/api/patients/{patientNumber}/health-records:
get:
tags:
- patient-controller
operationId: getFormsAndPrescriptionsByPatientNumber
parameters:
- name: patientNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/HealthRecord'
/api/patients/{patientNumber}/demographics:
get:
tags:
- patient-controller
operationId: getPersonDemographics
parameters:
- name: patientNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PatientDemographicDetailsResponse'
/api/icd10Codes:
get:
tags:
- ICD10Code
operationId: getAllICD10Codes
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ICDCode'
/api/icd10Codes/{code}:
get:
tags:
- ICD10Code
operationId: getAllICD10Codes_1
parameters:
- name: code
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ICDCode'
/api/fieldworkers/{fieldworkerId}/followups:
get:
tags:
- field-worker-follow-up-controller
operationId: getFollowUpsByFieldWorker
parameters:
- name: fieldworkerId
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/FieldWorkerFollowUp'
/api/doctors/{doctorNumber}/patients:
get:
tags:
- patient-controller
operationId: getPatientsByDoctorId
parameters:
- name: doctorNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/PatientDataResponse'
/api/doctors/specialisations/{specialisationId}/talukas/{talukaId}:
get:
tags:
- Doctor
operationId: getDoctorsBySpecialisation
parameters:
- name: specialisationId
in: path
required: true
schema:
type: integer
format: int32
- name: talukaId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/Doctor'
/api/districts/{districtId}/talukas:
get:
tags:
- Taluka
summary: Get talukas
description: Retrieve all the talukas of a given district
operationId: getTalukasFromDistrictId
parameters:
- name: districtId
in: path
description: District ID
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Taluka'
"404":
description: Taluka not found
/api/districts/{districtId}/fieldworkers:
get:
tags:
- Field Worker
summary: Retrieve list of fieldworkers
description: Retrieve the list of all the fieldworkers of a given district
operationId: getFieldWorkersFromDistrictId
parameters:
- name: districtId
in: path
description: District ID
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FieldWorker'
"404":
description: No fieldworkers found
/api/districts/{districtId}/doctors:
get:
tags:
- Doctor
summary: Retrieve doctors
description: Retrieve the list of doctors given the district ID
operationId: getDoctorsFromDistrictId
parameters:
- name: districtId
in: path
description: District ID
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Doctor'
"404":
description: No doctors found
/api/forms/default/{formId}:
put:
tags:
- Form Service
summary: Set Default form
description: Set a form as default
operationId: setDefaultForm
parameters:
- name: formId
in: path
required: true
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Form'
"500":
description: Could not update form
/api/forms:
get:
tags:
- Form Service
operationId: getForms
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/Form'
post:
tags:
- Form Service
summary: Add a form
description: Add a new form
operationId: addForm
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FormDefinition'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Form'
"500":
description: Could not add form
/api/form-responses:
post:
tags:
- form-response-controller
operationId: addForm_1
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OlapFormRequest'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/OlapForm'
/api/form-definitions:
get:
tags:
- form-definition-controller
operationId: getFormDefinitions
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
post:
tags:
- form-definition-controller
operationId: addFormDefinition
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FormDefinition'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/FormDefinition'
/api/abha/demographics:
post:
tags:
- abha-controller
operationId: retrievePersonDemographics
requestBody:
content:
application/json:
schema:
type: string
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PatientDemographicDetailsResponse'
/api/forms/form-definitions:
get:
tags:
- Form Service
operationId: getFormsWithFormDefinition
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/FormsWithFormDefinitionsResponse'
/api/forms/default:
get:
tags:
- Form Service
operationId: getDefaultForm
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/FormDefinition'
/api/form-responses/patient/{patientNumber}:
get:
tags:
- form-response-controller
operationId: getFormResponsesByPatientNumber
parameters:
- name: patientNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/FormNameTimestampResponse'
/api/form-definitions/{formDefinitionId}:
get:
tags:
- form-definition-controller
operationId: getFormDefinition
parameters:
- name: formDefinitionId
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/FormDefinition'
/api/demo:
get:
tags:
- demo-controller
operationId: demoMethod
responses:
"200":
description: OK
content:
'*/*':
schema:
type: string
components:
schemas:
AuthenticationRequest:
type: object
properties:
userCredential:
type: string
otp:
type: string
authenticationType:
type: string
enum:
- Phone_Number
- Email
AuthenticationResponse:
type: object
properties:
token:
type: string
user:
$ref: '#/components/schemas/User'
FieldWorkerAvailabilityRequest:
type: object
properties:
substituteFieldWorkerEmpId:
type: string
available:
type: boolean
District:
required:
- name
type: object
properties:
id:
type: integer
format: int32
name:
type: string
FieldWorker:
required:
- aadharNumber
- email
- firstName
- gender
- homeAddress
- languageKnown1
- lastName
- officeAddress
- phoneNumber
- role
- taluka
type: object
properties:
phoneNumber:
maxLength: 10
minLength: 10
type: string
email:
type: string
role:
type: string
enum:
- FieldWorker
- Doctor
- Admin
- SuperAdmin
empId:
type: string
firstName:
type: string
middleName:
type: string
lastName:
type: string
homeAddress:
type: string
officeAddress:
type: string
nearestRailwayStation:
type: string
gender:
type: string
enum:
- Male
- Female
- Other
taluka:
$ref: '#/components/schemas/Taluka'
dob:
type: string
format: date-time
bloodGroup:
type: string
aadharNumber:
maxLength: 12
minLength: 12
type: string
available:
type: boolean
substitute:
type: integer
format: int32
languageKnown1:
type: string
languageKnown2:
type: string
languageKnown3:
type: string
Taluka:
required:
- district
- name
type: object
properties:
id:
type: integer
format: int32
name:
type: string
district:
$ref: '#/components/schemas/District'
Doctor:
required:
- aadharNumber
- email
- firstName
- homeAddress
- hospitalAddress
- languageKnown1
- lastName
- phoneNumber
- role
- specialisation
- taluka
type: object
properties:
phoneNumber:
maxLength: 10
minLength: 10
type: string
email:
type: string
role:
type: string
enum:
- FieldWorker
- Doctor
- Admin
- SuperAdmin
empId:
type: string
firstName:
type: string
middleName:
type: string
lastName:
type: string
homeAddress:
type: string
hospitalAddress:
type: string
nearestRailwayStation:
type: string
gender:
type: string
enum:
- Male
- Female
- Other
specialisation:
$ref: '#/components/schemas/Specialisation'
taluka:
$ref: '#/components/schemas/Taluka'
dob:
type: string
format: date-time
bloodGroup:
type: string
aadharNumber:
maxLength: 12
minLength: 12
type: string
languageKnown1:
type: string
languageKnown2:
type: string
languageKnown3:
type: string
Specialisation:
required:
- name
type: object
properties:
id:
type: integer
format: int32
name:
type: string
description:
type: string
Dosage:
type: object
properties:
days:
type: string
name:
type: string
morningDose:
type: string
afternoonDose:
type: string
eveningDose:
type: string
FollowUpDetails:
type: object
properties:
interval:
type: integer
format: int32
repeatFrequency:
type: integer
format: int32
OlapPrescription:
type: object
properties:
formTitle:
type: string
patientNumber:
type: string
doctorId:
type: string
followUpDetails:
$ref: '#/components/schemas/FollowUpDetails'
notes:
type: string
icdCode:
type: string
prescriptionDetails:
$ref: '#/components/schemas/PrescriptionDetails'
PrescriptionDetails:
type: object
properties:
age:
type: string
height:
type: string
weight:
type: string
dosages:
type: array
items: