Medication step1

perki · perki · commit d3f35a40fb50 · 2025-10-08T14:51:00.000+02:00
diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@ Defines the initial version of stream structures and event types for a common mo
 
 ## Functional Requirements Specifications
 
-| Date             | 16th September 2025 |
+| Date             | 29th September 2025 |
 | ---------------- | ------------- |
-| Document Version | 0.3           |
+| Document Version | 0.4           |
 | Status           | Draft         |
 |                  |               |
 
@@ -69,6 +69,14 @@ Note: all textual descriptions and labels should be translatable. market with a
   - Some data may be taken with different variations and context
   - [SNOWMED CT](https://bioportal.bioontology.org/ontologies/SNOMEDCT)
   - [LOINC (BODY WEIGHT)](https://loinc.org/LG34372-9)
+
+- Medications code list
+  - ATC: https://atcddd.fhi.no/atc_ddd_index/
+  - HCPCS: https://www.aapc.com/codes/hcpcs-codes-range/ 
+  - SCTID: https://browser.ihtsdotools.org/?perspective=full&conceptId1=404684003&edition=MAIN/2025-09-01&release=&languages=en
+  - UNII: https://precision.fda.gov/uniisearch
+  - Frequency Fhir: https://build.fhir.org/ig/HL7/CDA-Examples/medicationfrequency.html
+
   
 - Source of the data
   The origin of the data will be given by `createdBy` and `modifiedBy` . Still this may not be sufficient 
diff --git a/definitions/eventTypes/eventTypes-hds.json b/definitions/eventTypes/eventTypes-hds.json
@@ -45,6 +45,42 @@
         "livebirth",
         "abortion"
       ]
-    }
+    },
+    "medication/basic": {
+      "description": "Simple medication based on name and eventual coding",
+      "type": "object",
+      "required": ["label"],
+      "properties": {
+        "name": {
+          "description": "The name of product",
+          "type": "string"
+        },
+        "doseMg": {
+          "description": "The dosage in milligrams",
+          "type": "number"
+        },
+        "frequencyHours": {
+          "description": "Frequency in Hours. If non null, 'event.duration' should reflect the full period, otherwise it reflects one intake",
+          "type": "number"
+        },
+        "codes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["system", "content"],
+            "properties": {
+              "system": {
+                "description": "The system code for HDS",
+                "type": "string"
+              },
+              "content": {
+                "description": "Accordingly to the norm, appropriate content for coding",
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    } 
   }
 }
diff --git a/definitions/items/fertility.yaml b/definitions/items/fertility.yaml
@@ -127,6 +127,3 @@ fertility-pregnancy:
       label: 'Live birth'
     - value: 'abortion'
       label: 'Abortion'
-
-    
-
diff --git a/definitions/items/medication.yaml b/definitions/items/medication.yaml
@@ -0,0 +1,20 @@
+medication-intake:
+  version: v1
+  label: Medication Intake
+  description: Medication Intake
+  streamId: medication-intake
+  eventType: medication/basic
+  type: composite
+  composite:
+    name: 
+      label: Name of the medication
+      type: text
+    doseMg:
+      label: Dosage in milligrams
+      type: number
+      canBeNull: true
+    frequencyHours:
+      label: Frequency in hours
+      type: number
+      canBeNull: true
+    
diff --git a/definitions/streams/medication.yaml b/definitions/streams/medication.yaml
@@ -0,0 +1,8 @@
+id: medication
+name: Medication
+parentId: null
+children:
+  - id: medication-intake
+    name: Intake
+  - id: medication-prescription
+    name: Prescriptions
diff --git a/docs/index.html b/docs/index.html
@@ -63,6 +63,7 @@ <h3>Items</h3>
 <tr><td><span style="font-weight: bold;" id="fertility-pregnancy">fertility-pregnancy</span><br><u>Type:</u> select<br><u>When:</u> any</td><td>Pregnancy<br>Pregnancy<BR><SELECT style="width: 20em"><OPTION>ongoing: Ongoing pregnangcy</OPTION><OPTION>miscarriage: Miscarriage</OPTION><OPTION>ectopic: Ectopic</OPTION><OPTION>stillbirth: Stillbirth</OPTION><OPTION>livebirth: Live birth</OPTION><OPTION>abortion: Abortion</OPTION></SELECT><BR><span style="font-style: italic; font-size: small">One per fetus. (can be multiple with same start date)<br>The value of `event.time` should indicate the start of pregnancy.<br>When content value is 'ongoing' `event.duration` must be set to `null`.<br>For any other value `event.duration` should be set to indicate when the pregnancy state terminated.</span></td><td><u>streamId:</u> fertility-preganancies<br><u>eventType(s):</u> pregnancy/detailed<br><u>version:</u> v1</td></tr>
 <tr><td><span style="font-weight: bold;" id="fertility-sexual-activity">fertility-sexual-activity</span><br><u>Type:</u> select<br><u>When:</u> any</td><td>Sexual activity<br>Potentially reproductive sexual activity<BR><SELECT style="width: 20em"><OPTION>fertile: Fertile intercourse</OPTION><OPTION>incomplete: No ejaculation (incomplete)</OPTION><OPTION>withdrawal: Withdrawal before ejaculation</OPTION><OPTION>condom: Usage of a condom</OPTION><OPTION>cervical-barrier: Usage of a cervical barrier</OPTION></SELECT></td><td><u>streamId:</u> fertility-sexual-activity<br><u>eventType(s):</u> reproductive-sexuality/detailed<br><u>version:</u> v1</td></tr>
 <tr><td><span style="font-weight: bold;" id="fertility-ttc-tta">fertility-ttc-tta</span><br><u>Type:</u> select<br><u>When:</u> daily</td><td>Trying to conceive / Avoiding pregnancy<br>Current fertility intention<BR><SELECT style="width: 20em"><OPTION>0: TTA - Not taking risks.  Would take all available measures to end a pregnancy.</OPTION><OPTION>1: TTA - Not taking risks.  Would strongly consider placing baby for adoption.</OPTION><OPTION>2: TTA - Not taking risks.  Would need some time, maybe counseling. Ultimately keeping the pregnancy.</OPTION><OPTION>4: TTA - Not taking risks.  Currently content with family size but a surprise pregnancy would be welcome.</OPTION><OPTION>5: TTW/TTA - "Loosely TTA" known risks are taken in the fertile window. "OOPS" pregnancy would be welcome.</OPTION><OPTION>6: TTW - Charting only for health/curiosity. Unprotected intercourse happens whenever. Pregnancy very welcome.</OPTION><OPTION>7: TTW/TTC - Pregnancy very welcome (moving up the scale in very near future).</OPTION><OPTION>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.</OPTION><OPTION>9: TTC - "Highly hopeful TTC" Intentional intercourse every cycle. Would consider some but not all fertility treatments if needed.</OPTION><OPTION>10: TTC - " Seriously TTC" Intentional intercourse every cycle. Would pursue any/ALL fertility treatments or procedures if needed.</OPTION></SELECT></td><td><u>streamId:</u> fertility-ttc-tta<br><u>eventType(s):</u> ratio/generic<br><u>version:</u> v1</td></tr>
+<tr><td><span style="font-weight: bold;" id="medication-intake">medication-intake</span><br><u>Type:</u> composite<br><u>When:</u> undefined</td><td>Medication Intake<br>Medication Intake</td><td><u>streamId:</u> medication-intake<br><u>eventType(s):</u> medication/basic<br><u>version:</u> v1</td></tr>
 <tr><td><span style="font-weight: bold;" id="profile-addresscountry">profile-addresscountry</span><br><u>Type:</u> text<br><u>When:</u> none</td><td>Country<br>Country of living</td><td><u>streamId:</u> profile-address<br><u>eventType(s):</u> contact/country<br><u>version:</u> temporary</td></tr>
 <tr><td><span style="font-weight: bold;" id="profile-date-of-birth">profile-date-of-birth</span><br><u>Type:</u> date<br><u>When:</u> none</td><td>Date of Birth<br>Date of birth</td><td><u>streamId:</u> profile-date-of-birth<br><u>eventType(s):</u> date/iso-8601<br><u>version:</u> v1</td></tr>
 <tr><td><span style="font-weight: bold;" id="profile-name">profile-name</span><br><u>Type:</u> text<br><u>When:</u> none</td><td>Name<br>Name</td><td><u>streamId:</u> profile-name<br><u>eventType(s):</u> contact/name<br><u>version:</u> temporary</td></tr>
diff --git a/docs/items.json b/docs/items.json
@@ -506,6 +506,40 @@
       }
     ]
   },
