Anonymous Recommendations Implementation Notes


Example Request Body

{
    "gender": "female",
    "yearOfBirth": "1955",
    "ethnicity": "caucasian",
    "familyHistory": [
        {
            "relationship": "father",
            "disease": "alzheimersDisease",
            "ageOfOnset": "60 or above"
        }
    ],
    "genotypes": {
        "rs3844508": "CT",
        "rs4945261": "AA",
        "rs4351": "AG"
    },
    "hasBeenDiagnosedWith": {
        "type2Diabetes": "yes"
    },
    "medical": {
        "cholesterolTotal(mg/dL)": "200",
        "homocysteine(umol/L)": "10.0"
    },
    "height(in)": "63.00",
    "weight(lbs)": "123.40",
    "systolicBloodPressure(mmHg)": "140",
    "diastolicBloodPressure(mmHg)": "95"
}
              
				
				

Example Response Body

{
    "riskFactors": [
        {
            "recommendations": [
                {
                    "category": "diet",
                    "actionId": "carbs",
                    "action": "Reduce your carbohydrate intake"
                },
                {
                    "category": "physicalActivity",
                    "actionId": "physicalActivity",
                    "action": "Increase your physical activity"
                }
            ],
            "riskFactorId": "type_2_diabetes",
            "riskFactorDisplayName": "Having Type 2 Diabetes",
            "riskFactorDescription": "Type 2 diabetes, also known as adult-onset or noninsulin-dependent diabetes, is a chronic condition that affects the metabolism of glucose (sugar) in the body. This condition is the result of resisting the effects of insulin or not producing enough of it to maintain a normal glucose level.",
            "riskFactorIdealRanges": []
        },
        {
            "recommendations": [
                {
                    "category": "diet",
                    "actionId": "sodium",
                    "action": "Reduce your sodium intake"
                },
                {
                    "category": "physicalActivity",
                    "actionId": "physicalActivity",
                    "action": "Increase your physical activity"
                }
            ],
            "riskFactorId": "hypertension",
            "riskFactorDisplayName": "Hypertension",
            "riskFactorDescription": "Systolic blood pressure is the top number and the diastolic blood pressure is the bottom number in a blood pressure reading.",
            "riskFactorIdealRanges": [
                {
                    "attributeName": "Blood Pressure",
                    "idealValueUnits": "mmHg",
                    "idealValue": "< 135/85"
                }
            ]
        },
        {
            "recommendations": [
                {
                    "category": "diet",
                    "actionId": "cholesterol",
                    "action": "Reduce your cholesterol intake"
                },
                {
                    "category": "physicalActivity",
                    "actionId": "physicalActivity",
                    "action": "Increase your physical activity"
                }
            ],
            "riskFactorId": "hypercholesterolemia",
            "riskFactorDisplayName": "Hypercholesterolemia",
            "riskFactorDescription": "Hypercholesterolemia refers to increased levels of blood cholesterol that may include increased levels of other lipids (also referred to as fats or triglycerides).",
            "riskFactorIdealRanges": [
                {
                    "attributeName": "Total Cholesterol",
                    "idealValueUnits": "mg/dL",
                    "idealValue": "< 200"
                },
                {
                    "attributeName": "LDL Cholesterol",
                    "idealValueUnits": "mg/dL",
                    "idealValue": "< 120"
                },
                {
                    "attributeName": "Triglycerides",
                    "idealValueUnits": "mg/dL",
                    "idealValue": "< 150"
                }
            ]
        }
    ]
}
           		

Request Body Keys


alcohol model

Key Possible Values Notes
beersPerWeek integers between 0 and 100 Number of 12-oz (341 mL) beers consumed per week
winePerWeek integers between 0 and 100 Number of 5-oz (142 mL) glasses of wine consumed per week
spiritsPerWeek integers between 0 and 100 Number of 1.5-oz (43 mL) glasses of spirits consumed per week

body model

