Get Tool by ID
The DynaMed Decisions /v1/content/tools endpoint gets tool details. Before you can execute a tools call, you must have an 'Authorization' token which is to be entered into the request header. The response from the list API returns an id which can be used to retrieve the tool contents. Not all tools are available to all consumers. The response shown below has two high-level arrays.
- options: Each option object has attributes such as optionKey and name.
- questions: Each question object has a field named answers. answers is an array that includes answers for all of the options listed in the options array.
Request
GET https://apis.ebsco.com/medsapi-dynamed-decisions/v1/content/tools/shared-decision-making_hip-osteoarthritis
{
"id": "shared-decision-making_hip-osteoarthritis",
"title": "Hip Osteoarthritis",
"slug": "/shared-decision-making_hip-osteoarthritis",
"description": "This tool is used to determine...",
"links": [
{
"rel": "self",
"href": "https://apis.ebsco.com/medsapi-dynamed-decisions/v1/content/tools/shared-decision-making_hip-osteoarthritis"
}
],
"optionGrid": {
"polarDecisionTool": true,
"options": [
{
"optionKey": "warfarin",
"name": "Warfarin"
}
],
"questions": [
{
"answers": [
{
"optionKey": "notreatment",
"answer": "<p>You will have no tests or treatments now. Ask for advice if you notice new symptoms.</p>"
}
],
"question": "What does the option involve?"
}
],
"references": "<ol><li><p>Akman T, Binbay M, Tekinarslan E, Tepeler A, Akcay M, Ozgor F.</p></li></ol>",
"contributors": "<h2><p>Clinical Review</p></h2><p>Kevin Loughlin, MD, MBA</p>",
"certifications": "<p>This product has been certified by the Washington State Health Care Authority pursuant to RCW 7.70.060.</p>",
"competingInterests": "<p>The editors and reviewers on this EBSCO Health Option Grid decision aid have declared no conflicts of interest, as of Apr 2, 2019.</p>",
"definitions": [
{
"name": "<p>BPH</p>",
"text": "<p>BPH is another name for benign prostatic hypertrophy.</p>"
}
],
"supplementalInformation": "<p><data base=\"name\">Enlarged Prostate (Benign Prostatic Hypertrophy) Treatment Options </data></p>"
}
}
Error Response Codes
The DynaMed Decisions get tool by ID endpoint can return one of the error response codes.