+  "medication-intake": {
+    "version": "v1",
+    "label": {
+      "en": "Medication Intake"
+    },
+    "description": {
+      "en": "Medication Intake"
+    },
+    "streamId": "medication-intake",
+    "eventType": "medication/basic",
+    "type": "composite",
+    "composite": {
+      "name": {
+        "label": {
+          "en": "Name of the medication"
+        },
+        "type": "text"
+      },
+      "doseMg": {
+        "label": {
+          "en": "Dosage in milligrams"
+        },
+        "type": "number",
+        "canBeNull": true
+      },
+      "frequencyHours": {
+        "label": {
+          "en": "Frequency in hours"
+        },
+        "type": "number",
+        "canBeNull": true
+      }
+    }
+  },
   "profile-addresscountry": {
     "version": "temporary",
     "label": {
diff --git a/docs/json-schemas/defs.json b/docs/json-schemas/defs.json
@@ -18,6 +18,15 @@
       "required": [
         "en"
       ]
+    },
+    "entryType": {
+      "enum": [
+        "number",
+        "text",
+        "select",
+        "checkbox",
+        "date"
+      ]
     }
   }
 }
diff --git a/docs/json-schemas/item.json b/docs/json-schemas/item.json
@@ -15,6 +15,9 @@
     "streamId": {
       "type": "string"
     },
