forked from pdestefano/developer_portal_openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dynameddecisions.json
726 lines (708 loc) · 26 KB
/
dynameddecisions.json
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
{
"openapi": "3.0.0",
"info": {
"title": "MedsAPI DynaMed Decisions",
"version": "1.0",
"contact": {
"name": "EBSCO Information Services",
"url": "https://connect.ebsco.com/"
},
"description": "MedsAPI DynaMed Decisions provides endpoints to get a robust collection of shared decision-making aids that enable patients and providers to have meaningful and informed conversations that lead to improved outcomes and higher patient satisfaction. The documentation on this site covers all supported functionality of the MedsAPI suite of APIs. Any fields or parameters not represented by the documentation are unsupported and subject to change. Additional optional query parameters and fields in the response could be added in the future as a non breaking change. Any other change that could break the contract would be considered in a future version."
},
"tags": [
{
"name": "Authorization",
"description": "MedsAPI Token API"
},
{
"name": "Tools",
"description": "MedsAPI DynaMed Tool Endpoints"
}
],
"servers": [
{
"url": "https://apis.ebsco.com/medsapi-dynamed-decisions/v1",
"description": "Apigee Live Server"
}
],
"paths": {
"/token": {
"servers": [
{
"url": "https://apis.ebsco.com/medsapi-auth/v1",
"description": "MedsAPI token endpoint"
}
],
"post": {
"summary": "Get an authorization token",
"tags": [
"Authorization"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"refresh_token_expires_in": {
"type": "string",
"example": "0",
"description": "The number of seconds remaining before the refresh token will expire. The lifespan of refresh tokens is usually larger than Access tokens. The exact duration depends on the type of Refresh Tokens issued. The different types explained below in the document."
},
"product": {
"type": "string",
"example": "dynamed-decisions",
"description": "The type of token issued"
},
"organization_name": {
"type": "string",
"example": "ebscois",
"description": "The issuer of the token"
},
"developer.email": {
"type": "string",
"example": "msmith@mycompany.com",
"description": "Name of the owener of the token"
},
"token_type": {
"type": "string",
"example": "BearerToken",
"description": "Always set to be a bearer token"
},
"issued_at": {
"type": "string",
"example": "1593011837412",
"description": "Epoch time when the token was issued"
},
"client_id": {
"type": "string",
"example": "{client_id}",
"description": "Client Id that the token can be used by"
},
"access_token": {
"type": "string",
"example": "{actual bearer token to use}",
"description": "Bearer token"
},
"application_name": {
"type": "string",
"example": "{id}",
"description": "Id of the application that is registered for this token"
},
"scope": {
"type": "string",
"example": "admin:rw",
"description": "Authorization scope"
},
"expires_in": {
"type": "string",
"example": "14399",
"description": "Seconds until this token has expired"
},
"refresh_count": {
"type": "string",
"example": "0",
"description": "When this token can be refreshed automatically"
},
"status": {
"type": "string",
"example": "approved",
"description": "Indicates that the token has been approved"
}
},
"required": [
"refresh_token_expires_in",
"product",
"organization_name",
"developer.email",
"token_type",
"issued_at",
"client_id",
"access_token",
"application_name",
"scope",
"expires_in",
"refresh_count",
"status"
]
}
}
}
},
"401": {
"description": "Unauthorized - This request requires authentication and none was provided."
},
"403": {
"description": "Forbidden - The authentication credentials do not have access to this resource."
},
"404": {
"description": "Not Found - The server was unable to find a resource matching this request."
},
"405": {
"description": "Method Not Allowed - The server has not implemented the requested HTTP method."
},
"406": {
"description": "Not Acceptable - The server cannot return the requested media type."
},
"415": {
"description": "Unsupported Media Type - The server cannot understand the media type in this request."
},
"429": {
"description": "Too Many Requests - The client has sent too many requests within the given time."
},
"500": {
"description": "Internal Server Error - There was an unexpected error with the server",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error-Response"
}
}
}
}
},
"operationId": "post-token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"example": "client_credentials",
"description": "Must be set to client_credentials"
},
"product": {
"type": "string",
"example": "dynamed-decisions",
"description": "Must be set to dynamed-decisions"
},
"client_id": {
"type": "string",
"example": "{client_id}",
"description": "The client_id to use will be provided by EBSCO"
},
"client_secret": {
"type": "string",
"example": "{client secret}",
"description": "This will be provided by EBSCO"
}
}
},
"examples": {
"Example Body": {
"value": {
"grant_type": "client_credentials",
"product": "dynamed-decisions",
"client_id": "{client id}",
"client_secret": "{client secret}"
}
}
}
},
"application/javascript": {
"schema": {
"type": "object",
"properties": {
}
}
},
"text/plain": {
"schema": {
"type": "object",
"properties": {
}
}
}
},
"description": "{\n \"grant_type\": \"client_credentials\",\n \"product\": \"dynamed-decisions\",\n \"client_id\": \"client_id\",\n \"client_secret\": \"client secret\"\n}\n"
},
"parameters": [
{
"schema": {
"type": "string",
"example": "application/json"
},
"in": "header",
"name": "Content-Type",
"description": ""
}
],
"description": "The authentication endpoint for getting a token, used in all other DynaMed Decisions APIs."
}
},
"/content/tools": {
"get": {
"summary": "Get all available tools",
"description": "Additional Documentation [/content/tools](https://developer.ebsco.com/medical-point-care-apis/dynamed-decisions/docs) ",
"parameters": [
{
"name": "page",
"in": "query",
"description": "A number representing the page of the response. A page will consist of an array of items.",
"required": false,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items per page of the response.",
"required": false,
"schema": {
"type": "string",
"example": "10"
}
}
],
"tags": [
"Tools"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tools"
}
}
}
},
"401": {
"description": "Unauthorized - This request requires authentication and none\nwas provided.",
"content": {
}
},
"403": {
"description": "Forbidden - The authentication credentials do not have access\nto this resource.",
"content": {
}
},
"404": {
"description": "Not Found - The server was unable to find a resource matching\nthis request.",
"content": {
}
},
"405": {
"description": "Method Not Allowed - The server has not implemented the requested\nHTTP method.",
"content": {
}
},
"406": {
"description": "Not Acceptable - The server cannot return the requested media\ntype.",
"content": {
}
},
"415": {
"description": "Unsupported Media Type - The server cannot understand the media\ntype in this request.",
"content": {
}
},
"429": {
"description": "Too Many Requests - The client has sent too many requests within\nthe given time.",
"content": {
}
},
"500": {
"description": "Internal Server Error - There was an unexpected error with\nthe server.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error-Response"
}
}
}
}
},
"security": [
{
"BearerToken": [
]
}
]
}
},
"/content/tools/{id}": {
"get": {
"summary": "Get Tool by Id",
"description": "Additional Documentation [/content/tools/{id}](https://developer.ebsco.com/medical-point-care-apis/dynamed-decisions/docs/get-tool-by-id) ",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Tool id. This is the unique identifier for a specific tool resource.",
"required": true,
"schema": {
"type": "string",
"example": "shared-decision-making_hip-osteoarthritis"
}
}
],
"tags": [
"Tools"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tool-response"
}
}
}
},
"401": {
"description": "Unauthorized - This request requires authentication and none\nwas provided.",
"content": {
}
},
"403": {
"description": "Forbidden - The authentication credentials do not have access\nto this resource.",
"content": {
}
},
"404": {
"description": "Not Found - The server was unable to find a resource matching\nthis request.",
"content": {
}
},
"405": {
"description": "Method Not Allowed - The server has not implemented the requested\nHTTP method.",
"content": {
}
},
"406": {
"description": "Not Acceptable - The server cannot return the requested media\ntype.",
"content": {
}
},
"415": {
"description": "Unsupported Media Type - The server cannot understand the media\ntype in this request.",
"content": {
}
},
"429": {
"description": "Too Many Requests - The client has sent too many requests within\nthe given time.",
"content": {
}
},
"500": {
"description": "Internal Server Error - There was an unexpected error with\nthe server.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error-Response"
}
}
}
}
},
"security": [
{
"BearerToken": [
]
}
]
}
}
},
"components": {
"schemas": {
"tools": {
"type": "object",
"properties": {
"_metadata": {
"properties": {
"totalItems": {
"type": "number",
"description": "Total count of tools in the collection regardless of pagination.",
"example": 2
},
"totalPages": {
"type": "number",
"description": "The total count of pages in the collection.",
"example": 1
},
"page": {
"type": "number",
"description": "A number representing the page of the response. A page will consist of an array of items.",
"example": 1
},
"pageSize": {
"type": "number",
"description": "The maximum number of items per page of the response.",
"example": 10
},
"links": {
"type": "array",
"description": "An array of Link Description Objects that can be used to navigate the content pages. Links may include self, previous, next, first and last as appropriate.",
"items": {
"type": "object",
"properties": {
"rel": {
"description": "Type of link",
"type": "string",
"example": "self"
},
"href": {
"description": "Hyperlink reference",
"type": "string",
"example": "https://apis.ebsco.com/medsapi-dynamed-decisions/v1/content/tools?page=1&pageSize=10"
}
}
}
}
},
"type": "object"
},
"items": {
"type": "array",
"description": "An array containing the current page of the result list.",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The unique identifier for this tool.",
"type": "string",
"example": "shared-decision-making_hip-osteoarthritis"
},
"title": {
"description": "The title of this tool.",
"type": "string",
"example": "Hip Osteoarthritis"
},
"slug": {
"description": "An SEO-friendly string designed as a URL suffix to uniquely identify this tool in a particular context.",
"type": "string",
"example": "/shared-decision-making/hip-osteoarthritis"
},
"description": {
"type": "string",
"description": "Tool Description - Information about this particular tool",
"example": "This tool is used to determine..."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"example": "self",
"description": "Relationship of the link to the tool"
},
"href": {
"type": "string",
"description": "Hyperlink reference",
"example": "https://apis.ebsco.com/medsapi-dynamed-decisions/v1/content/tools/shared-decision-making_hip-osteoarthritis"
}
}
}
}
}
}
}
}
},
"tool-response": {
"type": "object",
"properties": {
"id": {
"description": "The unique identifier for this tool.",
"type": "string",
"example": "shared-decision-making_hip-osteoarthritis"
},
"title": {
"description": "The title of this tool.",
"type": "string",
"example": "Hip Osteoarthritis"
},
"slug": {
"description": "An SEO-friendly string designed as a URL suffix to uniquely identify this tool in a particular context.",
"type": "string",
"example": "/shared-decision-making/hip-osteoarthritis"
},
"description": {
"type": "string",
"description": "Tool Description - Information about this particular tool.",
"example": "This tool is used to determine..."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"description": "Type of link",
"example": "self"
},
"href": {
"description": "Hyperlink reference",
"example": "https://apis.ebsco.com/medsapi-dynamed-decisions/v1/content/tools/shared-decision-making_hip-osteoarthritis"
}
}
}
},
"pubType": {
"type": "object",
"description": "The tool pubType.",
"properties": {
"id": {
"type": "string",
"example": "shared-decision-making"
}
}
},
"optionGrid": {
"$ref": "#/components/schemas/optionGrid"
}
}
},
"optionGrid": {
"type": "object",
"properties": {
"polarDecisionTool": {
"type": "boolean",
"description": "Single column presentation of a “polar decision”. True means the tool has 2 options. False means it has more than 2 options. Some polar decision aids have a single answer that crosses both options.<br/><br/>Multiple column presentation of the most common options for the healthcare decision presented in the decision aid (Ex: Self-Care vs. Exercise vs. Surgery)",
"example": "true"
},
"options": {
"$ref": "#/components/schemas/options"
},
"questions": {
"$ref": "#/components/schemas/questions"
},
"references": {
"type": "string",
"description": "List of references for resources used to create the content for the decision aid.",
"example": "<ol><li><p>Akman T, Binbay M, Tekinarslan E, Tepeler A, Akcay M, Ozgor F.</p></li></ol>"
},
"contributors": {
"type": "string",
"description": "List of editors responsible for the creation or review of the content for the decision aid.",
"example": "<h2><p>Clinical Review</p></h2><p>Kevin Loughlin, MD, MBA</p>"
},
"certifications": {
"type": "string",
"description": "Tool certification of a specific decision aid, when applicable.",
"example": "<p>This product has been certified by the Washington State Health Care Authority pursuant to RCW 7.70.060.</p>"
},
"competingInterests": {
"type": "string",
"description": "Declaration of no conflicts of interest for editorial staff and reviewers involved in creation of the decision aid.",
"example": "<p>The editors and reviewers on this EBSCO Health Option Grid decision aid have declared no conflicts of interest, as of Apr 2, 2019.</p>"
},
"definitions": {
"$ref": "#/components/schemas/definitions"
},
"supplementalInformation": {
"type": "string",
"description": "Additional background information for specific content within the decision aid, when applicable.",
"example": "<p><data base=\"name\">Enlarged Prostate (Benign Prostatic Hypertrophy) Treatment Options </data></p>"
}
}
},
"options": {
"type": "array",
"description": "Most common treatment or decision options for the healthcare decision presented in the decision aid.",
"items": {
"type": "object",
"properties": {
"optionKey": {
"type": "string",
"description": "Unique key to represent medicine or remedy option.",
"example": "warfarin"
},
"name": {
"type": "string",
"description": "Represents the name of medicine or remedy.",
"example": "Warfarin"
}
}
}
},
"questions": {
"type": "array",
"description": "Most frequently asked questions for the healthcare decision presented in the decision aid.",
"items": {
"type": "object",
"properties": {
"answers": {
"type": "array",
"description": "Answers for questions related to available options for a disease/treatments.",
"items": {
"type": "object",
"properties": {
"optionKey": {
"type": "string",
"description": "Unique key to represent answer for disease/treatment.",
"example": "notreatment"
},
"answer": {
"type": "string",
"description": "Answer for question for particular disease/treatments.",
"example": "<p>You will have no tests or treatments now. Ask for advice if you notice new symptoms.</p>"
}
}
}
},
"question": {
"type": "string",
"description": "Question related to available options for a disease/treatments.",
"example": "What does the option involve?"
}
}
}
},
"definitions": {
"type": "array",
"description": "Definitions and additional explanation of complex terms used within the decision aid",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of medicine.",
"example": "<p>BPH</p>"
},
"text": {
"type": "string",
"description": "Description/Definition of medicine.",
"example": "<p>BPH is another name for benign prostatic hypertrophy.</p>"
}
}
}
},
"Error-Response": {
"title": "Error-Response",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Standardized reason phrase for this status code",
"example": "Error Name"
},
"message": {
"type": "string",
"description": "Details about the error",
"example": "Error Description"
}
}
}
},
"securitySchemes": {
"BearerToken": {
"type": "http",
"scheme": "bearer"
}
}
}
}