Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/jsonBrowser/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,10 @@ Location: module/biomaterial/medical_history.json

Property name | Description | Type | Required? | Object reference? | User friendly name | Allowed values | Example
--- | --- | --- | --- | --- | --- | --- | ---
alcohol_history | Estimated amount of alcohol consumed per day. | string | no | | Alcohol history | | 3-6 alcohol units/day; 1 drink per day
alcohol_status | Does the donor have drink/ drank/ never drank alcohol? | string | no | | Alcohol status | active, former, never | Should be one of: active, former, never.
alcohol_type | Types of alcoholic beverages the donor consumed. | array | no | | Alcohol type | | beer; liquor; wine
alcohol_units | Alcohol consumption of donor in alcohol units per week (strength (ABV) x volume (ml) ÷ 1,000). | number | no | | Alcohol units | | 2.5; 15.2; 23
alcohol_usage_duration | Number of years the donor has used any alcohol. | integer | no | | Alcohol usage duration | | 5
medication | Medication(s) the individual was taking at time of biomaterial collection. | array | no | [See module medication_ontology](module.md#medication-ontology) | Medication | |
smoking_status | Whether the individual is actively, was formerly or never consumed smoking tobacco products like cigarettes, cigars, pipe etc. | string | no | | Smoking status | active, former, never | Should be one of: active, former, never.
smoking_pack_years | Estimated number of packs (20 cigarettes) smoked per day multiplied by the number of years the individual was smoking. | number | no | | Smoking pack years | | 4.55
Expand Down
37 changes: 32 additions & 5 deletions json_schema/module/biomaterial/medical_history.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,39 @@
"pattern": "^[0-9]{1,}.[0-9]{1,}.[0-9]{1,}$",
"example": "4.6.1"
},
"alcohol_history": {
"description": "Estimated amount of alcohol consumed per day.",
"alcohol_status": {
"description": "Does the donor have drink/ drank/ never drank alcohol?",
"type": "string",
"user_friendly": "Alcohol history",
"example": "3-6 alcohol units/day; 1 drink per day",
"guidelines": "Enter the amount consumed per day using units such as alcohol units (10mL or 8g of alcohol) or drinks (14g of alcohol)."
"enum": [
"active",
"former",
"never"
],
"user_friendly": "Alcohol status",
"example": "Should be one of: active, former, never."
},
"alcohol_type": {
"description": "Types of alcoholic beverages the donor consumed.",
"type": "array",
"items": {
"type": "string"
},
"user_friendly": "Alcohol type",
"example": "beer; liquor; wine"
},
"alcohol_units": {
"description": "Alcohol consumption of donor in alcohol units per week (strength (ABV) x volume (ml) ÷ 1,000).",
"type": "number",
"user_friendly": "Alcohol units",
"minimum": 0,
"example": "2.5; 15.2; 23"
},
"alcohol_usage_duration": {
"description": "Number of years the donor has used any alcohol.",
"type": "integer",
"user_friendly": "Alcohol usage duration",
"minimum": 0,
"example": 5
},
"medication": {
"description": "Medication(s) the individual was taking at time of biomaterial collection.",
Expand Down
2 changes: 2 additions & 0 deletions json_schema/update_log.csv
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Schema,Change type,Change message,Version,Date
module/biomaterial/medical_history.json,major,Deprecate alcohol_history,,
module/biomaterial/medical_history.json,minor,Added alcohol consumption details,,
Loading