Consumer Health

 

Browse our guides and interact with our API reference for more information about MEDSAPI Consumer Health. Try MEDSAPI Consumer Health and learn about core concepts.

 

 

 

 

Get an Article

The Consumer Health API GET an article by article ID endpoint returns an article by an article ID.  Before you can execute an article call, you must have an 'Authorization' token which is to be entered into the request header. 

To Perform an Article Request (example):

Gather the following information for the request:

  • An access token. Please see Use the Client Credentials Grant for further information.
  • The ID of the requested article. This will be the t-number or a chunkId.

Request

GET https://apis.ebsco.com/medsapi-consumer-health/v1/content/articles/{id}

Response - Common Shape

The common shape response is used for all articles.  All article responses will first contain an id, title, and links field.     

{
  "id": "t1643452634964",
  "title": "How COVID-19 Affects the Body",
  "links": [
    {
      "rel": "self",
      "href": "https://apis.ebsco.com/content/articles/t1643452634964"
    }
  ],
  "metadata": {
    "DC.Type": "topic",
    "DC.Title": "Valproic Acid",
    "DC.Format": "XHTML",
    "copyright": "(C) Copyright 2022",
    "DC.Creator": "by Julia M. Smith, MA",
    "DC.Coverage": "/tnp/pg000419,26 11000004 12000004 13000004 14000004,Trade Names : Depakene",
    "DC.Language": "en",
    "DC.Identifier": "GUID-8F887103-7A62-4FA3-9AE4-BBD23310BE87",
    "DC.Date.Revised": "2015-12-01",
    "DC.rights.owner": "(C) Copyright 2022",
    "DC.Subject": "Entrees, Vegetarian",
    "keywords": "Entrees, Vegetarian",
    "author": "Calvagna M",
    "editor": "Woods M",
    "publisherPlace": "Ipswich, Massachusetts",
    "ageGroup": "Adult",
    "gender": "Female",
    "chunkId": "21170",
    "category": "Allergies",
    "alternateTitle": [
      "Multiple Sclerosis & Relationships"
    ],
    "subject": [
      "Multiple Sclerosis--Psychosocial Factors"
    ],
    "subject.minor": "Aged, 80 and Ove",
    "specificInterest": "Consumer Health",
    "medicalCodes.ICD-10-CM": "G35|Multiple sclerosis",
    "medicalCodes.ICD-10-PCS": 102,
    "medicalCodes.ICD-9-CM-D": "340|Multiple sclerosis",
    "medicalCodes.ICD-9-CM-P": [
      "639"
    ],
    "medicalCodes.NDC": [
      "13533060320|Antithrombin III, Human 50 UNT/ML Injectable Solution"
    ],
    "medicalCodes.RxNorm": [
      "1009|Antithrombin III"
    ],
    "medicalCodes.SNOMED": "15770003|Acute cholestatic jaundice syndrome",
    "medicalCodes.LOINC": [
      "59205-5|Gamma tocopherol Ser/Plas SCnc Pt Qn"
    ],
    "title": "Relationships & MS",
    "pubDate": "2017 Jan 6",
    "created": "20110429",
    "revised": "20171013"
  },
  "toc": [
    {
      "title": "Transcript",
      "anchor": "GUID-32B26DF2-8350-47A8-ADC2-4D632CD2EFF8__GUID-CECEED28-B5AC-47CE-9BC1-3A40D19C128E"
    }
  ],
  "sections": [
    {
      "anchor": "GUID-32B26DF2-8350-47A8-ADC2-4D632CD2EFF8",
      "title": "How COVID-19 Affects the Body",
      "content": "<div class=\"body\"> <div class=\"p standard\"> <div class=\"fig fignone\"><span class=\"figcap\">How_COVID-19_Affects_the_Body.mp4. </span><span class=\"desc figdesc\"> <p class=\"p\"></p>\n </span>   <p class=\"p copyright\"></p>\n <p class=\"p mediaProvider\"></p>\n <img class=\"image\" id=\"GUID-32B26DF2-8350-47A8-ADC2-4D632CD2EFF8__d7e50\" src=\"https://media.ebsco.healthcare/video/authenticated/s--BuYijKRX--/EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E43111A1099.mp4\"> <object id=\"d7e53\"> <param name=\"mediaHost\" value=\"Cloudinary\"> <param name=\"mediaType\" value=\"video\"> <param name=\"format\" value=\"mp4\"> <param name=\"public_id\" value=\"EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E43111A1099\"></object> <span class=\"data data\"> <span class=\"data\" property=\"VideoID\">V71100E43111A1099</span> <span class=\"data\" property=\"Filename\">How_COVID-19_Affects_the_Body.mp4</span> <span class=\"data\" property=\"GetVideoLoc\">http://services.epnet.com/getvideo.aspx?videoid=71100E43111A1099</span> <span class=\"data\" property=\"type\">animation</span> <span class=\"data\" property=\"width\">640</span> <span class=\"data\" property=\"height\">467</span> <span class=\"data\" property=\"id\">animation</span> <span class=\"data\" property=\"src\">How_COVID-19_Affects_the_Body.mp4</span> <span class=\"data\" property=\"autoplay\">true</span> <span class=\"data\" property=\"controller\">true</span> </span> </div>\n </div>\n <div class=\"section\" id=\"GUID-32B26DF2-8350-47A8-ADC2-4D632CD2EFF8__GUID-CECEED28-B5AC-47CE-9BC1-3A40D19C128E\"> <p class=\"p SectionHeader\">Transcript</p>\n <p class=\"p\">COVID-19 is the short name for the disease known as novel coronavirus disease 2019.</p>\n <p class=\"p\">Coronaviruses are a large group of similar viruses.</p>\n <p class=\"p\">Some are known to infect humans, such as SARS-CoV and MERS-CoV.</p>\n <p class=\"p\">The one that causes COVID-19 is called SARS-CoV-2.<a class=\"xref articlelink ArticleLink\" href=\"T1643490536002\" target=\"_blank\">EBSCO NAT Editorial Process</a></p>\n <p class=\"p\">All coronaviruses are named for the crown-like &ldquo;spikes&rdquo; that cover their surface, called spike, or &ldquo;S,&rdquo; proteins.</p>\n <p class=\"p\">Inside the virus, genetic material, called RNA, is made up of genes. Genes carry the information to make more copies of the virus.</p>\n <p class=\"p\">The virus can infect you if it enters your mouth, nose, or lungs.</p>\n <p class=\"p\">Inside your body, the S protein of the virus locks to a receptor on the surface of one of your cells.</p>\n <p class=\"p\">This can trigger the virus to enter the cell in a couple of ways.</p>\n <p class=\"p\">It may cause the virus to fuse with the cell surface, then release its genes into the cell.</p>\n <p class=\"p\">Or, the cell may pull the virus inside by enclosing it in a sac.</p>\n <p class=\"p\">Once inside, the virus can fuse to the sac and release its genes.</p>\n <p class=\"p\">Next, the genes use a structure in your cell, called a ribosome, to make new copies of the virus.</p>\n <p class=\"p\">The new viruses travel to the surface of the cell.</p>\n <p class=\"p\">There, they leave to infect more cells.</p>\n <p class=\"p\">In the meantime, viral S proteins left on the surface of the infected cell can cause it to fuse with nearby healthy cells, forming a giant cell.</p>\n <p class=\"p\">This may be another way for the virus to spread between cells.</p>\n <p class=\"p\">People may be infected with COVID-19 for two to fourteen days before symptoms appear.</p>\n <p class=\"p\">The three main symptoms of COVID-19 are:</p>\n <p class=\"p\">a fever, cough, and shortness of breath.</p>\n <p class=\"p\">Other symptoms may include:</p>\n <p class=\"p\">tiredness, body aches, stuffy nose, sore throat, diarrhea and vomiting, loss of appetite, and loss of smell.</p>\n <p class=\"p\">Most people have a mild illness and can recover at home.</p>\n <p class=\"p\">Some people who have the virus may not get sick at all or may show no symptoms.</p>\n <p class=\"p\">But, if you have trouble breathing, or any other symptoms that are severe, call your doctor or the emergency room. They will tell you what to do.</p>\n <p class=\"p\">For most people who have the virus, the risk for serious illness is thought to be low.</p>\n <p class=\"p\">People sixty-five years and older may have a higher risk for serious illness.</p>\n <p class=\"p\">And, people of any age may be at high-risk if they have underlying conditions, such as:</p>\n <p class=\"p\">chronic lung disease or asthma, serious heart conditions, diabetes, severe obesity, chronic kidney disease, and liver disease.</p>\n <p class=\"p\">High-risk groups also include people with a weakened immune system, including:</p>\n <p class=\"p\">those on certain medications, such as corticosteroids, people in cancer treatment, and those with HIV or AIDS.</p>\n <p class=\"p\">Even if you aren&rsquo;t in a high-risk group, it&rsquo;s important to practice social distancing, which means keeping at least two meters, or six feet, between you and other people.</p>\n <p class=\"p\">This helps prevent infections and serious illness in others as well as yourself.</p>\n <p class=\"p\">For up-to-date information about COVID-19 and other ways to prevent its spread, visit the CDC website at cdc dot gov slash coronavirus slash twenty nineteen dash ncov.</p>\n </div>\n </div>"
    }
  ],
  "ancillary": {
    "pubType": {
      "id": "Symptoms"
    },
    "hlType": "ConditionInDepth",
    "contributors": [],
    "pubFamily": "patientinformation",
    "productInformation": [
      {
        "an": "2009858136",
        "publisher": "Patient Education Reference Center, EBSCO Publishing",
        "publicationType": "patient education, lifestyle sheet",
        "product": "perc"
      }
    ],
    "multimedia": [
      {
        "mediaType": "video",
        "content": [
          {
            "links": [
              {
                "rel": "external",
                "href": "http://media.ebsco.healthcare/eis-live/video/authenticated/f_mp4/v1/EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E43111A1099.mp4?__cld_token__=exp=1648582955~hmac=94519b92ad419762adc3d575f9415ed2ff930ea8613f205b0aba8146c776d117"
              }
            ],
            "title": "How_COVID-19_Affects_the_Body.mp4. ",
            "mediaHost": "Cloudinary"
          }
        ]
      }
    ],
     "relatedLinks": [
        "article://T6543218987", 
        "article://T1234567098"
     ]
  }
}

