Health Data Safe - Data Dictionnary

Github Repo

---

Files

Title	Filename
Pack items & streams	pack.json
Json Schema Item	./json-schemas/item.json
Json Schema Defs	./json-schemas/defs.json
Streams Tree	./streamsTree.json
Items dictionnary	./items.json
EventTypes dictionnary	./eventTypes.json
Datasources dictionnary	./datasources.json
Unit conversions	./conversions.json
Converter: cervical-fluid — versions	converters/cervical-fluid/index.json
Converter: cervical-fluid — latest pack	converters/cervical-fluid/pack-latest.json
Converter: mood — versions	converters/mood/index.json
Converter: mood — latest pack	converters/mood/pack-latest.json
Converters index	converters/pack.json
User settings definitions	./settings.json

HDS STREAMS TREE

---

Items

Id & Type	Description	streamId & eventType
activity-cycling Type: checkbox When: unlimited	Cycling Cycling or biking session.	streamId: activity-cycling eventType(s): activity/plain version: v1
activity-hiit Type: checkbox When: unlimited	HIIT High-intensity interval training session.	streamId: activity-hiit eventType(s): activity/plain version: v1
activity-hiking Type: checkbox When: unlimited	Hiking Hiking or trail walking session.	streamId: activity-hiking eventType(s): activity/plain version: v1
activity-jogging Type: checkbox When: unlimited	Jogging Jogging or running session.	streamId: activity-jogging eventType(s): activity/plain version: v1
activity-pilates Type: checkbox When: unlimited	Pilates Pilates session.	streamId: activity-pilates eventType(s): activity/plain version: v1
activity-stretching Type: checkbox When: unlimited	Stretching Stretching or flexibility exercises.	streamId: activity-stretching eventType(s): activity/plain version: v1
activity-swimming Type: checkbox When: unlimited	Swimming Swimming session.	streamId: activity-swimming eventType(s): activity/plain version: v1
activity-weights Type: checkbox When: unlimited	Weights Strength or weight training session.	streamId: activity-weights eventType(s): activity/plain version: v1
activity-yoga Type: checkbox When: unlimited	Yoga Yoga session.	streamId: activity-yoga eventType(s): activity/plain version: v1
body-height Type: number When: unlimited	Body height Measured body height	streamId: body-height eventType(s): (Unit): length/m, length/ft version: temporary
body-skin-acne Type: checkbox When: P1D	Acne Acne or skin breakouts.	streamId: body-skin-acne eventType(s): activity/plain version: v1
body-skin-dry Type: checkbox When: P1D	Dry Skin Dry skin.	streamId: body-skin-dry eventType(s): activity/plain version: v1
body-skin-glowing Type: checkbox When: P1D	Glowing Skin Good or glowing skin quality.	streamId: body-skin-glowing eventType(s): activity/plain version: v1
body-skin-oily Type: checkbox When: P1D	Oily Skin Oily or greasy skin.	streamId: body-skin-oily eventType(s): activity/plain version: v1
body-vulva-bleeding Type: select When: unlimited	Bleeding intensity Subjective bleeding intensity on a 0-1 proportion scale. 0: None0.08: Spotting0.2: Very light0.35: Light0.55: Moderate0.75: Heavy0.95: Very heavy	streamId: body-vulva-bleeding eventType(s): ratio/proportion version: v2
body-vulva-bleeding-browndark Type: checkbox When: P1D	Brown/dark coloration Presence of brown or dark coloration in bleeding. Qualifier for a co-occurring body-vulva-bleeding event.	streamId: body-vulva-bleeding-browndark eventType(s): activity/plain version: v1
body-vulva-bleeding-clots Type: checkbox When: P1D	Blood clots Presence of blood clots during bleeding. Qualifier for a co-occurring bleeding event.	streamId: body-vulva-bleeding-clots eventType(s): activity/plain version: v1
body-vulva-bleeding-miscarriage Type: checkbox When: P1D	Miscarriage Bleeding Vaginal bleeding associated with pregnancy loss.	streamId: body-vulva-bleeding-miscarriage eventType(s): activity/plain version: v1
body-vulva-bleeding-postpartum Type: checkbox When: P1D	Postpartum Bleeding Vaginal bleeding following childbirth (lochia).	streamId: body-vulva-bleeding-postpartum eventType(s): activity/plain version: v1
body-vulva-cervix-position Type: composite When: P1D	Cervical Position Self-assessed cervical position with three dimensions (height, firmness, openness) on a 0–1 fertility scale.	streamId: body-vulva-cervix-position eventType(s): cervix-position/3d-vectors version: v1
body-vulva-mucus-inspect Type: select When: unlimited	Cervical Fluid Inspect Cervical fluid observation as a 9-dimensional vector, convertible across charting methods (Apple Health, Creighton, Billings, Mira, etc.) clear: Clearcreamy: Creamydry-sticky: Dry & Stickyegg-white: Egg White	streamId: body-vulva-mucus-inspect eventType(s): vulva-mucus-inspect/9d-vector version: v2
body-vulva-mucus-stretch Type: select When: unlimited	Cervical Fluid Stretch Manual strech test of cervical fluid. Short can be streched less than 2 cm, long greater than 2cm. 0: No Strech1: Short2: Long	streamId: body-vulva-mucus-stretch eventType(s): ratio/generic version: v1
body-vulva-wetness-feeling Type: select When: unlimited	Vulva Wetness feeling Vulva wetness feeling 0: Dry1: Wet2: Very wet	streamId: body-vulva-wetness-feeling eventType(s): ratio/generic version: v1
body-vulva-wetness-wiping Type: select When: unlimited	Vulva Wetness when wiping Vulva wetness when wiping 0: Dry1: Wet2: Very wet	streamId: body-vulva-wetness-wiping eventType(s): ratio/generic version: v1
body-weight Type: number When: unlimited	Body weight Measured body weight	streamId: body-weight eventType(s): (Unit): mass/kg, mass/lb version: temporary
family-children-count Type: number When: once	Nb of children Number of children at this date	streamId: family-children eventType(s): count/generic version: temporary
fertility-cycles-charted-count Type: number When: once	Nb of charted cycles Number of total charted cycles at this date	streamId: fertility-cycles-charted-estimation eventType(s): count/generic version: temporary
fertility-cycles-fertile-window Type: checkbox When: P1D	Fertile Window When a women is considered a fertile Use duration property to indicate end of fertile window.	streamId: fertility-cycles-fertile-window eventType(s): activity/plain version: temporary
fertility-cycles-ovulation Type: checkbox When: P1D	Ovulation Day Flag this day as an ovulation day	streamId: fertility-cycles-ovulation eventType(s): activity/plain version: temporary
fertility-cycles-peak-day Type: checkbox When: P1D	Peak day of fertility When fertility is at its highest point	streamId: fertility-cycles-peak-day eventType(s): activity/plain version: temporary
fertility-cycles-period-end Type: checkbox When: P1D	End of period. Last day of periods. First day of period is given by a new cycle indication. To track start / end of period, use fertility-cycles-start & fertility-cycles-period-end.	streamId: fertility-cycles-period eventType(s): activity/plain version: temporary
fertility-cycles-start Type: checkbox When: P1D	New Cycle Flag this day as a new cycle start. First day of full menstrual bleeding (Period) Cycle duration is determined by next fertility cycle date unless duration property is given.	streamId: fertility-cycles-start eventType(s): activity/plain version: temporary
fertility-hormone-e3g Type: number When: any	E3G Estrone-3-glucuronide concentration in urine - µg/L	streamId: body-urine-hormones-e3g eventType(s): concentration/ug-l version: v1
fertility-hormone-fsh Type: number When: any	FSH Follicle Stimulating Hormone concentration in urine - IU/L	streamId: body-urine-hormones-fsh eventType(s): concentration/iu-l version: v1
fertility-hormone-hcg Type: number When: any	hCG Human Chorionic Gonadotropin concentration in urine - IU/L	streamId: body-urine-hormones-hcg eventType(s): concentration/iu-l version: v1
fertility-hormone-lh Type: number When: any	LH Luteinizing Hormone concentration in urine - mg/L	streamId: body-urine-hormones-lh eventType(s): concentration/mg-l version: v1
fertility-hormone-pdg Type: number When: any	PdG Pregnanediol-3-glucuronide concentration in urine - IU/L	streamId: body-urine-hormones-pdg eventType(s): concentration/iu-l version: v1
fertility-miscarriages-count Type: number When: once	Nb of miscarriages Number of total miscarriages at this date	streamId: fertility-miscarriages eventType(s): count/generic version: temporary
fertility-pregnancy Type: select When: any	Pregnancy Pregnancy ongoing: Ongoing pregnangcymiscarriage: Miscarriageectopic: Ectopicstillbirth: Stillbirthlivebirth: Live birthabortion: Abortion One per fetus. (can be multiple with same start date) The value of `event.time` should indicate the start of pregnancy. When content value is 'ongoing' `event.duration` must be set to `null`. For any other value `event.duration` should be set to indicate when the pregnancy state terminated.	streamId: fertility-preganancies eventType(s): pregnancy/detailed version: v1
fertility-sexual-activity Type: select When: any	Sexual activity Potentially reproductive sexual activity fertile: Fertile intercourseincomplete: No ejaculation (incomplete)withdrawal: Withdrawal before ejaculationcondom: Usage of a condomcervical-barrier: Usage of a cervical barrierprotected: Protected intercourse (unspecified method)	streamId: fertility-sexual-activity eventType(s): reproductive-sexuality/detailed version: v1
fertility-test-opk Type: number When: any	Ovulation test (OPK) Ovulation Predictor Kit result. Uses test-result/scale (-1 negative, 0 indeterminate, 1 positive). Intermediate values for semi-quantitative results (e.g. 0.5 weak positive).	streamId: fertility-test-opk eventType(s): test-result/scale version: v1
fertility-test-pregnancy Type: number When: any	Pregnancy test Home pregnancy test result. Uses test-result/scale (-1 negative, 0 indeterminate, 1 positive).	streamId: fertility-test-pregnancy eventType(s): test-result/scale version: v1
fertility-ttc-tta Type: select When: P1D	Trying to conceive / Avoiding pregnancy Current fertility intention 0: TTA - Not taking risks. Would take all available measures to end a pregnancy.1: TTA - Not taking risks. Would strongly consider placing baby for adoption.2: TTA - Not taking risks. Would need some time, maybe counseling. Ultimately keeping the pregnancy.4: TTA - Not taking risks. Currently content with family size but a surprise pregnancy would be welcome.5: TTW/TTA - "Loosely TTA" known risks are taken in the fertile window. "OOPS" pregnancy would be welcome.6: TTW - Charting only for health/curiosity. Unprotected intercourse happens whenever. Pregnancy very welcome.7: TTW/TTC - Pregnancy very welcome (moving up the scale in very near future).8: TTC - "Excited to start/grow a family TTC" Intentional intercourse every cycle. Excited to start/grow a family. But would not use any fertility treatments if needed.9: TTC - "Highly hopeful TTC" Intentional intercourse every cycle. Would consider some but not all fertility treatments if needed.10: TTC - " Seriously TTC" Intentional intercourse every cycle. Would pursue any/ALL fertility treatments or procedures if needed.	streamId: fertility-ttc-tta eventType(s): ratio/generic version: v1
medication-intake-basic Type: composite When: unlimited	Medication Intake Basic Free-text medication intake with optional dose and route. Content has an 'intake' sub-object following the same structure as medication/coded-v1.	streamId: medication-intake eventType(s): medication/basic version: v2
medication-intake-coded Type: datasource-search When: unlimited	Medication Intake (coded) Search and select a coded medication from datasets service	streamId: medication-intake eventType(s): medication/coded-v1 version: v1
medication-prescription-coded Type: datasource-search When: unlimited	Medication Prescription (coded) Doctor-prescribed medication with dosage and frequency	streamId: medication-prescription eventType(s): medication/prescription-v1 version: v1
nutrition-appetite Type: select When: P1D	Appetite Self-reported appetite level. 0.25: Decreased0.5: Normal0.75: Increased	streamId: nutrition-appetite eventType(s): ratio/proportion version: v1
profile-addresscountry Type: text When: once	Country Country of living	streamId: profile-address eventType(s): contact/country version: temporary
profile-avatar Type: picture When: once	Avatar Profile picture (picture/attached, picture/base64, or picture/url)	streamId: profile-avatar eventType(s): (Format): picture/attached, picture/base64, picture/url version: v1
profile-date-of-birth Type: date When: once	Date of Birth Date of birth	streamId: profile-date-of-birth eventType(s): date/iso-8601 version: v1
profile-display-name Type: text When: once	Display Name Preferred display name	streamId: profile-display-name eventType(s): contact/display-name version: v1
profile-name Type: text When: once	Name Name	streamId: profile-name eventType(s): contact/name version: temporary
profile-sex Type: select When: once	Sex Biological Sex male: Malefemale: Female	streamId: profile-sex eventType(s): attributes/biological-sex version: v1
profile-surname Type: text When: once	Surname Surname	streamId: profile-name eventType(s): contact/surname version: temporary
symptom-dermatological-hair-growth Type: checkbox When: unlimited	Excess Hair Growth Unusual body or facial hair growth (hirsutism).	streamId: symptom-dermatological-hair-growth eventType(s): activity/plain version: v1
symptom-dermatological-hair-loss Type: checkbox When: unlimited	Hair Loss Noticeable hair loss or thinning.	streamId: symptom-dermatological-hair-loss eventType(s): activity/plain version: v1
symptom-gastrointestinal-bloating Type: checkbox When: unlimited	Bloating Abdominal bloating or distension.	streamId: symptom-gastrointestinal-bloating eventType(s): activity/plain version: v1
symptom-gastrointestinal-constipation Type: checkbox When: unlimited	Constipation Difficulty with bowel movements or infrequent stools.	streamId: symptom-gastrointestinal-constipation eventType(s): activity/plain version: v1
symptom-gastrointestinal-cramps Type: checkbox When: unlimited	Cramps Abdominal or pelvic cramps.	streamId: symptom-gastrointestinal-cramps eventType(s): activity/plain version: v1
symptom-gastrointestinal-cravings Type: checkbox When: unlimited	Cravings Food cravings or increased appetite for specific foods.	streamId: symptom-gastrointestinal-cravings eventType(s): activity/plain version: v1
symptom-gastrointestinal-diarrhea Type: checkbox When: unlimited	Diarrhea Loose or watery stools.	streamId: symptom-gastrointestinal-diarrhea eventType(s): activity/plain version: v1
symptom-gastrointestinal-gas Type: checkbox When: unlimited	Gas Intestinal gas or flatulence.	streamId: symptom-gastrointestinal-gas eventType(s): activity/plain version: v1
symptom-gastrointestinal-nausea Type: checkbox When: unlimited	Nausea Feeling of nausea or urge to vomit.	streamId: symptom-gastrointestinal-nausea eventType(s): activity/plain version: v1
symptom-general-fatigue Type: checkbox When: unlimited	Fatigue Low energy, tiredness, or exhaustion.	streamId: symptom-general-fatigue eventType(s): activity/plain version: v1
symptom-metabolic-water-retention Type: checkbox When: unlimited	Water Retention Fluid retention, swelling, or edema.	streamId: symptom-metabolic-water-retention eventType(s): activity/plain version: v1
symptom-neurological-dizziness Type: checkbox When: unlimited	Dizziness Sensation of lightheadedness or unsteadiness.	streamId: symptom-neurological-dizziness eventType(s): activity/plain version: v1
symptom-pain-backache Type: checkbox When: unlimited	Backache Back pain, lower or general.	streamId: symptom-pain-backache eventType(s): activity/plain version: v1
symptom-pain-headache Type: checkbox When: unlimited	Headache Head pain, tension-type or unspecified.	streamId: symptom-pain-headache eventType(s): activity/plain version: v1
symptom-pain-migraine Type: checkbox When: unlimited	Migraine Migraine headache, typically with throbbing pain, may include aura, nausea, or light sensitivity.	streamId: symptom-pain-migraine eventType(s): activity/plain version: v1
symptom-pain-sore-breasts Type: checkbox When: unlimited	Sore Breasts Breast pain or tenderness.	streamId: symptom-pain-sore-breasts eventType(s): activity/plain version: v1
symptom-sleep-insomnia Type: checkbox When: unlimited	Insomnia Difficulty falling or staying asleep.	streamId: symptom-sleep-insomnia eventType(s): activity/plain version: v1
wellbeing-mood Type: composite When: unlimited	Mood How you feel — pleasantness, energy, sense of control, and more.	streamId: wellbeing-mood eventType(s): mood/5d-vectors version: v2
wellbeing-sex-drive Type: select When: P1D	Sex Drive Self-reported sex drive level. 0.25: Low0.5: Neutral0.75: High	streamId: wellbeing-sex-drive eventType(s): ratio/proportion version: v1