Skip to content

docs: add warning about sample CGM data format limitations#81

Open
surfdoc wants to merge 2 commits intomainfrom
docs/acknowledge-cgm-data-limitations
Open

docs: add warning about sample CGM data format limitations#81
surfdoc wants to merge 2 commits intomainfrom
docs/acknowledge-cgm-data-limitations

Conversation

@surfdoc
Copy link
Member

@surfdoc surfdoc commented Dec 21, 2025

Summary

Addresses part of #60 by adding a prominent warning to the CGM tutorial explaining that the sample data does not fully comply with IEEE 1752/Open mHealth standards.

Problem

The sample CGM data in the tutorial (sourced from PLOS Biology research) has several format issues:

  • Units: Uses MGDL instead of mg/dL
  • Modality: Shows self-reported instead of sensed (CGM devices sense, not self-report)
  • Temporal relationship: Uses invalid value unknown instead of OMH-compliant values
  • External datasheets: Lacks proper device provenance (model, firmware)

These issues could mislead users learning the OMH format or suggest that validation isn't properly enforced.

Changes

tutorial/tutorial-cgm.ipynb:

  • Added warning cell after the intro explaining the data format limitations
  • Links to the Add Data Source Type guide for proper schema validation
  • Makes clear this is demonstration data, not production-ready format

Related Issues

Testing

  • ✅ Ran npm run myst -- build --html locally
  • ✅ Build completed successfully with no errors
  • ✅ Warning renders properly in MyST markdown

Next Steps

A separate issue will be created in jupyterhealth-exchange requesting:

  1. Investigation of why non-compliant data exists
  2. Strengthened schema validation
  3. Generation of properly formatted sample CGM data

Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

surfdoc and others added 2 commits December 21, 2025 15:09
Adds prominent warning cell explaining that the sample CGM data from
PLOS Biology does not fully comply with IEEE 1752/OMH standards:
- Units use MGDL instead of mg/dL
- Modality incorrectly shows self-reported instead of sensed
- Temporal relationship to meal uses invalid 'unknown' value
- External datasheet lacks proper device provenance

Addresses #60
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant