forked from pdestefano/developer_portal_openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dynamichealth.json
3129 lines (3111 loc) · 121 KB
/
dynamichealth.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
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.0",
"info": {
"title": "Dynamic Health",
"version": "1.0",
"contact": {
"name": "EBSCO Information Services",
"url": "https://connect.ebsco.com/"
},
"description": "MedsAPI Dynamic Health Endpoints. 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": "Dynamic Health Token API"
},
{
"name": "Search",
"description": "Dynamic Health Search Endpoints"
},
{
"name": "Articles",
"description": "Dynamic Health Articles Endpoints"
},
{
"name": "Categories",
"description": "Dynamic Health Categories Endpoints"
},
{
"name": "Custom Articles",
"description": "Dynamic Health Custom Articles Endpoints"
},
{
"name": "Article Notes",
"description": "Dynamic Health Article Notes Endpoints"
},
{
"name": "Article Exclusions",
"description": "Dynamic Health Article Exclusions Endpoints"
},
{
"name": "Personalization",
"description": "Dynamic Health Personalization Endpoints"
}
],
"servers": [
{
"url": "https://apis.ebsco.com/medsapi-dynamic-health/v1"
}
],
"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": "dynamic-health",
"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": "dynamic-health",
"description": "Must be set to dynamic-health"
},
"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": "dynamic-health",
"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\": \"dynamic-health\",\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 Dynamic Health APIs."
}
},
"/content/search": {
"post": {
"tags": [
"Search"
],
"summary": "Search for DH content and information using POST.",
"description": "Additional Documentation [/content/search](https://developer.ebsco.com/medical-point-care-apis/dynamic-health/docs) ",
"operationId": "post-search-v1",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "Maximum number of results to return per page. Defaults to the highest value allowed: 30. Set pageSize to 0 to retrieve a response without an items array.",
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "page",
"in": "query",
"description": "Page of results to return. Not needed on the first call.",
"schema": {
"type": "integer"
}
},
{
"name": "pageToken",
"in": "query",
"description": "A string token used by the search engine to retrieve the next set of results. Must be supplied if page parameter is supplied. Returned in the response of the first page of results.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Search Request Specification",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "A term or terms to search.",
"example": "heart"
},
"sort": {
"type": "string",
"description": "Order in which results will appear.",
"example": "relevancy",
"default": "relevancy",
"enum": [
"relevancy",
"title",
"categoryPath"
]
},
"filters": {
"type": "object",
"description": "List of types that will be used for searching and aggregations.",
"properties": {
"populations": {
"minItems": 1,
"uniqueItems": true,
"type": "array",
"description": "One or more populations to include in the results.",
"items": {
"type": "string",
"description": "Example: Adult or all or Pediatric",
"example": "pediatric",
"enum": [
"adults",
"pediatric",
"all"
]
}
},
"categoryPaths": {
"minItems": 1,
"uniqueItems": true,
"type": "array",
"description": "One or more categories to include in the results.",
"items": {
"type": "string",
"description": "Example: Skills",
"example": "Skills|Nursing Skills|Specialties|Emergency and Trauma"
}
},
"specialties": {
"minItems": 1,
"type": "array",
"description": "One or more specialties to include in the results.",
"items": {
"type": "string",
"description": "Example: Psychiatry",
"example": "Emergency & Trauma Medicine"
}
},
"genders": {
"type": "array",
"items": {
"type": "string",
"example": "All"
}
},
"pubTypeIds": {
"type": "array",
"items": {
"type": "string",
"example": "nursingskills"
}
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string",
"example": "videos",
"enum": [
"images",
"videos"
]
}
}
}
},
"aggregations": {
"type": "array",
"description": "One or more fields to aggregate counts in the response.",
"items": {
"type": "string",
"example": "specialties",
"enum": [
"cdh",
"media",
"specialties",
"population",
"gender"
]
}
},
"fields": {
"type": "array",
"description": "Fields that should be included in the response.",
"items": {
"type": "string",
"example": "title",
"enum": [
"title",
"pubType",
"description",
"hitSummary",
"images",
"videos",
"toc",
"gender",
"population",
"specialties"
]
}
},
"imageSizes": {
"type": "array",
"description": "Size(s) of images to return in the image link(s). (small, medium, large, full)",
"items": {
"type": "string",
"example": "small"
}
},
"posterSizes": {
"type": "array",
"description": "Size(s) of the poster link representing the video. (small, medium, large, full)",
"items": {
"type": "string",
"example": "small"
}
},
"secure": {
"type": "boolean",
"description": "Return secure (https) URLs for media links",
"default": true
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_metadata": {
"type": "object",
"required": [
"pageToken",
"pageSize",
"page",
"totalPages",
"totalItems",
"request",
"links",
"aggregations"
],
"properties": {
"pageToken": {
"type": "string",
"example": "id:rsid:8088d9c0-ffc9-4ce5-a770-e6c1fd3107b4"
},
"pageSize": {
"type": "number",
"example": 30
},
"page": {
"type": "number",
"example": 1
},
"totalPages": {
"type": "number",
"example": 1
},
"totalItems": {
"type": "number",
"example": 5
},
"request": {
"type": "object",
"required": [
"query",
"sort",
"aggregations",
"filters",
"fields"
],
"properties": {
"query": {
"type": "string",
"example": "heart"
},
"sort": {
"type": "string",
"example": "relevancy"
},
"aggregations": {
"type": "array",
"example": [
"specialties"
],
"items": {
"type": "string"
}
},
"filters": {
"type": "object",
"required": [
"categoryPaths",
"populations",
"specialties",
"genders",
"pubTypeIds",
"mediaTypes"
],
"properties": {
"categoryPaths": {
"type": "array",
"example": [
"Skills|Nursing Skills|Specialties|Emergency and Trauma"
],
"items": {
"type": "string"
}
},
"populations": {
"type": "array",
"example": [
"Pediatric"
],
"items": {
"type": "string"
}
},
"specialties": {
"type": "array",
"example": [
"Emergency & Trauma Medicine"
],
"items": {
"type": "string"
}
},
"genders": {
"type": "array",
"example": [
"All"
],
"items": {
"type": "string"
}
},
"pubTypeIds": {
"type": "array",
"example": [
"nursingskills"
],
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"example": [
"videos"
],
"items": {
"type": "string"
}
}
}
},
"fields": {
"type": "array",
"example": [
"title"
],
"items": {
"type": "string"
}
}
}
},
"searchSegments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "tylenol",
"description": "The term(s) that were searched. This could be multiple terms if they were used together in the search."
},
"synonyms": {
"type": "string",
"example": "acetaminophen",
"description": "Synonym for the term."
}
},
"required": [
"token"
]
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"example": "self"
},
"href": {
"type": "string",
"example": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/search?page=1&pageToken=id:rsid:8088d9c0-ffc9-4ce5-a770-e6c1fd3107b4"
},
"method": {
"type": "string",
"example": "post"
}
}
}
},
"aggregations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "specialties"
},
"counts": {
"type": "object",
"properties": {
"Emergency & Trauma Medicine": {
"type": "number",
"example": 5
},
"Gastroenterology": {
"type": "number",
"example": 1
},
"Otolaryngology": {
"type": "number",
"example": 1
}
},
"required": [
"Emergency & Trauma Medicine",
"Gastroenterology",
"Otolaryngology"
]
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "T919787"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"example": "self"
},
"href": {
"type": "string",
"example": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/T919787"
}
}
}
},
"title": {
"type": "string",
"example": "Automated External Defibrillation in a Pediatric Patient"
},
"pubType": {
"type": "object",
"description": "Topic type.",
"properties": {
"id": {
"type": "string",
"description": "Publication type id.",
"example": "skills"
},
"title": {
"pattern": "Nursing Skills",
"type": "string",
"description": "Displayable publication type."
}
}
},
"description": {
"type": "string",
"description": "Summary of the topic.",
"example": "Assisting in restoring or maintaining cerebrospinal\nfluid flow"
},
"hitSummary": {
"type": "object",
"description": "Indicates whether an exact match to the query\nwas used in the aggregation count foe this item.",
"properties": {
"titleExactMatch": {
"type": "boolean",
"description": "Indicates if the query term matched exactly\nto the topic title.",
"example": true
}
}
},
"gender": {
"type": "string",
"description": "Relevent gender for the article.",
"example": "all",
"enum": [
"all",
"male",
"female"
]
},
"specialties": {
"type": "array",
"description": "List of specialties related to the article.",
"items": {
"type": "string",
"example": "Urology"
}
},
"populations": {
"type": "array",
"description": "Population that this article is relevant to.",
"items": {
"type": "string",
"example": "Pediatric"
}
},
"toc": {
"type": "array",
"description": "Table of Contents",
"items": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"description": "Anchor location in this document.",
"example": "POST_PROCEDURE_STEPS"
},
"title": {
"type": "string",
"description": "Name of the section.",
"example": "Post-Procedure Steps"
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anchor": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
}
}
},
"images": {
"type": "array",
"description": "List of any images in the topic.",
"items": {
"type": "object",
"properties": {
"copyright": {
"type": "string",
"description": "Copyright and date of the image.",
"example": "Copyright© Madhero88, 2011. Licensed under\nCreative Commons Attribution-Share Alike 3.0 Unported\nLicense"
},
"title": {
"type": "string",
"description": "Caption of the image.",
"example": "Heel Sticks On a Newborn Or Infant."
},
"links": {
"minItems": 1,
"type": "array",
"description": "Link to the image(s).",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"description": "External link type.",
"example": "external"
},
"href": {
"type": "string",
"description": "Expiring link to the resource.",
"example": "http://media.ebsco.healthcare/eis-live/image/authenticated/f_auto/v1/EBSCOHealth/CCMS/I509101?__cld_token__=exp=1590236397~hmac=cb9fa19867467"
}
}
}
},
"imageSize": {
"type": "string",
"description": "Size of the image returned",
"example": "large"
}
}
}
},
"videos": {
"type": "array",
"description": "List of any videos in the topic.",
"items": {
"type": "object",
"properties": {
"copyright": {
"type": "string",
"description": "Copyright and date of the video.",
"example": "Copyright© Madhero88, 2011. Licensed under\nCreative Commons Attribution-Share Alike 3.0 Unported\nLicense"
},
"title": {
"type": "string",
"description": "Caption of the video.",
"example": "Performing a Heelstick in an Infant."
},
"links": {
"minItems": 1,
"type": "array",
"description": "Link to the video(s)",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"description": "External link type.",
"example": "external"
},
"href": {
"type": "string",
"description": "Expiring link to the resource.",
"example": "https://media.ebsco.healthcare/eis-live/image/authenticated/f_auto/v1/EBSCOHealth/ICMSVI589121.mp4?__cld_token__=exp=1590236397~hmac=cb9faf1f91881"
},
"posterSize": {
"type": "string",
"description": "Size o fthe poster returned",
"example": "small"
},
"type": {
"type": "string",
"example": "poster",
"description": "Type of link returned"
}
}
}
}
}
}
}
}
}
}
},
"required": [
"_metadata",
"items"
]
}
}
}
},
"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"
}
}
}
}
},
"security": [
{
"BearerToken": [
]
}
],
"x-codegen-request-body-name": "body"
}
},
"/content/search/suggestions": {
"get": {
"tags": [
"Search"
],
"summary": "Get a list of search suggestions, either word completions (term) or article completions (title), based on the users access.",
"operationId": "get-search-suggestions",
"description": "Additional Documentation [/content/search/suggestions](https://developer.ebsco.com/medical-point-care-apis/dynamic-health/docs/search-suggestions) ",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "query",
"description": "Word or phrase to search for an article title or a term against. Can be a single character or partial term.",
"required": true
},
{
"schema": {
"type": "number"
},
"in": "query",
"name": "maxItemsPerSuggestionType",
"description": "The maximum number of search suggestions to return for each suggestion type (term or article title)",
"required": false
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/search-suggestions-title-response"
}
}
}
},
"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": {