Consumer Health

 

Browse our guides and interact with our API reference for more information about MEDSAPI Product Content. Try the API and learn about core concepts.

 

 

 

 

Retrieving Articles

The Product Content API GET an article by article ID endpoint returns an article for a product.  Before you can execute an article call, you must have an 'Authorization' token which is entered into the request header. Since the product content articles by ID endpoint can return an article coming from DynaMed, DynaMedex, Dynamic Health, Consumer Health or the Nursing and Allied Health Reference Center, this documentation provides a generic response that documents all of the fields for all of the products.  Please consult the individual product documentation pages for more clearly identifed fields that may be returned.

To Perform an Article Request (example):

Gather the following information for the request:

Request

GET https://apis.ebsco.com/medsapi-ref-ctr/v1/content/articles/dm:t904163

Response

The response below is a generic response for all of the fields that might be returned by any of our product articles.  Not all of the fields will be returned.  All article responses first contain an ID and links field.  Article responses can include images, videos and algorithms which 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 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.

In the sample response below, please note that bolded fields followed by an arrow indicate that the field is unique to a particuar product set. 

{
  "id": "dm:t115279",
  "title": "Acne",
  "slug": "/condition/acne",
  "links": [
    {
      "href": "https://apis.ebsco.com/medsapi-product-content/v1/articles/dm:t12345",
      "rel": "self"
    }
  ],
  "metadata": {
    "DC.Coverage": [
      "PediatricsDermatologic disorders"
    ],
    "DC.Date.Created": "2017-06-27",
    "DC.Date.Revised": "2019-07-29",
    "DC.Format": "XHTML",
    "DC.Identifier": "GUID-944EB57C-4546-4A61-924E-713D3A3DB473",
    "DC.Language": "en",
    "DC.Publisher": "EBSCO Publishing",
    "DC.Title": "Acne",
    "DC.Type": "topic",
    "DC.rights.owner": "(C) Copyright 2023",
    "abstract": "Acne is a chronic skin condition characterized by noninflammatory open and/or closed comedones and inflammatory lesions.",
    "copyright": "(C) Copyright 2023",
    "description": "Acne is a chronic skin condition characterized by noninflammatory open and/or closed comedones and inflammatory lesions.",
    <== additional fields possible based on product    
  },
  "toc": [
    {
      "anchor": "GUID-3E2BB624-A1C1-4C77-BF7A-19789BD87180",
      "children": [
        {
          "anchor": "OVERVIEW_BACKGROUND",
          "title": "Background"
        }
      ],
      "title": "Overview and Recommendations"
    }
  ],
  "sections": [
    {
      "anchor": "GUID-3E2BB624-A1C1-4C77-BF7A-19789BD87180",
      "children": [
        {
          "anchor": "OVERVIEW_BACKGROUND",
          "content": "<html>...</html>",
          "title": "Background"
        }
      ],
      "content": "<html>...</html>",
      "title": "Overview and Recommendations",
      "references": [  <== Consumer Health,
      
        {
          "title": "References",
          "anchor": "REFERENCES",
          "content": [
            {
              "id": "GUID-77FE74DB-FA1A-40B5-9DFF-866561FA6CE3__P1",
              "data": "Tartaglia NR . A review of trisomy X. Orphanet J Rare Dis. 2010;5:8."
            }
          ]
        }
      ]
    }
  ],
  "tablesContent": {
    "PREDICTING_WEANING_SUCCESS__TABLE_AAA_AA1_131": "<xhtml> ....</xhtml>"
  }
  "ancillary": {
    "consensusDetails": [
      {
        "anchor": "GUID-342C5BB2-451B-44EA-977C-EC127205856A__CONSENSUSDETAIL",
        "consensusNote": "<div>Content referenced with...</div>",
        "consensusPanel": "<div>Panel participants:</div>"
      }
    ],
    "contributors": {   <=== Note that contributors may return an array of objects for Consumer Health, DynaMed and DynaMedex
      "": {
        "affiliationText": "\"The Skin Clinic, Massachusetts, United States",
        "conflictsText": "Dr. Elpern declares no relevant conflicts of\\n interest.",
        "degrees": "MD, MPH, FACP",
        "firstName": "David J.",
        "label": "Topic Editor",
        "lastName": "Elpern"
      },
      "revisedDate": "2017-06-27"
    },
    "description": "Acne is a chronic skin condition characterized by noninflammatory open and/or closed comedones and inflammatory lesions.",
    "headerMetadata": {
      "boxedWarnings": [
        {
          "heading": "Intravenous (Powder for Solution)",
          "warnings": [
            "Hypersensitivity Reactions Including Anaphylaxis"
          ]
        }
      ],
      "classes": [
        "Enzyme"
      ],
      "routes": [
        "intravenous"
      ]
    },
    "checklist": [  <== Dynamic Health
      {
        "anchor": "GUID-0F92EBD8-09F3-4CF5-BBC3-3722E5F6E038__GUID-77FE98B5-96E3-49F2-B0BC-AD01B69A6BBE",
        "content": "< div>html< /div>",
        "title": "Pre-Procedure Steps"
      }
    ],
    "glossary": {  <== Dynamic Health
      "anchor": "GUID-0FD93E05-5A58-460E-A875-DECF39E9C5D2",
      "title": "Glossary",
      "sections": [
        {
          "anchor": "GUID-DC4C8487-B3A7-429B-ADF2-5FDE8D98C96A",
          "content": "< div>html< /div>",
          "title": "peristalsis"
        }
      ]
    },
    "supplemental": { <== Dynamic Health
      "anchor": "GUID-A951E562-1BBE-41CB-B43D-53D46F4FEFD7",
      "title": "Supplemental Information",
      "sections": [
        {
          "anchor": "GUID-A951E562-1BBE-41CB-B43D-53D46F4FEFD7__GUID-5A4B56A8-7993-4A5D-92F3-9F3E4602F89B",
          "content": "",
          "title": "Contraindications to Gait Belt Use"
        }
      ]
    }
    "multimedia": [
      {
        "content": [
          {
            "id": "i1616936170274",
            "title": "Birt-Hogg-Dubé syndrome. ",
            "format": "mp4",
            "copyright": "Copyright 2023, Luke Danaher. Video courtesy of Luke Danaher and Radiopaedia.org. Used under licence.",
            "description": "Diagnostic Approach to Cystic Lung Disease",
            "mediaProvider": "Science Photo Library",
            "mediaHost": "cloudinary",
            "publicId": "EBSCOHealth/CCMS/Dynamed/videos/V1674666001630"
            "links": [
              {
                "href": "https://media.ebsco.healthcare/video/authenticated/s--y2MpK4a9--/v1674665799/EBSCOHealth/CCMS/Dynamed/videos/V1674666001630.mp4",
                "imageSize": "medium",
                "posterSize": "small",
                "rel": "external"
              }
            ]
          }
        ],
        "mediaType": "video"
      }
    ],
    "pubDate": "2018-06-29",
    "pubType": {
      "id": "condition"
    },
    "abstract": "SYNOPSIS OF FACTS: Plaintiff, female, 38, had periodontal surgery ...",  <== found in NAH Reference center
     "extlinks": [ <== found in NAH Reference center
      {
        "href": "I000001.png",
        "type": "image",
        "xlink": "http://www.w3.org/1999/xlink",
        "lastModifiedDate": "2023-08-02T02:44:18.746Z"
      }
    ],
    "referenceLinks": [
      {
        "anchor": "GUID-C22B30D6-C077-4BDE-8547-F6C9F2DAE88A__AAD2016",
        "description": "<li>Eichenfield DZ<div data-title=\\\"JAMA 2021\\\" data-transform=\\\"full-text-container\\\" data-value=\\\"34812859\\\"><a href=\\\"http://pubmed.ncbi.nlm.nih.gov/34812859?dopt=Abstract\\\">PubMed Abstract</a></div>.</li>"
      }
    ],
    "revisedDate": "2019-07-29",
    "HFC": {
      "content": "<div>This content is supported by",
      "title": "Hospitalist Panel",
      "dialog": "<div>content to display in the dialog"
    },
    "tables": [
      {
        "id": "STAGING__D12E20",
        "title": "Table 1",
        "caption": "AHA/ACC/HFSA Staging of Heart Failure",
        "standAlone": true,
        "parentSection": "INCIDENCE_PREVALENCE"
      }
    ],
    "updates": [
      {
        "text": "Heart Failure Society of America guideline on heart failure epidemiology...",
        "timestamp": "2023-10-18T00:47:05.000Z",
        "practiceChangingUpdate": true,
        "healthEquity": "false",
        "updateType": "guidelineNotationUpdate",
        "updatePriority": "low",
        "anchor": "UNITED_STATES_GUIDELINES__LI_XR1_ZCK_DZBGNU101723"
      }
    ],
    "pubFamily": "patientinformation", <== found in Consumer Health
    "navigationGroup": [ <== found in Consumer Health
      {
        "id": "T123456",
        "title": "Main Page",
        "chunkId": "103020"
      }
    ],
    "productionInformation": [ <== found in Consumer Health,
     {
        "an": "2009858136",
        "title": "Shingles",
        "publisher": "Patient Education Reference Center, EBSCO Publishing",
        "publicationType": "patient education, lifestyle sheet",
        "product": "perc"
      }
    ]
  }
}

Error Response Codes

The Product Content get an article endpoint by article ID can return one of the error response codes.