Media Responses
Media within Responses
Access to Multimedia Assets
Responses may include references to multimedia assets within the multimedia section of the response payload. These may include images, videos and or algorithms.
Each Multimedia Entry Can Include the Following Metadata
- Title – The name or caption associated with the media asset.
- Copyright – Copyright attribution information.
- Media URL Links – A link to the associated image, algorithm or video asset.
- Additional possible fields:
- description - When available, will describe the media
- format - Indicates the media file type
- publicId - The storage location (most applications will not need this)
- alt - Alternative text to display if the image can't be rendered
- telemetryData - Used for monitoring usage
Media URL Behavior
- The media URL provides access to a full-resolution image, algorithm or video.
- The URL is temporary and valid for 24 hours from the time the article response is generated.
- Clients must not cache the URL.
Access and Refresh
- If access to the media asset is required after the 24-hour validity period, the client must re-request the response through the API to obtain a new media URL.
- No additional authentication is required to retrieve the media asset once the URL has been issued.
Specifying Image and Video Sizes
Links to images, algorithms and videos of varying sizes may be returned in the article response. To specify the image or algorithm size, add one or more imageSize parameters or for videos, add the posterSize parameter(s) to the call. small (thumbnail size), medium (500w), large (1000w) and full image sizes are supported. Image links are returned in full size by default and are optimized for the browser making the request. The video links are always returned in full size and cannot be resized. A thumbnail of the video will display a still image of a frame from the video. To get the thumbnail for the video, be sure to add the posterSize and set it to small (other sizes are also available).
Many algorithm responses may come back in an svg format. If this is not desired, you may set the convertSvg flag to true. This will instead return a link to a png file format. Note that svg files can only be returned in "full" size. If you specify a differnt size, then the file will be returned as a png image link.
| Parameter Name | Description | Sizes Available |
|---|---|---|
| imageSize | Returns the requested size. | small, medium, large, full |
| posterSize | Returns the requested thumbnail of the video | small, medium, large, full |
| convertSvg | Return images and algorithms that are originally in svg format as png format. | default is to return svg |
Sample Search Media Response
Sample JSON is listed below showing a generalized image, video and algorithm media response. An imageSize of large and posterSize of small was requested. Note that imageSize applies to images and algorithms. Dyna responses will be similar.
"items": [
{
"id": "I1604413732495",
"contentLocations": {
"parent": [
{
"title": "Atrioventricular (AV) Canal Defect",
"pubtype": "condition",
"slug": "/condition/atrioventricular-av-canal-defect"
}
],
"anchor": "I1604413732495"
},
"title": "Anatomy of atrioventricular septation complex in human 4-chambered heart with normal anatomy and in hearts with AVSDs",
"pubType": {
"id": "image"
},
"exactMatch": false,
"mediaType": "image",
"format": "png",
"copyright": "Burns T, Yang Y, Hiriart E, Wessels A. The Dorsal Mesenchymal Protrusion and the Pathogenesis of Atrioventricular Septal Defects. J Cardiovasc Dev Dis 2016;3(4):29. Reproduced with permission from BioMed Central.",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/Dynamed/images/I1604413732495.png?__cld_token__=exp=1785253222~hmac=1a785eb5f847fa7f341678e66362954a91e6d655462f18b3abf74bf4d6712891&_a=BAMAPqiu0",
"imageSize": "large"
}
]
},
{
"id": "V1730731408115",
"contentLocations": {
"parent": [
{
"title": "Computed Tomography (CT) of the Thorax",
"pubtype": "evaluation",
"slug": "/evaluation/computed-tomography-ct-of-the-thorax"
},
{
"title": "Computed Tomography (CT) of the Thorax",
"pubtype": "evaluation",
"slug": "/evaluation/computed-tomography-ct-of-the-thorax"
}
],
"anchor": "V1730731408115"
},
"title": "Cardiac structures and vasculature",
"pubType": {
"id": "video"
},
"exactMatch": false,
"mediaType": "video",
"format": "mp4",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/v1/EBSCOHealth/CCMS/Dynamed/videos/V1730731408115.mp4?__cld_token__=exp=1785253680~hmac=e8c07246e190edf392ba7f484211addc926adc8bb66c09093eac0bcc1bb5e961&_a=BAMAPqiu0"
},
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/t_media_lib_thumb/f_jpg/v1/EBSCOHealth/CCMS/Dynamed/videos/V1730731408115.jpg?__cld_token__=exp=1785253680~hmac=f316a3a154a44131182240ad46fa6d59d0644f5f0ff85b083d0023445b602020&_a=BAMAPqiu0",
"posterSize": "small",
"type": "poster"
}
]
},
{
"id": "A1720633859289",
"contentLocations": {
"parent": [
{
"title": "Coronary Artery Disease (CAD) in Female Adults",
"pubtype": "condition",
"slug": "/condition/coronary-artery-disease-cad-in-female-adults-3"
},
{
"title": "Coronary Artery Disease (CAD) in Female Adults",
"pubtype": "condition",
"slug": "/condition/coronary-artery-disease-cad-in-female-adults-3"
}
],
"anchor": "A1720633859289"
},
"title": "Diagnostic testing in symptomatic female persons with suspected stable ischemic heart disease algorithm",
"pubType": {
"id": "algorithm"
},
"exactMatch": false,
"mediaType": "algorithm",
"format": "svg",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/Dynamed/images/A1720633859289.png?__cld_token__=exp=1785253736~hmac=6f762181d5bf950790357733de4bf145a87763609412e948f915b30b834e258c&_a=BAMAPqiu0",
"imageSize": "large"
}
]
}
Sample Article Media Response
Articles with media vary a bit from search. Media are located within the ancillary section and may include content locations. This particular response shows the size when imageSize was set to small and large (?imageSize=small&imageSize=large). Algorithm and videos will follow a similar pattern. As noted above, be sure to specify a posterSize to get a still image of the video.
"multimedia": [
{
"mediaType": "image",
"content": [
{
"id": "i1604413975703",
"title": "Complete AV canal defect",
"format": "jpg",
"copyright": "Image courtesy of Centers for Disease Control and Prevention.",
"mediaProvider": "Centers for Disease Control and Prevention",
"mediaHost": "Cloudinary",
"description": "Coronal illustration of heart showing ostium primum defect of atrial septum and ventricular septal defect. Abbreviation: AV, atrioventricular.",
"publicId": "EBSCOHealth/CCMS/Dynamed/images/I1604413975703",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_media_lib_thumb/v1/EBSCOHealth/CCMS/Dynamed/images/I1604413975703.jpg?__cld_token__=exp=1784821000~hmac=394cfc88c66ed350a9277e86cd436280d4d7c9e78a16e1ea5f85f017467921bd&_a=BAMAPqiu0",
"imageSize": "small"
},
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/Dynamed/images/I1604413975703.jpg?__cld_token__=exp=1784821000~hmac=4bae7a88b83e4ba6abc9f14b66334eec72fc1af21dcbbcad3dd79ecbe2998cfd&_a=BAMAPqiu0",
"imageSize": "large"
}
],
"contentLocations": [
{
"rel": "external",
"href": "https://ebscois-development-devqa.apigee.net/medsapi-dynamed/v2/content/articles/t921888"
},
{
"rel": "external",
"href": "https://ebscois-development-devqa.apigee.net/medsapi-dynamed/v2/content/articles/an:dmx:t921888"
}
]
}
}
}
Sample Dyna Media Response
The response below shows the size when imageSize was set to large and posterSize was set to small(?imageSize=large&posterSize=small). Algorithm will follow a similar pattern as images. As noted above, be sure to specify a posterSize to get a still image of the video.
"media": {
"videos": {
"title": "Videos:",
"results": [
{
"id": "V1671561189571",
"publicId": "EBSCOHealth/CCMS/Dynamed/videos/V1671561189571",
"title": "Gait in a patient with Charcot-Marie-Tooth disease",
"description": "Patient walks slowly with high stepping gait. Unable to stand on toes. Four years later gait is worse with much more obvious stepping gait. Pes cavus with high arch and clawed toes is visible. ",
"pubType": "video",
"copyright": "©Oxford University Press 2015. Caption may have been modified from original source.",
"format": "mp4",
"alt": "Patient walks slowly with high stepping gait. Unable to stand on toes. Four years later gait is worse with much more obvious stepping gait. Pes cavus with high arch and clawed toes is visible. ",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/v1/EBSCOHealth/CCMS/Dynamed/videos/V1671561189571.mp4?__cld_token__=exp=1794061122~hmac=931e46e246371b17a5ca1baaef921611cbbdb593faf01c21b50f03e696947f02&_a=BAMAROkS0",
"size": "full"
},
{
"rel": "poster",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/f_jpg/t_media_lib_thumb/v1/EBSCOHealth/CCMS/Dynamed/videos/V1671561189571.jpg?__cld_token__=exp=1794061122~hmac=49bf458d9deb71ef8e4b8d07c9e42f033ec33385183d64375fcd0b756a8ca6a6&_a=BAMAROkS0",
"size": "small"
}
],
"telemetryData": {
"id": "V1671561189571",
"title": "Gait in a patient with Charcot-Marie-Tooth disease",
"format": "mp4"
}
},
"images": {
"title": "Images:",
"results": [
{
"id": "I504049",
"publicId": "EBSCOHealth/CCMS/Dynamed/images/I504049",
"title": "Foley catheter diagram",
"description": "Side-view diagram of male urinary tract with Foley catheter in place to drain urine. A label points to the Foley catheter, which consists of two tubes for fluids flowing in and out of the bladder. A label explains that a balloon near the tip of the catheter holds the catheter in place. A label pointing to a tube entering the urethra at the tip of the penis explains that the tube allows water to flow into the bladder from a hanging bottle. An arrow shows the direction of the water flowing out of the catheter. A label pointing to a tube emerging out of the urethra explains that fluids drain into a sterile bag. An arrow shows the direction of flow toward the sterile bag. ",
"pubType": "image",
"copyright": "Copyright National Institute of Diabetes and Digestive and Kidney Diseases.",
"format": "jpg",
"alt": "Side-view diagram of male urinary tract with Foley catheter in place to drain urine. A label points to the Foley catheter, which consists of two tubes for fluids flowing in and out of the bladder. A label explains that a balloon near the tip of the catheter holds the catheter in place. A label pointing to a tube entering the urethra at the tip of the penis explains that the tube allows water to flow into the bladder from a hanging bottle. An arrow shows the direction of the water flowing out of the catheter. A label pointing to a tube emerging out of the urethra explains that fluids drain into a sterile bag. An arrow shows the direction of flow toward the sterile bag. ",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/Dynamed/images/I504049.jpg?__cld_token__=exp=1794062150~hmac=e5efee0f242227939297439e4b0de26ff13bde5a66f2ab4b0fe941921c097f6a&_a=BAMAROkS0",
"size": "large"
}
],
"telemetryData": {
"id": "I504049",
"title": "Foley catheter diagram",
"format": "jpg"
}
}
]
}
]
}
}Updated 4 months ago
