medwear.github.io/documentation.html at main · SCAI-Lab/medwear.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Documentation | MEDWEAR</title>
  <link rel="stylesheet" href="style.css" />
  <link rel="icon" href="favicon.ico" />
</head>

<body>
  <header>
    <div class="header-upper">
        <!-- <img src="assets/images/medwear_logo.png" alt="MEDWEAR Logo" class="logo" /> -->
    </div>
    <div class="header-lower">
        <h1>MEDWEAR</h1>
        <p>Open, Interoperable Standards for Medical Wearables</p>
    </div>
    <hr class="header-separator" />
    <div class="under-construction-banner">
        🚧 This website is currently under construction. Some content may be incomplete. 🚧
    </div>
  </div>
    <nav>
      <a href="index.html">Home</a>
      <a href="about.html">About</a>
      <a href="standards.html">Standards</a>
      <a href="documentation.html" class="active">Documentation</a>
      <a href="schemas.html">Schemas</a>
      <a href="contribute.html">Contribute</a>
      <a href="med-api.html">MED-API</a>
    </nav>
  </header>

<div class="content-container">
  <main>
    <section>
      <h2>Usage Examples</h2>

      <h3>Using MEDWEAR JSON Schemas</h3>
      <p>The schemas define the data structure for wearable sensor data. You can validate your data against these schemas to ensure interoperability.</p>

      <h4>Example: ECG Data JSON</h4>
      <pre><code>{
  "schema_id": "org.medwear.biosignal.ecg",
  "version": "1.0",
  "data": {
    "ecg": [0.12, 0.15, 0.11, ...],
    "sample_rate": 250,
    "units": "mV"
  },
  "metadata": {
    "device_id": "device1234",
    "timestamp": "2025-06-30T15:30:00Z"
  }
}</code></pre>

      <h3>Loading MEDWEAR Schemas in Python</h3>
      <pre><code>import json
from jsonschema import validate

with open('ecg_schema.json') as schema_file:
    schema = json.load(schema_file)

with open('ecg_data.json') as data_file:
    data = json.load(data_file)

validate(instance=data, schema=schema)
print("Data is valid according to MEDWEAR ECG schema.")</code></pre>

      <h3>Further Resources</h3>
      <ul>
        <li><a href="https://json-schema.org/" target="_blank" rel="noopener">JSON Schema documentation</a></li>
        <li><a href="https://github.com/SCAI-Lab/ord_schemas" target="_blank" rel="noopener">MEDWEAR GitHub Repository</a></li>
        <li><a href="schemas.html">Explore MEDWEAR Schemas (new page)</a></li>
      </ul>
    </section>

    <section>
      <h2>Documentation & Resources</h2>

      <h3>📚 User Guides</h3>
      <ul>
        <li><a href="#schemas">Using MEDWEAR Data Schemas</a></li>
        <li><a href="#ros">ROS 2 Integration Guide</a></li>
        <li><a href="#conversion">Data Conversion Workflow</a></li>
      </ul>

      <h3 id="schemas">📄 JSON Schemas</h3>
      <p>
        Our schemas extend Open mHealth to include raw sensor formats. <br />
        <a href="schemas.html">View all schemas on a dedicated page</a> | <a href="https://github.com/SCAI-Lab/ord_schemas" target="_blank" rel="noopener">View on GitHub</a>
      </p>

      <h3 id="ros">🤖 ROS 2 Messages</h3>
      <p>
        Download ROS 2 `.msg` definitions for integration with healthcare robots and assistive devices.<br />
        <a href="https://github.com/SCAI-Lab/healthcare_msgs" target="_blank" rel="noopener">View ROS 2 message package</a>
      </p>

      <h3 id="conversion">🔁 Conversion Tools</h3>
      <p>
        Command-line tools and notebooks to convert CSV/JSON/wearable data to MEDWEAR-compliant format.<br />
        <a href="https://github.com/medwear/conversion-tools" target="_blank" rel="noopener">Explore conversion tools</a>
      </p>

      <h3>📊 Example Datasets</h3>
      <p>
        Sample anonymized datasets for development and testing.<br />
        <a href="https://github.com/medwear/sample-data" target="_blank" rel="noopener">Download examples</a>
      </p>

      <h3>🧠 Publications</h3>
      <ul>
        <li>"MEDWEAR: Data Standardization of Wearable Devices for Healthcare Applications" (in preparation)</li>
        <li>Symposium [<a href="https://scai.ethz.ch/symposium-2025.html" target="_blank" rel="noopener">PDF</a>]</li>
      </ul>

      <h3>🛠️ Contribute</h3>
      <p>
        Found a bug or want to add support for new sensors? <br />
        See our <a href="contribute.html" target="_blank" rel="noopener">contributing guide</a>.
      </p>

      <h3>❓ FAQs</h3>
      <p>
        Coming soon: Frequently asked questions about MEDWEAR schemas and implementation.
      </p>
    </section>
  </main>
</div>
  <footer>
    <div class="footer-logos">
      <img src="assets/images/scai_logo.png" alt="SCAI Lab Logo" class="logo" />
      <img src="assets/images/dart_logo.png" alt="DART Logo" class="logo" />
      <img src="assets/images/ethz_logo.png" alt="ETH Zurich Logo" class="logo" />
    </div>
    <p>© 2025 ETH Zurich – MEDWEAR Project | Contact: diego.paez@scai.ethz.ch</p>
  </footer>
</body>

</html>