Image and Video Responses in Articles

Article responses can include images and/or videos. These can include the title, copyright and a link to the actual image or video. The image URL is a link to a full resolution image that is optimized for the browser making the request.  The link is valid for 24 hours and should not be cached. The caller can alternately request that secure URLs (https) be returned by specifying that secure=true in the request. Image size(s) and poster size(s) of the video can also be requested.

Request for Secure Image and Video Size Links

GET https://apis.ebsco.com/medsapi-consumer-health/v2/content/articles/t1643452782631?secure=true&imageSize=small&imageSize=large&posterSize=small

Response Body

{
    "id": "t1643452782631",
    "title": "Infant Distress Warning Signs",
    "links": [
        {
            "rel": "self",
            "href": "https://apis.ebsco.com/content/articles/t1643452782631"
        }
    ],
    "metadata": {...},
    "toc": [
        {
            "title": "Transcript",
            "anchor": "GUID-A7C67A36-B583-4720-8501-83510C13758F__GUID-230088FC-C7CD-4407-AE77-568D56272D81"
        }
    ],
    "sections": [...]
    "ancillary": {
        "pubType": {
            "id": "Animation - 3D"
        },
        "contributors": [...],
        "productInformation": [...],
        "multimedia": [
            {
                "mediaType": "video",
                "content": [
                    {
                        "links": [
                            {
                                "rel": "external",
                                "href": "https://res.cloudinary.com/eis-live/video/authenticated/f_mp4/v1/EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E44637A1099.mp4?__cld_token__=exp=1660218754~hmac=478905cf63cf90930710ba186467a84d15e5af4c330c7c044af9dc5f0c658432"
                            },
                            {
                                "rel": "external",
                                "href": "https://res.cloudinary.com/eis-live/video/authenticated/t_s200/f_jpg/v1/EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E44637A1099.mp4?__cld_token__=exp=1660218754~hmac=255c2c53eac4ee9ac70453c13fde322ae163bbdfe7fa2a73b71be8521ee14fdf",
                                "posterSize": "small",
                                "type": "poster"
                            }
                        ],
                        "title": "Infant_Distress_Warning_Signs.mp4. ",
                        "mediaHost": "Cloudinary"
                    }
                ]
            },
            {
                "mediaType": "image",
                "content": [
                    {
                        "links": [
                            {
                                "rel": "external",
                                "href": "https://res.cloudinary.com/eis-live/image/authenticated/t_s200/f_auto/v1/EBSCOHealth/CCMS/Consumer_Health/images/SN7714_96213?__cld_token__=exp=1660219687~hmac=587e7a36ed1a980724873ec69cfab027218affdd8551a4c13544bd833e65e9be",
                                "imageSize": "small"
                            },
                            {
                                "rel": "external",
                                "href": "https://res.cloudinary.com/eis-live/image/authenticated/t_s1000/f_auto/v1/EBSCOHealth/CCMS/Consumer_Health/images/SN7714_96213?__cld_token__=exp=1660219687~hmac=47841d79002353b8e07ed7701931398c1b1ad9e02930ed728204945bcc8d9aa8",
                                "imageSize": "large"
                            }
                        ],
                        "title": "The Stomach. ",
                        "copyright": "Copyright © Nucleus Medical Media, Inc.",
                        "mediaHost": "Cloudinary"
                    }
                ]
            }
        ]
    }
}

For some use cases, non-expiring media links are required.  In this case, mediaLinksFormat can be set to "server", which will return a secure link to the image or video in its original size.  The link will include the file type.  If a video is returned, it will return a poster of the video in the poster's original size. By default, mediLinksFormat is set to "browser", and does not need to be specified.

GET https://apis.ebsco.com/medsapi-consumer-health/v2/content/articles/t1643452782631?mediaLinksFormat=server.

Error Response Codes

The Consumer Health get an article endpoint can return one of the error response codes.