Skip to content

Commit 24bd871

Browse files
authored
Merge pull request #1638 from HumanCellAtlas/iz-adipose-tier2
Adds Adipose tier2 fields
2 parents b1a6be2 + 860f606 commit 24bd871

16 files changed

Lines changed: 663 additions & 33 deletions

changelog.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,90 @@ and (starting with v4.0.0) this project adheres to [Semantic Versioning](http://
77

88
## [Unreleased](https://github.com/HumanCellAtlas/metadata-schema/tree/staging)
99

10+
### [module/biomaterial/medical_history.json - v9.5.0] - 2026-04-02
11+
### Added
12+
Added fasting_time, blood_test
13+
14+
### [module/biomaterial/reproductive_history.json - v1.4.0] - 2026-04-02
15+
### Added
16+
Added menstrual_cycle_stage
17+
18+
### [module/biomaterial/lifestyle.json - v1.1.0] - 2026-04-02
19+
### Added
20+
Added physical_activity
21+
22+
### [module/biomaterial/human_specific.json - v2.1.0] - 2026-04-02
23+
### Added
24+
Added waist_circumference, waist_hip_ratio, lifestyle
25+
26+
### [module/biomaterial/blood_test.json - v1.1.0] - 2026-04-02
27+
### Added
28+
Added androstenedione, androstenedione_unit, dhea, dhea_unit, estrogen, estrogen_unit, fasting_glucose, fasting_glucose_unit, fasting_insulin, fasting_insulin_unit, free_fatty_acid, free_fatty_acid_unit, haematocrit, haematocrit_unit, haemoglobin, haemoglobin_unit, hba1c, hba1c_unit, hdl, hdl_unit, homa_ir, ldl, ldl_unit, platelet_count, platelet_count_unit, shbg, shbg_unit, testosterone, testosterone_unit, triglycerides, triglycerides_unit, white_blood_cell_count, white_blood_cell_count_unit, bloodtest_time_offset
29+
30+
### [type/protocol/biomaterial_collection/collection_protocol.json - v9.5.0] - 2026-04-02
31+
### Added
32+
Added biopsy_procedure
33+
34+
### [type/protocol/sequencing/library_preparation_protocol.json - v6.5.0] - 2026-04-02
35+
### Added
36+
Added processing_time
37+
38+
### [type/biomaterial/cell_suspension.json - v14.3.0] - 2026-04-02
39+
### Added
40+
Added nuclei_yield
41+
42+
### [type/biomaterial/specimen_from_organism.json - v11.3.0] - 2026-04-02
43+
### Added
44+
Added time_to_laboratory, experimental_condition
45+
46+
### [module/biomaterial/human_specific.json - v3.0.0] - 2026-04-02
47+
### Changed
48+
Changed body_mass_index to string
49+
50+
### [module/biomaterial/blood_test.json - v2.0.0] - 2026-04-02
51+
### Added
52+
Added new blood_test module
53+
54+
### [module/biomaterial/lifestyle.json - v2.0.0] - 2026-04-02
55+
### Added
56+
Added new lifestyle module
57+
58+
### [module/ontology/file_content_ontology.json - v4.0.0] - 2026-04-02
59+
### Fixed
60+
Fixed class and example for EDAM ontology
61+
62+
### [module/ontology/file_format_ontology.json - v3.0.0] - 2026-04-02
63+
### Fixed
64+
Fixed class and example for EDAM ontology
65+
66+
### [type/biomaterial/donor_organism.json - v18.7.0] - 2026-04-02
67+
### Added
68+
Added fasting_time, blood_test
69+
70+
### [core/file/file_core.json - v9.0.0] - 2026-04-02
71+
### Fixed
72+
Fixed class and example for EDAM ontology
73+
74+
### [type/file/supplementary_file.json - v5.0.0] - 2026-04-02
75+
### Fixed
76+
Fixed class and example for EDAM ontology
77+
78+
### [type/file/sequence_file.json - v12.0.0] - 2026-04-02
79+
### Fixed
80+
Fixed class and example for EDAM ontology
81+
82+
### [type/file/reference_file.json - v6.0.0] - 2026-04-02
83+
### Fixed
84+
Fixed class and example for EDAM ontology
85+
86+
### [type/file/image_file.json - v5.0.0] - 2026-04-02
87+
### Fixed
88+
Fixed class and example for EDAM ontology
89+
90+
### [type/file/analysis_file.json - v10.0.0] - 2026-04-02
91+
### Fixed
92+
Fixed class and example for EDAM ontology
93+
1094
## [Released](https://github.com/HumanCellAtlas/metadata-schema/)
1195

1296
### [type/biomaterial/specimen_from_organism.json - v11.1.1] - 2026-02-09

docs/jsonBrowser/module.md

Lines changed: 60 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Location: module/ontology/file_content_ontology.json
5757
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
5858
--- | --- | --- | --- | --- | --- | --- | ---
5959
text | General description of the contents of the file. | string | yes | | Content description | | DNA sequence (raw); Sequence alignment
60-
ontology | An ontology term identifier in the form prefix:accession. | string | no | | Content description ontology ID | | EDAM:3494; EDAM:0863
60+
ontology | An ontology term identifier in the form prefix:accession. | string | no | | Content description ontology ID | | EDAM:data_3494; EDAM:data_0863
6161
ontology_label | The preferred label for the ontology term referred to in the ontology field. This may differ from the user-supplied value in the text field. | string | no | | Content description ontology label | | DNA sequence; Sequence alignment
6262

6363
## Length unit ontology<a name='Length unit ontology'></a>
@@ -244,7 +244,7 @@ Location: module/ontology/file_format_ontology.json
244244
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
245245
--- | --- | --- | --- | --- | --- | --- | ---
246246
text | The name of the file format. | string | yes | | File format | | FASTQ; JSON
247-
ontology | An ontology term identifier in the form prefix:accession. | string | no | | File format ontology ID | | EDAM:1930; EDAM:3464
247+
ontology | An ontology term identifier in the form prefix:accession. | string | no | | File format ontology ID | | EDAM:format_1930; EDAM:format_3464
248248
ontology_label | The preferred label for the ontology term referred to in the ontology field. This may differ from the user-supplied value in the text field. | string | no | | File format ontology label | | FASTQ; JSON
249249

250250
## Enrichment ontology<a name='Enrichment ontology'></a>
@@ -430,14 +430,17 @@ Location: module/biomaterial/human_specific.json
430430

431431
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
432432
--- | --- | --- | --- | --- | --- | --- | ---
433-
body_mass_index | The body mass index of the donor. | number | no | | Body mass index | | 36.4
433+
body_mass_index | The body mass index of the donor. | string | no | | Body mass index | | 36.4; 29-32
434+
waist_circumference | Waist circumference of the donor at the time of collection measured in cm. | string | no | | Waist circumference | | 60; 85-95; 153
435+
waist_hip_ratio | Waist-hip ratio of the donor at the time of collection. | string | no | | Waist-hip ratio | | 0.85; 0.85-0.91; 0.88
434436
ethnicity | Ethnicity of the donor. | array | no | [See module ethnicity_ontology](module.md#ethnicity-ontology) | Ethnicity | |
435437
ethnicity_question | Question and response options posed to donors for collecting metadata on donor self-reported ethnicity and / or tribe and / or dialect group and / or race etc. | string | no | | Ethnicity question | | What is your ethnicity?; Are you Hispanic/Latino?; Which categories describe you? Select all that apply. Note You may select more than one group. 1. American Indian or Alaska Native (for example, Aztec, Blackfeet Tribe, Mayan, Navajo Nation, Native Village of Barrow (Utqiagvik) Inupiat Traditional Government, Nome Eskimo Community, etc.), 2 - Asian (for example, Asian Indian, Chinese, Filipino, Japanese, Korean, Vietnamese, etc.), 3 - Black, African American, or African (for example, African American, Ethiopian, Haitian, Jamaican, Nigerian, Somali, etc.), 4 - Hispanic, Latino, or Spanish (for example, Columbian, Cuban, Dominican, Mexican or Mexican American, Puerto Rican, Salvadoran, etc.), 5 - Middle Eastern or North African (for example, Algerian, Egyptian, Iranian, Lebanese, Moroccan, Syrian, etc.), 6 - Native Hawaiian or other Pacific Islander (for example, Chamorro, Fijian, Marshallese, Native Hawaiian, Tongan, etc.), 7 - White (for example, English, European, French, German, Irish, Italian, Polish, etc.), 8 - None of these fully describe me (optional free text answer), 9 - Prefer not to answer
436438
ethnicity_of_parents | Ethnicity(-ies) of the donor's parents. | array | no | [See module ethnicity_ontology](module.md#ethnicity-ontology) | Parents ethnicity | |
437439
primary_language | Primary language(s), spoken by donor. Can include dialects (for example, Hokkien). | array | no | | Donor primary language | | Mandarin Chinese; Hokkien; Bahasa Melayu
438440
language_of_family | Ancestral language(s), spoken by parents (“mother tongue” and / or “father tongue”) and / or grandparents or any other person in the donor family. Can include dialects (for example, Hokkien). | array | no | | Language of family | | Mandarin Chinese; Hokkien; Bahasa Melayu
439441
current_residence | Donor's current residence at time of sample collection. | object | no | [See module residence](module.md#residence) | Current residence | |
440442
place_of_birth | Donor's place of birth residence. | object | no | [See module residence](module.md#residence) | Place of birth | |
443+
lifestyle | Lifestyle and habits of the donor. | object | no | [See module lifestyle](module.md#lifestyle) | Lifestyle | |
441444

442445
## Growth conditions<a name='Growth conditions'></a>
443446
_Information relating to how a biomaterial was grown and/or maintained in a laboratory setting._
@@ -524,6 +527,7 @@ Location: module/biomaterial/reproductive_history.json
524527
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
525528
--- | --- | --- | --- | --- | --- | --- | ---
526529
menarche_age | Age at menarche, rounded to nearest whole number. | integer | no | | Menarche age | | 13; 12; 16
530+
menstrual_cycle_stage | Menstrual cycle stage of donor at the time of collection. | string | no | | Menstrual cycle stage | follicular phase, ovulation, luteal phase, menstruation | follicular phase; ovulation; luteal phase; menstruation
527531
menopause_status | Menopausal status of donor at time of sample collection. | string | no | | Menopause status | pre-menopausal, peri-menopausal, post-menopausal, post-menopausal (induced) | pre-menopausal; peri-menopausal; post-menopausal; post-menopausal (induced)
528532
parity | Number of children (full-term pregnancies) the donor has given birth to at time of sample collection. | integer | no | | Full term pregnancy - parity | | 0; 2; 3
529533
gravidity | Number of pregnancies the donor has had at time of sample collection. | integer | no | | Pregnancy - gravidity | | 2; 3; 5
@@ -540,6 +544,15 @@ storage_time | Length of time the biomaterial was stored for in Storage time uni
540544
storage_time_unit | The unit in which Storage time is expressed. | object | no | [See module time_unit_ontology](module.md#time-unit-ontology) | Storage time unit | |
541545
preservation_method | The method by which a biomaterial was preserved through the use of chemicals, cold, or other means to prevent or retard biological or physical deterioration. | string | no | | Preservation method | cryopreservation in liquid nitrogen (dead tissue), cryopreservation in dry ice (dead tissue), cryopreservation of live cells in liquid nitrogen, cryopreservation, other, formalin fixed, unbuffered, formalin fixed, buffered, formalin fixed and paraffin embedded, hypothermic preservation media at 2-8C, fresh | cryopreservation in liquid nitrogen (dead tissue); fresh
542546

547+
## Lifestyle<a name='Lifestyle'></a>
548+
_Lifestyle and habits of the donor._
549+
550+
Location: module/biomaterial/lifestyle.json
551+
552+
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
553+
--- | --- | --- | --- | --- | --- | --- | ---
554+
physical_activity | The habitual level of physical activity and regular physical activities. | string | no | | Physical activity | | active - football, tennis; sedentary
555+
543556
## Death<a name='Death'></a>
544557
_Information relating to the death of an organism._
545558

@@ -585,14 +598,58 @@ household_smoking_exposure | If the donor is exposed to passive smoking in their
585598
vaping_status | Whether the individual is actively, was formerly or never vaped. | string | no | | Vaping status | active, former, never | Should be one of: active, former, never.
586599
marijuana_inhaled_status | Whether the individual is actively, was formerly or never inhaled/smoked marijuana. | string | no | | Inhaled marijuana status | active, former, never | Should be one of: active, former, never.
587600
nutritional_state | Nutritional state of individual at time of biomaterial collection. | string | no | | Nutritional state | normal, fasting, feeding tube removed | Should be one of: normal, fasting, or feeding tube removed.
601+
fasting_time | Duration of the donor's fasting period (in hours) prior to sample collection. | integer | no | | Fasting time | | 2; 5; 8
588602
diet_meat_consumption | Dietary patterns of donor - meat (chicken, seafood, fish, pork, lamb, beef, etc.) consumption versus meat-free diet - at time of sample collection. Fill yes if donor consumes meat or no if donor does not consumes meat. | boolean | no | | Meat consumption | | Should be one of: yes; no.
589603
reproductive_history | Reproductive history of the donor at the time of collection. | object | no | [See module reproductive_history](module.md#reproductive-history) | Reproductive history | |
604+
blood_test | Results from blood tests performed on the individual. | object | no | [See module blood_test](module.md#blood-test) | Blood tests | |
590605
test_results | Results from medical tests performed on the individual. | string | no | | Test results | | lipid panel shows normal level of LDL (124 mg/dL); HIV, HBV, HCV: Negative
591606
treatment | Treatments the individual has undergone prior to biomaterial collection. | string | no | | Treatments | | Patient treated with antibiotics for a urinary tract infection; Patient treated with chemotherapy (Epirubicin, cisplatin, capecitabine) to treat stomach cancer
592607
previous_surgeries | Previous surgeries the individual has undergone prior to biomaterial collection. | string | no | | Previous surgeries | | Appendectomy; Coleostomy; Vaginoplasty; LASIK; Abdominal surgery
593608
defined_diet | Whether the individual was following a defined diet at the time of biomaterial collection. | boolean | no | | Defined diet | | yes; no
594609
diet_specific | Defined diet the donor was on at the time of biomaterial collection. | array | no | | Diet Specific | vegan, vegetarian, omnivore, gluten_free, fodmap, baby_formula, breastfeeding, elimination, keto, paleo | gluten_free; fodmap; baby_formula; breastfeeding; elimination; keto; paleo
595610

611+
## Blood test<a name='Blood test'></a>
612+
_Blood test results of the donor._
613+
614+
Location: module/biomaterial/blood_test.json
615+
616+
Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
617+
--- | --- | --- | --- | --- | --- | --- | ---
618+
androstenedione | Androstenedione in the last blood test of the donor before collection. | number | no | | Androstenedione | | 0.7; 3.4; 2.41
619+
androstenedione_unit | Androstenedione unit. | string | no | | Androstenedione unit | ng/dL, nmol/L | ng/dL; nmol/L
620+
dhea | Dehydroepiandrosterone (DHEA) in the last blood test of the donor before collection. | number | no | | DHEA | | 240; 3500; 1500
621+
dhea_unit | DHEA unit. | string | no | | DHEA unit | ng/dL, nmol/L | ng/dL; nmol/L
622+
estrogen | Estrogen in the last blood test of the donor before collection. | number | no | | Estrogen | | 10; 150; 120
623+
estrogen_unit | Estrogen unit. | string | no | | Estrogen unit | pg/mL, pmol/L | pg/mL; pmol/L
624+
fasting_glucose | Fasting glucose levels from the donor's last blood test after at least 8 hours of fasting, prior to the biopsy collection. | number | no | | Fasting glucose | | 70; 125; 90.2
625+
fasting_glucose_unit | Fasting glucose unit. | string | no | | Fasting glucose unit | mg/dL, mmol/L | mg/dL; mmol/L
626+
fasting_insulin | Fasting insulin levels from the donor's last blood test after at least 8 hours of fasting, prior to the biopsy collection. | number | no | | Fasting insulin | | 2; 20; 14
627+
fasting_insulin_unit | Fasting insulin unit. | string | no | | Fasting insulin unit | μU/mL, pmol/L | μU/mL; pmol/L
628+
free_fatty_acid | Free Fatty Acid (FFA) in the last blood test of the donor before collection. | number | no | | FFA | | 0.1; 0.6; 0.24
629+
free_fatty_acid_unit | Free Fatty Acid (FFA) unit. | string | no | | FFA unit | mmol/L | mmol/L
630+
haematocrit | Percentage of red blood cells in whole blood from the donor's last blood test prior to biopsy collection. | number | no | | Haematocrit | | 36; 54; 45
631+
haematocrit_unit | Haematocrit unit. | string | no | | Haematocrit unit | percentage (%) | %
632+
haemoglobin | Concentration of haemoglobin in whole blood from the donor's last blood test prior to biopsy collection. | number | no | | Haemoglobin | | 12; 17.5; 14.2
633+
haemoglobin_unit | Haemoglobin unit. | string | no | | Haemoglobin unit | g/dL, mmol/L | g/dL; mmol/L
634+
hba1c | Concentration of glycated hemoglobin (HbA1c) from the donor's last blood test prior to biopsy collection. | number | no | | HbA1c | | 42; 58; 53.3
635+
hba1c_unit | HbA1c unit. | string | no | | HbA1c unit | mmol/mol, % | mmol/mol; %
636+
hdl | High-density lipoprotein cholesterol (HDL) in the last blood test of the donor before collection. | number | no | | HDL | | 40; 60; 92
637+
hdl_unit | HDL unit. | string | no | | HDL unit | mg/dL, mmol/L | mg/dL; mmol/L
638+
homa_ir | Homeostatic Model Assessment of Insulin Resistance (HOMA-IR) in the last blood test of the donor before collection. | number | no | | HOMA-IR | | 0.4; 1.2; 0.94
639+
ldl | Low-density lipoprotein cholesterol (LDL) in the last blood test of the donor before collection. | number | no | | LDL | | 160; 133
640+
ldl_unit | LDL unit. | string | no | | LDL unit | mg/dL, mmol/L | mg/dL; mmol/L
641+
platelet_count | Measurement of platelets per unit volume of blood from the donor's last blood test prior to biopsy collection | number | no | | Platelet count | | 240; 124; 110
642+
platelet_count_unit | Platelet count unit. | string | no | | Platelet count unit | 10^9/L, cells/μL | 10^9/L; cells/μL
643+
shbg | Sex hormone binding globulin (SHBG) in the last blood test of the donor before collection. | number | no | | SHBG | | 10; 140; 72
644+
shbg_unit | SHBG unit. | string | no | | SHBG unit | nmol/L | nmol/L
645+
testosterone | Testosterone in the last blood test of the donor before collection. | number | no | | Testosterone | | 15; 1000; 420
646+
testosterone_unit | Testosterone unit. | string | no | | Testosterone unit | nmol/L, ng/dL | nmol/L; ng/dL
647+
triglycerides | Triglycerides levels from the donor's last blood test after at least 9-12 hours of fasting, prior to the biopsy collection. | number | no | | Triglycerides | | 160; 133; 140
648+
triglycerides_unit | Triglycerides unit. | string | no | | Triglycerides unit | mg/dL, mmol/L | mg/dL; mmol/L
649+
white_blood_cell_count | Measurement of total white blood cells per unit volume of blood from the donor's last blood test prior to biopsy collection. | number | no | | White cell count | | 4.5; 11; 9.24
650+
white_blood_cell_count_unit | White cell count unit. | string | no | | White cell count unit | 10^9/L, cells/μL | 10^9/L; cells/μL
651+
bloodtest_time_offset | Time between the test and the collection of the sample, in days. | number | no | | Blood test time offset | | 12; 42; 98
652+
596653
## Residence<a name='Residence'></a>
597654
_Donor's residence location information._
598655

docs/jsonBrowser/required_fields.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,8 @@ _There are no required properties in schema Disease profile_
370370
_There are no required properties in schema Reproductive history_
371371
### Preservation and storage<a name='Preservation and storage'></a>
372372
_There are no required properties in schema Preservation and storage_
373+
### Lifestyle<a name='Lifestyle'></a>
374+
_There are no required properties in schema Lifestyle_
373375
### Death<a name='Death'></a>
374376
Property name | Description | Type | Object reference? | User friendly name | Allowed values | Example
375377
--- | --- | --- | --- | --- | --- | ---
@@ -378,6 +380,8 @@ cause_of_death | Conditions resulting in death. | string | | Cause of death |
378380
_There are no required properties in schema Familial relationship_
379381
### Medical history<a name='Medical history'></a>
380382
_There are no required properties in schema Medical history_
383+
### Blood test<a name='Blood test'></a>
384+
_There are no required properties in schema Blood test_
381385
### Residence<a name='Residence'></a>
382386
_There are no required properties in schema Residence_
383387
### Cell morphology<a name='Cell morphology'></a>

0 commit comments

Comments
 (0)