-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
577 lines (577 loc) · 19 KB
/
openapi.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
openapi: 3.0.1
info:
title: Health&Med MVP
description: Demo API para sistema de consultas médicas online
contact:
name: Grupo 15
url: http://fiap-3soat-g15-healthmed.s3-website-us-east-1.amazonaws.com
version: 1.0.0
servers:
- url: /
paths:
/healthmed/patient/{document}:
put:
tags:
- patient-controller
summary: Atualizar um cadastro de um paciente
operationId: update
parameters:
- name: document
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PatientRequest"
required: true
responses:
"200":
description: Operação bem-sucedida
content:
'*/*':
schema:
$ref: "#/components/schemas/Patient"
/healthmed/doctor/{crm}:
get:
tags:
- doctor-controller
operationId: get
parameters:
- name: crm
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/Doctor"
put:
tags:
- doctor-controller
summary: Atualizar um cadastro de um médico
operationId: update_1
parameters:
- name: crm
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DoctorRequest"
required: true
responses:
"200":
description: Operação bem-sucedida
content:
'*/*':
schema:
$ref: "#/components/schemas/Doctor"
/healthmed/patient:
post:
tags:
- patient-controller
summary: Cria um cadastro de um paciente
operationId: create
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PatientRequest"
required: true
responses:
"200":
description: Operação bem-sucedida
content:
'*/*':
schema:
$ref: "#/components/schemas/Patient"
/healthmed/medical-record/{appointmentNumber}/append:
post:
tags:
- medical-record-controller
operationId: appendAnnotations
parameters:
- name: appointmentNumber
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/MedicalRecordContentRequest"
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/medical-appointment/{document}/{crm}:
post:
tags:
- medical-appointment-by-patient-controller
operationId: scheduleAppointment
parameters:
- name: document
in: path
required: true
schema:
type: string
- name: crm
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TimeAndDateToScheduleRequest"
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/medical-appointment/{document}/cancel/{appointmentNumber}:
post:
tags:
- medical-appointment-by-patient-controller
operationId: cancelAppointment
parameters:
- name: document
in: path
required: true
schema:
type: string
- name: appointmentNumber
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JustificationCancellationRequest"
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/medical-appointment/{crm}/reject/{appointmentNumber}:
post:
tags:
- medical-appointment-by-doctor-controller
operationId: rejectAppointment
parameters:
- name: crm
in: path
required: true
schema:
type: string
- name: appointmentNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/medical-appointment/{crm}/cancel/{appointmentNumber}:
post:
tags:
- medical-appointment-by-doctor-controller
operationId: acceptAppointment
parameters:
- name: crm
in: path
required: true
schema:
type: string
- name: appointmentNumber
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/doctor:
post:
tags:
- doctor-controller
summary: Cria um cadastro de um médico
operationId: create_1
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DoctorRequest"
required: true
responses:
"200":
description: Operação bem-sucedida
content:
'*/*':
schema:
$ref: "#/components/schemas/Doctor"
/healthmed/doctor/{crm}/update-availability:
patch:
tags:
- doctor-controller
summary: Atualizar os horarios disponiveis do medico
operationId: updateAvailableTimes
parameters:
- name: crm
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AvailableTimesRequest"
required: true
responses:
"200":
description: Operação bem-sucedida
content:
'*/*':
schema:
$ref: "#/components/schemas/Doctor"
/healthmed/medical-appointment/{document}:
get:
tags:
- medical-appointment-by-patient-controller
operationId: getAllMyAppointments
parameters:
- name: document
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/medical-appointment/{crm}:
get:
tags:
- medical-appointment-by-doctor-controller
operationId: getAllMyAppointments_1
parameters:
- name: crm
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: "#/components/schemas/MedicalAppointment"
/healthmed/doctor/search:
get:
tags:
- doctor-controller
operationId: search
parameters:
- name: query
in: query
required: true
schema:
type: object
additionalProperties:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: "#/components/schemas/Doctor"
components:
schemas:
PatientRequest:
type: object
properties:
document:
type: string
description: CPF
example: "12345678900"
name:
type: string
description: Name
example: Foo Bar
email:
type: string
description: Email
example: [email protected]
phoneNumber:
type: string
description: Phone number
example: "+5511999999999"
zipCode:
type: string
description: ZIP code
example: "12345678"
address:
type: string
description: Address
example: "123, Main St."
Patient:
required:
- address
- document
- email
- name
- phoneNumber
- zipCode
type: object
properties:
document:
type: string
name:
type: string
email:
type: string
phoneNumber:
type: string
zipCode:
type: string
address:
type: string
AvailablePeriodsRequest:
type: object
properties:
start:
type: string
description: Start time
format: date-time
end:
type: string
description: End time
format: date-time
description: Available slots
example:
MONDAY:
- start: 2022-12-31T00:00:00
end: 2022-12-31T23:59:59
AvailableTimesRequest:
type: object
properties:
slots:
type: object
additionalProperties:
type: array
description: Available slots
example:
MONDAY:
- start: 2022-12-31T00:00:00
end: 2022-12-31T23:59:59
items:
$ref: "#/components/schemas/AvailablePeriodsRequest"
description: Available slots
example:
MONDAY:
- start: 2022-12-31T00:00:00
end: 2022-12-31T23:59:59
description: Available times
DoctorRequest:
type: object
properties:
crm:
type: string
description: CRM
example: "123456"
document:
type: string
description: CPF
example: "28685216907"
specialty:
type: string
description: Specialty
example: Cardiologist
name:
type: string
description: Name
example: John Doe
email:
type: string
description: Email
example: [email protected]
phoneNumber:
type: string
description: Phone number
example: "+5511999999999"
serviceZipCode:
type: string
description: Service ZIP code
example: "12345678"
serviceAddress:
type: string
description: Service address
example: "123, Main St."
availableTimes:
$ref: "#/components/schemas/AvailableTimesRequest"
appointmentPrice:
type: number
description: Appointment price
example: 100.0
AvailablePeriods:
required:
- end
- start
type: object
properties:
start:
type: string
format: date-time
end:
type: string
format: date-time
AvailableTimes:
required:
- slots
type: object
properties:
slots:
type: object
additionalProperties:
type: array
items:
$ref: "#/components/schemas/AvailablePeriods"
Doctor:
required:
- appointmentPrice
- availableTimes
- crm
- document
- email
- name
- phoneNumber
- serviceAddress
- serviceZipCode
- specialty
type: object
properties:
crm:
type: string
document:
type: string
specialty:
type: string
name:
type: string
email:
type: string
phoneNumber:
type: string
serviceZipCode:
type: string
serviceAddress:
type: string
availableTimes:
$ref: "#/components/schemas/AvailableTimes"
appointmentPrice:
type: number
MedicalRecordContentRequest:
type: object
properties:
content:
type: string
description: Medical record content
example: Patient has a fever
MedicalAppointment:
required:
- doctor
- estimatedTimeSpentInMinutes
- expectedStartTime
- patient
- status
type: object
properties:
number:
type: integer
format: int64
doctor:
$ref: "#/components/schemas/Doctor"
patient:
$ref: "#/components/schemas/Patient"
expectedStartTime:
type: string
format: date-time
estimatedTimeSpentInMinutes:
type: integer
format: int32
status:
type: string
enum:
- SCHEDULED
- CANCELED
- ACCEPTED
- REJECTED
- FINISHED
statusChangedAt:
type: string
format: date-time
justificationCancellationByPatient:
type: string
TimeAndDateToScheduleRequest:
type: object
properties:
scheduleAt:
type: string
description: scheduleAt
format: date-time
JustificationCancellationRequest:
type: object
properties:
text:
type: string
description: Justification text
example: I'm not feeling well
securitySchemes:
Bearer Authentication:
type: http
scheme: bearer
bearerFormat: JWT