Key Possible Values Notes
ageOfFirstMenstrualPeriod integer between 7 and 18 At what age did the subject's menstrual periods begin? (Only required if subject is female)
ageOfFirstPregnancy integer between 7 and 65 At what age did the subject first become pregnant? (Only required if the subject is female and has been pregnant in the past)
ageOfLastMenstrualPeriod integer between 7 and 99 At what age did the subject's menstrual periods cease? (Only applicable if the subject is a post-menopausal female)
allergenExposure cat | dustMite | dog | mixedGrassPollen | none Has the subject been diagnosed for sensitization against any of the following allergens?
allergicToCatsAlternariaOrWhiteOak cats | alternaria | whiteOak | someOfThese | noneOfThese Is the subject allergic to cats, alternaria, or white oak?
breastDensityDescription almostEntirelyFat | scatteredFibroglandularDensities | heterogeneouslyDense | extremelyDense If the subject has had a mammogram, what was her breast density description? (Only applicable if subject is female)
currentMenopausalState premenopausal | postmenopausal | none The subject's current menopausal state (only applicable if subject is female)
diastolicBloodPressure(mmHg) number between 30 and 120 The subject's diastolic blood pressure, in mmHg
difficultySleepingDaysPerWeek 1-3 days per week | 4 or more days per week How many days per week does the subject experience difficulty sleeping? Only applicable if hasDifficultySleeping is yes)
doesSnore yes | no (Deprecated) Does the subject snore when sleeping?
easilyPanics 1 | 2 | 3 | 4 | 5 (Deprecated) Does the subject panic easily? Rate from 1 [very rarely] to 5 [very frequently].
ethnicity africanAmerican | asian | asianIndian | caucasian | hanChinese | hispanic | japanese | korean | nativeAmerican | other | pacificIslander | tuscan | unknown | yoruban The subject's ethnicity
experiencedChildhoodPhysicalAbuse yes | no Was the subject physically abused as a child?
experiencedChildhoodSexualAbuse yes | no Was the subject sexually abused as a child?
exposedToRadonAtHome yes | no Is the subject exposed to radon at home?
feelsRefreshedInMornings yes | no Does the subject feel refreshed upon waking up in the mornings?
gender female | male Required. The subject's sex at birth
hadEpisodesSneezingCongestionThisYear yes | no Has the subject had more than one episode of sneezing or congestion this year, not including colds?
hadSmokingFamilyMemberDuringChildhood yes | no During the subject's childhood, did he or she have any family members who smoked at home?
hasCurrentOccupationalDieselExhaustExposure yes | no Is the subject currently employed at a job involving high levels of exposure to diesel motor exhaust? (eg. occupations such as motor vehicle mechanic, wood worker, welder, machine operator, construction worker)
hasDifficultySleeping yes | no Does the subject experience any difficulty sleeping?
hasHadBenignBreastTumor yes | no Has the subject ever had a benign tumor in her breast? (Only applicable if subject is female)
hasHadOccupationalAsbestosExposure yes | no Has the subject had any occupational exposure to asbestos for greater than 1 year? (eg. occupations such as motor vehicle mechanic, wood worker, welder, machine operator, construction worker)
hasHadOccupationalDieselExhaustExposure yes | no Has the subject ever had any occupational exposure to diesel exhaust? (eg. occupations such as mining, vehicle loading, agricultural machinery mechanic)
hasHadOccupationalTobaccoExposure yes | no Has the subject ever had any occupational exposure to tobacco smoke?
hasHistoryOfAlcoholDependence yes | no Has the subject ever had a dependence on alcohol?
hasSurvivedSexualAssault yes | no (Deprecated) Has the subject ever been sexually assaulted?
height(in) number between 13 and 107 The subject's height in inches, to 2 decimals
historyOfPanicAttacks yes | no Does the subject have a history of panic attacks?
hormoneReplacementTherapy none | nonconjugatedEstrogen | conjugatedEstrogen | estrogen | estrogenPatch | estrogenAndProgestin What type of hormone replacement therapy has the subject used? (Only applicable if the subject is a post-menopausal female who has used hormone replacement therapy)
howLongDifficultySleeping less than 1 month | more than 1 month For how long has the subject had difficulty sleeping? (Only applicable if hasDifficultySleeping is yes)
howRecentOccupationalTobaccoExposure less than 12 months ago | over 12 months ago How recently was the subject employed at a job involving exposure to tobacco smoke? (Only applicable if hasHadOccupationalTobaccoExposure is yes)
maritalStatus single | separated | widowed | married | divorced | other The subject's marital status
numYearsOccupationalDieselExhaustExposure number between 0 and 99 For how many years was the subject employed at a job involving high levels of exposure to diesel motor exhaust? (Only applicable if hasHadOccupationalDieselExhaustExposure is yes)
numberOfNevi integer values How many nevi does the subject have on his or her skin?
radonExposureLevel(PCi/L) number between 0 and 10.8 What is the radon exposure level in pCi/L at the subject's home? (Only applicable if exposedToRadonAtHome is yes)
sleepPositionSupineLateral supine | lateral (Deprecated) Does the subject generally sleep on his or her back (supine) or side (lateral)?
systolicBloodPressure(mmHg) number between 60 and 220 The subject's systolic blood pressure, in mmHg
tanningBedHours integer values For how many hours has the subject used a tanning bed?
tanningBedHoursNext6Months number greater than or equal to 0 Over the next 6 months, how many hours does the subject plan to spend using a tanning bed?
usedHrt never | currentUser | formerUser Has the subject ever used hormone replacement therapy? (Only applicable if the subject is a post-menopausal female)
usedHrtPast2Years yes | no Has the subject used hormone replacement therapy in the past 2 years? (Only applicable if the subject is a post-menopausal female)
waistCircumference(in) number between 20 and 60 The subject's waist circumference in inches, to 2 decimals
wasAssaultedUnderSubstanceInfluence yes | no (Deprecated) Has the subject been sexually assaulted while he or she was under the influence of drugs or alcohol?
wasAssaultedUsingPhysicalForce yes | no (Deprecated) Has the subject been sexually assaulted by a perpetrator who used (or threatened to use) physical force?
weight(lbs) number between 51 and 503 The subject's weight in pounds, to 2 decimals
yearOfBirth 1900 or later Required. The subject's year of birth, in 'yyyy' format

