Risk Output

Example request

GET /api/v1/{tenantId}/reports/{traversalId}/risks
  ?ages=80&ages=90
  &conclusions=3495&conclusions=3501

Parameters

Parameter	Description
tenantId	The tenant ID, usually the same as the `client_id` used for authentication
traversalId	ID of a completed HRA traversal
ages	Ages for which to calculate the risks, e.g. `ages=80&ages=90` will calculate risks by the ages of 80 and 90, respectively
conclusions	IDs of conclusions selected from the `checkableConclusions` array (see below). If present, the API will calculate the risks as if the user had implemented the specified recommendations.

Example response

{
    "age": 38,
    "ageAtDeath": 85,
    "minimumAgeAtDeath": 91,
    "healthAge": 35,
    "minimumHealthAge": 29,
    "averageLifeExpectancy": 82,
    "maximumLifeExpectancy": 91,
    "gender": "F",
    "risks": [
        {
            "name": "Breast cancer",
            "time": 42,
            "current": 9.69,
            "minimum": 6.57
        },
        {
            "name": "Breast cancer",
            "time": 52,
            "current": 14.29,
            "minimum": 9.77
        },
        {
            "name": "Bowel cancer",
            "time": 42,
            "current": 1.84,
            "minimum": 1.21
        },
        {
            "name": "Bowel cancer",
            "time": 52,
            "current": 2.53,
            "minimum": 1.67
        },
        {
            "name": "Death",
            "time": 42,
            "current": 35.35,
            "minimum": 20.5
        },
        {
            "name": "Death",
            "time": 52,
            "current": 72.15,
            "minimum": 48.96
        },
        {
            "name": "Diabetes",
            "time": 42,
            "current": 15.14,
            "minimum": 8.34
        },
        {
            "name": "Diabetes",
            "time": 52,
            "current": 18.39,
            "minimum": 10.22
        },
        {
            "name": "Heart disease",
            "time": 42,
            "current": 6.1,
            "minimum": 3.05
        },
        {
            "name": "Heart disease",
            "time": 52,
            "current": 11.18,
            "minimum": 5.67
        },
        {
            "name": "Lung cancer",
            "time": 42,
            "current": 0.17,
            "minimum": 0.17
        },
        {
            "name": "Lung cancer",
            "time": 52,
            "current": 0.35,
            "minimum": 0.35
        },
        {
            "name": "Stroke",
            "time": 42,
            "current": 2.22,
            "minimum": 1.95
        },
        {
            "name": "Stroke",
            "time": 52,
            "current": 4.06,
            "minimum": 3.57
        }
    ],
    "checkableConclusions": [
        3497,
        10076,
        3505,
        ...
    ]
}

Definitions

RiskOutput

Property	Description
age	The user's actual age
ageAtDeath	The user's predicted age at death
minimumAgeAtDeath	The user's predicted age at death, if all the recommendations are implemented
healthAge	The user's health age, calculated as `age + averageLifeExpectancy - ageAtDeath`
minimumHealthAge	The user's health age, if all the recommendations are implemented
averageLifeExpectancy	The average life expectancy for a person of this age and gender
maximumLifeExpectancy	The maximum life expectancy for a person of this age and gender, if all recommendations are implemented
gender	The user's gender: "M" for male, "F" for female, "U" for other/unknown
risks	Array of `Risk` objects (see below), one for each risk/timescale combination
checkableConclusions	Array of `assetId`s of conclusions (recommendations) that may affect the calculations if implemented. A list of the conclusions attached to the traversal should be requested from the `conclusions` endpoint of the Traversal API. See the conclusions documentation for more details.

Risk

Property	Description
name	Name of the risk
time	The timescale, in years from now
current	Percentage probability of the risk occurring within the given timescale
minimum	Percentage probability of the risk occurring within the given timescale, if all recommendations are implemented