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

HDS STREAMS TREE

---

Items

Id & Type	Description	streamId & eventType
body-height Type: number When: any	Body height Measured body height	streamId: body-height eventType(s): length/m, length/ft version: temporary
body-vulva-bleeding Type: select When: any	Bleeding type Bleeding type subjective 0: None1: Spotting2: Light3: Medium4: Heavy	streamId: body-vulva-bleeding eventType(s): ratio/generic version: v1
body-vulva-bleeding-browndark Type: checkbox When: daily	Brown coloration of bleeding Brown coloration of bleeding	streamId: body-vulva-bleeding-browndark eventType(s): activity/plain version: temporary
body-vulva-mucus-inspect Type: select When: any	Cervical Fluid Inspect Visual aspect of cervical fluid inspection clear: Clearcreamy: Creamydry-sticky: Dry & Stickyegg-white: Egg White	streamId: body-vulva-mucus-inspect eventType(s): vulva-mucus-inspect/v0 version: v1
body-vulva-mucus-stretch Type: select When: any	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: any	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: any	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: any	Body weight Measured body weight	streamId: body-weight eventType(s): mass/kg, mass/lb version: temporary
family-children-count Type: number When: none	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: none	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-ovulation Type: checkbox When: daily	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: daily	Peak day of fertility When fertility is at its highest point	streamId: fertility-cycles-peak-day eventType(s): activity/plain version: temporary
fertility-cycles-start Type: checkbox When: daily	New Cycle Flag this day as a new cycle start	streamId: fertility-cycles-start eventType(s): activity/plain version: temporary
fertility-miscarriages-count Type: number When: none	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 barrier	streamId: fertility-sexual-activity eventType(s): reproductive-sexuality/detailed version: v1
fertility-ttc-tta Type: select When: daily	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
profile-addresscountry Type: text When: none	Country Country of living	streamId: profile-address eventType(s): contact/country version: temporary
profile-date-of-birth Type: date When: none	Date of Birth Date of birth	streamId: profile-date-of-birth eventType(s): date/iso-8601 version: v1
profile-name Type: text When: none	Name Name	streamId: profile-name eventType(s): contact/name version: temporary
profile-sex Type: select When: none	Sex Biological Sex male: Malefemale: Female	streamId: profile-sex eventType(s): attributes/biological-sex version: v1
profile-surname Type: text When: none	Surname Surname	streamId: profile-name eventType(s): contact/surname version: temporary