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.     Additional fields may be returned in the metadata. 

{
  "id": "t1643477381001",
  "title": "Toxicology Screen",
  "links": [
    {
      "rel": "self",
      "href": "https://apis.ebsco.com/medsapi-consumer-health/v1/content/articles/t1643477381001"
    }
  ],
  "metadata": {
    "DC.Type": "topic",
    "DC.Title": "Toxicology Screen",
    "DC.Format": "XHTML",
    "copyright": "(C) Copyright 2023",
    "DC.Coverage": "/perc/labtests/Toxicology Screen,20311000010",
    "DC.Language": "en",
    "DC.Identifier": "GUID-EA812200-23D9-4B3E-B61E-64601350EAEE",
    "DC.rights.owner": "(C) Copyright 2023",
    "DC.Date.Created": "2018-12-01T00:00:00.000Z",
    "DC.Date.Revised": "2023-11-03T00:00:00.000Z",
    "DC.Creator": "by Michael Jubinville, MPH",
    "publisherPlace": "Ipswich, Massachusetts",
    "ageGroup": [
      "Infant, Newborn",
      "Infant",
      "Child, Preschool",
      "Child",
      "Adolescent",
      "Young Adult",
      "Adult",
      "Middle Aged",
      "Aged",
      "Aged, 80 and Older"
    ],
    "gender": [
      "Male",
      "Female"
    ],
    "medicalCodes.ICD-9-CM-P": [
      "91.25|Microscopic examination of specimen from kidney, ureter, perirenal and periureteral tissue, toxicology"
    ],
    "medicalCodes.SNOMED": [
      "167007008|Blood sent for toxicology"
    ],
    "medicalCodes.LOINC": [
      "16793-2|Drugs identified Unk sub Prid Pt Nom Screen"
    ],
    "title": "Toxicology Screen",
    "created": "20080321",
    "revised": "20230601"
  },
  "toc": [
    {
      "title": "What Is a Toxicology Screen?",
      "anchor": "GUID-6D9D301C-555A-44AE-82EE-C7F959F13676__WHAT"
    }
  ],
  "sections": [
    {
      "anchor": "GUID-6D9D301C-555A-44AE-82EE-C7F959F13676",
      "title": "Toxicology Screen",
      "content": "<div class=\"body\"> <p class=\"p SubTitle\">(Amphetamines Screen; Analgesics Screen)</p> \n <div class=\"section\" id=\"GUID-6D9D301C-555A-44AE-82EE-C7F959F13676__WHAT\"> <p class=\"p SectionHeader\">What Is a Toxicology Screen?</p> \n <p class=\"p standard\">A toxicology screen tests for the presence of medicines, illegal drugs, or poisons in the blood, urine, or saliva. It can detect many different drugs at one time.</p> \n </div></div>"
    },
    {
      "references": [
        {
          "anchor": "REFERENCES",
          "title": "References:",
          "content": [
            {
              "id": "GUID-7D837600-E3C7-47AE-B2A3-EC25C7D836F7__P1",
              "data": "Drugs of abuse urine screening test. EBSCO DynaMed website. Available at: https://www.dynamed.com/lab-monograph/drugs-of-abuse-urine-screening-test."
            }
          ]
        }
      ]
    }
  ],
  "ancillary": {
    "hlType": "FactSheet",
    "pubFamily": "patientinformation",
    "chunkId": "253517",
    "pubType": {
      "id": "Lab Test"
    },
    "navigationGroup": [
      {
        "id": "T123456",
        "title": "Main Page",
        "chunkId": "103020"
      }
    ],
    "contributors": {
       "authors": [...],
       "reviewers": [
         {
            "id": "T1643488381850ES",
            "chunkId": "29311",
            "reviewer": "Nicole S. Meregian, PA",
            "lastName": "MEREGIAN",
            "organization": "EBSCO Medical Review Board "
         }
      ],
      "authors": [...]
     },
    "multimedia": [],
    "productInformation": [
      {
        "an": "2009805435",
        "product": "NUP",
        "title": "Toxicology Screen",
        "publisher": "EBSCO Publishing",
        "publicationType": "(patient education, laboratory test)"
      }
    ]
  }
}

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.jpg?__cld_token__=exp=1660218754~hmac=255c2c53eac4ee9ac70453c13fde322ae163bbdfe7fa2a73b71be8521ee14fdf",
                                "posterSize": "small",
                                "type": "poster"
                            }
                        ],
                        "publicId": "EBSCOHealth/CCMS/Consumer_Health/videos/SNV71100E44637A1099"
                        "title": "Infant_Distress_Warning_Signs.mp4. ",
                        "mediaHost": "Cloudinary"
                    }
                ]
            },
            {
                "mediaType": "image",
                "publicId": "EBSCOHealth/CCMS/Consumer_Health/images/SN7714_96213",
                "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.jpg?__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.jpg?__cld_token__=exp=1660219687~hmac=47841d79002353b8e07ed7701931398c1b1ad9e02930ed728204945bcc8d9aa8",
                                "imageSize": "large"
                            }
                        ],
                        "title": "The Stomach. ",
                        "copyright": "Copyright © Nucleus Medical Media, Inc.",
                        "mediaHost": "Cloudinary",
                        "publicId": "xxx"
                    }
                ]
            }
        ]
    }
}

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.