GuidesAPI ReferenceTry Ribbon!

Condition Content Endpoint

Suggest Edits

Overview

Description: The Conditions endpoint provides modularized information on 200+ conditions, including condition overviews, symptoms, causes, and treatment options.

Endpoint: /v1/conditions and /v1/conditions/{UUID}

Status: Live -- Please Contact Us to Learn More

Example use-case: Build a full article on the Common Flu during flu season to inform users of your telemedicine app when to contact a medical professional, how to prevent the flu, and what the common symptoms are.

Diving In - Search for Conditions

Ribbon Health combines data from high-quality sources into a clean, structured format that makes it easy to integrate into your core application.

We can use the search parameter to perform a 'fuzzy' search against the key fields in each condition object to return the most relevant options.

❗️

/conditions/ endpoint versioning

Note: this conditions content endpoint is different from the conditions endpoint.

In order to switch between the two versions of the /conditions/ endpoint, you must include a header variable in your API request:

  • Ribbon-Version = 2019-11-19 for this /conditions/ content endpoint
  • Ribbon-Version = 2021-05-03 for the /conditions/ endpoint (docs)

Depending on your use case, we will set one or the other as your default API version, so you only need to use the header for the non-default use case. Please contact us for more information about this and to make sure your default is set correctly!

Example Request

curl -X GET \
  'https://api.ribbonhealth.com/v1/conditions?search=asthma' \
  -H 'authorization: Token your_token'

Example JSON Output

This is what we get in return:

{
  "count": 1,
  "next": null,
  "previous": null,
  "data": [
    {
      "uuid": "f8825889-58c1-4a61-8e63-e42277aefa5a",
      "display": "Asthma",
      "condition_code_count": 1,
      "condition_codes": [
        {
          "code": "J45",
          "type": "ICD",
          "description": "Asthma"
        }
      ]
    }
  ]
}

Diving In - Viewing Conditions

We can then view the full content on a given condition by uuid. Let's try f8825889-58c1-4a61-8e63-e42277aefa5a, which we learned above is Asthma.

Example Request

curl -X GET \
  'https://api.ribbonhealth.com/v1/conditions/f8825889-58c1-4a61-8e63-e42277aefa5a' \
  -H 'authorization: Token your_token'

Example JSON Output

This is what we get in return:

{
  "uuid": "f8825889-58c1-4a61-8e63-e42277aefa5a",
  "display": "Asthma",
  "condition_code_count": 1,
  "condition_codes": [
    {
      "code": "J45",
      "type": "ICD",
      "description": "Asthma"
    }
  ],
  "condition_content": {
    "overview": {
      "content": [
        {
          "type": "text",
          "value": "Asthma is a common lung condition that causes occasional breathing problems."
        }
      ]
    },
    "symptoms": {
      "content": [
        {
          "type": "text",
          "value": "The main symptoms of asthma are:"
        },
        {
          "type": "bulleted_list",
          "value": [
            "a whistling sound when breathing (wheezing)",
            "breathlessness",
            "a tight chest, which may feel like a band is tightening around it",
            "coughing"
          ]
        },
        {
          "type": "text",
          "value": "The symptoms can sometimes get temporarily worse. This is known as an asthma attack"
        }
      ]
    },
    "causes": {
      "content": [
        {
          "type": "text",
          "value": "Asthma is caused by swelling (inflammation) of the breathing tubes that carry air in and out of the lungs. This makes the tubes highly sensitive, so they temporarily narrow."
        },
        {
          "type": "text",
          "value": "It may occur randomly or after exposure to a trigger."
        },
        {
          "type": "text",
          "value": "Common asthma triggers include:"
        },
        {
          "type": "bulleted_list",
          "value": [
            "allergies (to house dust mites, animal fur or pollen, for example)",
            "smoke, pollution, and cold air",
            "exercise",
            "infections like colds or flu"
          ]
        },
        {
          "type": "text",
          "value": "Identifying and avoiding your asthma triggers can help you keep your symptoms under control."
        }
      ]
    },
    "treatments": {
      "content": [
        {
          "type": "text",
          "value": "The main treatments for asthma are inhalers that either ease symptoms when they occur or help stop symptoms occurring."
        },
        {
          "type": "text",
          "value": "Asthma is usually treated by using an inhaler, a small device that lets you breathe in medicines."
        },
        {
          "type": "text",
          "value": "The main types are:"
        },
        {
          "type": "bulleted_list",
          "value": [
            "reliever inhalers – used when needed to quickly relieve asthma symptoms for a short time",
            "preventer inhalers – used every day to prevent asthma symptoms occurring"
          ]
        },
        {
          "type": "text",
          "value": "Some people also need to take tablets."
        }
      ]
    },
    "sources": [
      "https://www.nhs.uk"
    ]
  }
}

Fields

Below are the fields included in the default response from this endpoint when we retrieve information on a given condition using its uuid.

FieldDescription
uuidUniversally unique identifier for the condition.
displayName of the condition.
condition_code_countNumber of codes associated with the condition.
condition_codesList of condition codes associated with the condition.
condition_contentArticle with information on the condition, including overview, symptoms, causes, and treatments.
contentList of type, value pairs that contains the information for a given section (overview, symptoms, causes, treatments).
typeNature of the content in a type, value pair. Current options are: text, bulleted_list (similar to an unordered HTML list), numbered_list (similar to an ordered HTML list).
valueThe actual information in a type, value pair. If the type is text, then the value will be a string. If the type is bulleted_list or numbered_list, then the value will be a list of strings.
sourcesList of sources that were used to create the article on the condition.

Updated almost 3 years ago