+    "eventType": {
+      "type": "string"
+    },
     "repeatable": {
       "enum": [
         "any",
@@ -45,39 +48,17 @@
       "nullable": true
     },
     "type": {
-      "enum": [
-        "number",
-        "text",
-        "select",
-        "checkbox",
-        "date"
-      ]
-    },
-    "eventType": {
-      "type": "string"
-    },
-    "options": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "nullable": false,
-        "properties": {
-          "value": {
-            "type": [
-              "number",
-              "string"
-            ]
-          },
-          "label": {
-            "$ref": "defs.json#/definitions/localized"
-          }
+      "type": "string",
+      "oneOf": [
+        {
+          "$ref": "defs.json#/definitions/entryType"
         },
-        "required": [
-          "value",
-          "label"
-        ],
-        "additionalProperties": false
-      }
+        {
+          "enum": [
+            "composite"
+          ]
+        }
+      ]
     },
     "variations": {
       "type": "object",
@@ -89,12 +70,87 @@
       }
     }
   },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "select"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "options": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "nullable": false,
+              "properties": {
+                "value": {
+                  "type": [
+                    "number",
+                    "string"
+                  ]
+                },
+                "label": {
+                  "$ref": "defs.json#/definitions/localized"
+                }
+              },
+              "required": [
+                "value",
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "composite"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "composite": {
+            "type": "object",
+            "nullable": false,
+            "patternProperties": {
+              "^[a-z][a-zA-Z0-9]*$": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "$ref": "defs.json#/definitions/localized"
+                  },
+                  "type": {
+                    "$ref": "defs.json#/definitions/entryType"
+                  },
+                  "canBeNull": {
+                    "type": "boolean",
+                    "nullable": true
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          }
+        },
+        "required": [
+          "composite"
+        ]
+      }
+    }
+  ],
   "required": [
     "version",
     "label",
     "description",
     "streamId",
     "type"
-  ],
-  "additionalProperties": false
+  ]
 }
diff --git a/docs/pack.json b/docs/pack.json
@@ -1,5 +1,5 @@
 {
-  "publicationDate": "2025-09-24T09:32:55.428Z",
+  "publicationDate": "2025-10-08T12:48:11.640Z",
   "streams": [
     {
       "id": "body",
@@ -144,6 +144,23 @@
         }
       ]
     },
+    {
+      "id": "medication",
+      "name": "Medication",
+      "parentId": null,
+      "children": [
+        {
+          "id": "medication-intake",
+          "name": "Intake",
+          "parentId": "medication"
+        },
+        {
+          "id": "medication-prescription",
+          "name": "Prescriptions",
+          "parentId": "medication"
+        }
+      ]
+    },
     {
       "id": "profile",
       "name": "Profile",
@@ -685,6 +702,40 @@
         }
       ]
     },
+    "medication-intake": {
+      "version": "v1",
+      "label": {
+        "en": "Medication Intake"
+      },
+      "description": {
+        "en": "Medication Intake"
+      },
+      "streamId": "medication-intake",
+      "eventType": "medication/basic",
+      "type": "composite",
+      "composite": {
+        "name": {
+          "label": {
+            "en": "Name of the medication"
+          },
+          "type": "text"
+        },
+        "doseMg": {
+          "label": {
+            "en": "Dosage in milligrams"
+          },
+          "type": "number",
+          "canBeNull": true
+        },
+        "frequencyHours": {
+          "label": {
+            "en": "Frequency in hours"
+          },
+          "type": "number",
+          "canBeNull": true
+        }
+      }
+    },
     "profile-addresscountry": {
       "version": "temporary",
       "label": {
diff --git a/docs/streams.html b/docs/streams.html
diff --git a/docs/streamsTree.json b/docs/streamsTree.json
diff --git a/src/items.js b/src/items.js
diff --git a/src/schemas/items.js b/src/schemas/items.js

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,15 @@`
`18`	`18`	`"required": [`
`19`	`19`	`"en"`
`20`	`20`	`]`
	`21`	`+ },`
	`22`	`+ "entryType": {`
	`23`	`+ "enum": [`
	`24`	`+ "number",`
	`25`	`+ "text",`
	`26`	`+ "select",`
	`27`	`+ "checkbox",`
	`28`	`+ "date"`
	`29`	`+ ]`
`21`	`30`	`}`
`22`	`31`	`}`
`23`	`32`	`}`