added data source medication intake

Author: perki

definitions/datasources/medications.yaml

@@ -0,0 +1,17 @@
+medication:
+  label: Medications
+  description: Search medications from datasets service
+  endpoint: https://datasets.datasafe.dev/medication
+  queryParam: search
+  minQueryLength: 3
+  resultKey: medications
+  displayFields:
+    label: label
+    description: description
+  valueFields:
+    - label
+    - code
+    - system
+    - source
+    - hdsId
+    - meta

definitions/eventTypes/eventTypes-hds.json

@@ -81,7 +81,60 @@
           }
         }
       }
-    } 
+    },
+    "medication/coded-v1": {
+      "description": "Coded medication from external dataset with optional dosage and route metadata",
+      "type": "object",
+      "required": ["label"],
+      "properties": {
+        "label": {
+          "description": "Localized medication name",
+          "type": "object"
+        },
+        "codes": {
+          "description": "Array of coding identifiers (ATC, RxNorm, etc.)",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["code", "system"],
+            "properties": {
+              "code": {
+                "description": "Code value (e.g. ATC code)",
+                "type": "string"
+              },
+              "system": {
+                "description": "Coding system (e.g. ATC, RxNorm)",
+                "type": "string"
+              },
+              "source": {
+                "description": "Data source reference",
+                "type": "object"
+              },
+              "hdsId": {
+                "description": "Unique HDS identifier for this code entry",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "dosageValue": {
+          "description": "Dosage amount",
+          "type": "number"
+        },
+        "dosageUnit": {
+          "description": "Dosage unit (mg, g, ml, etc.)",
+          "type": "string"
+        },
+        "administrationRoute": {
+          "description": "Route of administration (oral, parenteral, etc.)",
+          "type": "string"
+        },
+        "frequencyHours": {
+          "description": "Frequency in Hours. If non null, 'event.duration' should reflect the full period, otherwise it reflects one intake",
+          "type": "number"
+        }
+      }
+    }
   },
   "extras": {}
 }

definitions/items/medication.yaml

@@ -1,7 +1,7 @@
-medication-intake:
+medication-intake-basic:
   version: v1
-  label: Medication Intake
-  description: Medication Intake
+  label: Medication Intake Basic
+  description: Medication Intake Custom
   streamId: medication-intake
   eventType: medication/basic
   type: composite
@@ -17,4 +17,12 @@ medication-intake:
       label: Frequency in hours
       type: number
       canBeNull: true
-    
+
+medication-intake-coded:
+  version: v1
+  label: Medication Intake (coded)
+  description: Search and select a coded medication from datasets service
+  streamId: medication-intake
+  eventType: medication/coded-v1
+  type: datasource-search
+  datasource: medication

docs/datasources.json

@@ -0,0 +1,30 @@
+{
+  "medication": {
+    "label": {
+      "en": "Medications"
+    },
+    "description": {
+      "en": "Search medications from datasets service"
+    },
+    "endpoint": "https://datasets.datasafe.dev/medication",
+    "queryParam": "search",
+    "minQueryLength": 3,
+    "resultKey": "medications",
+    "displayFields": {
+      "label": {
+        "en": "label"
+      },
+      "description": {
+        "en": "description"
+      }
+    },
+    "valueFields": [
+      "label",
+      "code",
+      "system",
+      "source",
+      "hdsId",
+      "meta"
+    ]
+  }
+}

docs/eventTypes.json

@@ -1958,6 +1958,64 @@
           }
         }
       }
+    },
+    "medication/coded-v1": {
+      "description": "Coded medication from external dataset with optional dosage and route metadata",
+      "type": "object",
+      "required": [
+        "label"
+      ],
+      "properties": {
+        "label": {
+          "description": "Localized medication name",
+          "type": "object"
+        },
+        "codes": {
+          "description": "Array of coding identifiers (ATC, RxNorm, etc.)",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "code",
+              "system"
+            ],
+            "properties": {
+              "code": {
+                "description": "Code value (e.g. ATC code)",
+                "type": "string"
+              },
+              "system": {
+                "description": "Coding system (e.g. ATC, RxNorm)",
+                "type": "string"
+              },
+              "source": {
+                "description": "Data source reference",
+                "type": "object"
+              },
+              "hdsId": {
+                "description": "Unique HDS identifier for this code entry",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "dosageValue": {
+          "description": "Dosage amount",
+          "type": "number"
+        },
+        "dosageUnit": {
+          "description": "Dosage unit (mg, g, ml, etc.)",
+          "type": "string"
+        },
+        "administrationRoute": {
+          "description": "Route of administration (oral, parenteral, etc.)",
+          "type": "string"
+        },
+        "frequencyHours": {
+          "description": "Frequency in Hours. If non null, 'event.duration' should reflect the full period, otherwise it reflects one intake",
+          "type": "number"
+        }
+      }
     }
   },
   "extras": {

docs/index.html

@@ -30,6 +30,7 @@ <h3>Files</h3>
 <tr><td>Streams Tree</td><td><a href="./streamsTree.json">./streamsTree.json</a></tr>
 <tr><td>Items dictionnary</td><td><a href="./items.json">./items.json</a></tr>
 <tr><td>EventTypes dictionnary</td><td><a href="./eventTypes.json">./eventTypes.json</a></tr>
+<tr><td>Datasources dictionnary</td><td><a href="./datasources.json">./datasources.json</a></tr>
         </tbody>
       </table>
 
@@ -70,7 +71,8 @@ <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="medication-intake-basic">medication-intake-basic</span><br><u>Type:</u> composite<br><u>When:</u> undefined</td><td>Medication Intake Basic<br>Medication Intake Custom</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="medication-intake-coded">medication-intake-coded</span><br><u>Type:</u> datasource-search<br><u>When:</u> undefined</td><td>Medication Intake (coded)<br>Search and select a coded medication from datasets service</td><td><u>streamId:</u> medication-intake<br><u>eventType(s):</u> medication/coded-v1<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>

docs/items.json

@@ -624,13 +624,13 @@
     "type": "number",
     "repeatable": "any"
   },
-  "medication-intake": {
+  "medication-intake-basic": {
     "version": "v1",
     "label": {
-      "en": "Medication Intake"
+      "en": "Medication Intake Basic"
     },
     "description": {
-      "en": "Medication Intake"
+      "en": "Medication Intake Custom"
     },
     "streamId": "medication-intake",
     "eventType": "medication/basic",
@@ -658,6 +658,19 @@
       }
     }
   },
+  "medication-intake-coded": {
+    "version": "v1",
+    "label": {
+      "en": "Medication Intake (coded)"
+    },
+    "description": {
+      "en": "Search and select a coded medication from datasets service"
+    },
+    "streamId": "medication-intake",
+    "eventType": "medication/coded-v1",
+    "type": "datasource-search",
+    "datasource": "medication"
+  },
   "profile-addresscountry": {
     "version": "temporary",
     "label": {

docs/json-schemas/item.json

@@ -55,7 +55,8 @@
         },
         {
           "enum": [
-            "composite"
+            "composite",
+            "datasource-search"
           ]
         }
       ]
@@ -170,6 +171,25 @@
           "composite"
         ]
       }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "datasource-search"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "datasource": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "datasource"
+        ]
+      }
     }
   ],
   "required": [