diet model

Key Possible Values Notes
isVegetarian yes | no Whether or not the subject is vegetarian
dailyServingsVegetables none | 1 per day | 2 per day | 3 per day | 4 per day Servings of vegetables per day; 1 serving is 1 cup
dailyServingsDarkLeafyVegetables none | 1 per day | 2 per day | 3 per day | 4 per day Servings of dark leafy vegetables per day (eg. spinach); 1 serving is 1 cup
dailyServingsFruit none | 1 per day | 2 per day | 3 per day | 4 per day Servings of fruits per day; 1 serving is 1 cup
dailyServingsNutProducts none | 1 or more per day Servings of nuts or nut-based products per day; 1 serving is 1 oz
dailyServingsDairyProducts none | 1 per day | 2 per day | 3 per day | 4 per day Servings of milk and other dairy products per day; 1 serving is 1/2 cup
weeklyServingsProcessedMeat none | 1 per week | 2-3 per week | 4-6 per week | 1 per day Servings of processed meat (eg. sausage, bacon) per week; 1 serving is 1 oz
weeklyServingsRedMeat none | 1 per week | 2-3 per week | 4-6 per week | 1 per day Servings of red meat (eg. beef, pork) per week; 1 serving is 1 oz
weeklyServingsWhiteMeat none | 1 per week | 2-3 per week | 4-6 per week | 1 per day Servings of white meat (eg. chicken, fish) per week; 1 serving is 1 oz
weeklyServingsWholeGrain none | 2-3 per week | 4-6 per week | 1 per day | 2 or more per day Servings of whole grain per week; 1 serving is 1/2 cup
yearsTakingMultivitamins never | less than 5 years | 5 or more years Number of years the subject has taken multivitamins regularly

familyHistory model

Key Possible Values Notes
relationship father | mother | maternalGrandfather | maternalGrandmother | paternalGrandfather | paternalGrandmother | brother | sister Required. The relationship of this family member to the subject.
disease
abdominalAorticAneurysm Abdominal Aortic Aneurysm
ageRelatedMacularDegeneration Age Related Macular Degeneration
alzheimersDisease Alzheimers Disease
atrialFibrillation Atrial Fibrillation
breastCancer Breast Cancer
colorectalCancer Colorectal Cancer
coronaryArteryDisease Coronary Artery Disease
deepVenousThrombosis Deep Venous Thrombosis
depression Depression
downSyndrome Down Syndrome
generalAsthma General Asthma
lungCancer Lung Cancer
osteoporosis Osteoporosis
prostateCancer Prostate Cancer
sleepApnea Sleep Apnea
type2Diabetes Type 2 Diabetes
ageOfOnset below 30 | 30-39 | 40-49 | 50-59 | 60 or above | unknown Required. Age of onset of the disease

hasBeenDiagnosedWith model

Key Possible Values Notes
asthma yes | no Has subject been diagnosed with asthma?
atopicDermatitis yes | no Has subject been diagnosed with atopic dermatitis?
atrialFibrillation yes | no Has subject been diagnosed with atrial fibrillation?
cardiomyopathy yes | no Has subject been diagnosed with cardiomyopathy?
copd yes | no Has subject been diagnosed with chronic obstructive pulmonary disease?
eclampsia yes | no Has subject been diagnosed with eclampsia (only applicable if female)?
gestationalHypertension yes | no Has subject been diagnosed with gestational hypertension (only applicable if female)?
heartFailure yes | no Has subject been diagnosed with heart failure?
hypercholesterolemia yes | no Has subject been diagnosed with hypercholesterolemia?
hyperthyroidism yes | no Has subject been diagnosed with hyperthyroidism?
insomniaOrHypersomnia yes | no Has subject been diagnosed with either insomnia or hypersomnia?
irritableBowelDisease yes | no Has subject been diagnosed with either ulcerative colitis or Crohn's disease?
myocardialInfarction yes | no Has subject been diagnosed with myocardial infarction?
obstructiveSleepApnea yes | no Has subject been diagnosed with obstructive sleep apnea?
stroke yes | no Has subject been diagnosed with stroke?
syphilis yes | no Has subject been diagnosed with syphilis?
gonorrhea yes | no Has subject been diagnosed with gonorrhea?
otherSTD yes | no Has subject been diagnosed with any other STD (not gonorrhea or syphilis)?
valveDisease yes | no Has subject been diagnosed with Valve Disease?

medical model

Key Possible Values Notes
cholesterolTotal(mg/dL) number What is the subject's total cholesterol level?
hdl(mg/dL) number What is the subject's HDL level?
ldl(mg/dL) number What is the subject's LDL level?
triglycerides(mg/dL) number What is the subject's triglyceride level?
homocysteine(umol/L) number What is the subject's homocysteine level?

medicinesTakenPast30Days model

Key Possible Values Notes
diuretics yes | no Has the subject taken any diuretic medications within the past 30 days? (eg. hydrochlorothiazide, furosemide)
nsaids yes | no Has the subject taken NSAID medications within the past 30 days on a regular basis? (eg. ibuprofen, naproxen)

physicalActivities model

Key Possible Values Notes
intensity low-moderate 3.0-4.4 MET, e.g. Slow walking, 2.5 mph
high-moderate 4.5-5.9 MET, e.g. Moderate-paced bicycling, 9.4 mph
vigorous 6.0-8.9 MET, e.g. Moderate-paced running, 4 mph
extremely vigorous 9.0+ MET, e.g. Fast running, 7 mph
minPerWeek integer between 1 and 1440 Required. The number of minutes per week that the subject performs this physical activity

smoking model

Key Possible Values Notes
hasSmoked100CigarettesInLifetime yes | no Has the subject smoked 100 or more cigarettes in his or her lifetime? (If 'no', then the rest of this model is not applicable and is not used in the assessment.)
isCurrentSmoker yes | no Does the subject currently smoke?
ageWhenBeganSmoking integer between 0 and 99 Age at which subject began smoking
ageQuitSmoking integer between 0 and 99 Age at which subject quit smoking (eg. '30')? (Only applicable if isCurrentSmoker is no)
isTakingActionToQuit yes | no Is the subject currently taking action to quit smoking? (Only applicable if isCurrentSmoker is yes)
numberWeeklyCigarettesWhenLastSmoked yes | no When the subject last smoked, how many cigarettes per week did he or she smoke? (If isCurrentSmoker is yes, then this is the number of weekly cigarettes the subject currently smokes)

Response Body Keys


response model

Key Details
riskFactors An array of riskFactor objects corresponding to the user's top risk factors.

riskFactor model

Key Details
recommendations An array of recommendation objects. Each object provides recommended actions to improve this risk factor.
riskFactorIdealRanges An array of riskFactorIdealRange objects. Each object provides ideal ranges for attributes comprising this risk factor.
riskFactorId String Id for this risk factor.
riskFactorDisplayName Name of this risk factor.
riskFactorDescription A short summary of this risk factor.

recommendation model

Key Details
category The category for this action
actionId String Id for this action
action Description of the recommended action

riskFactorIdealRange model

Key Details
attributeName Display name for this attribute
idealValue String representation of the ideal range for this attribute
idealValueUnits units for the idealValue range