Skip to content

Commit baca3f2

Browse files
authored
Update README.md (#57)
# Updates to Documentation added ANC visualizations, so updating the documentation! ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): - [X] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md).
1 parent ef5e895 commit baca3f2

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ NeutroFeverGuard is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ec
4646
- **Manual Entry**: Users can manually add health data, including vitals, lab values, medications, symptoms, and the [MASCC (Multinational Association for Supportive Care in Cancer) Risk Index](https://www.mdcalc.com/calc/3913/mascc-risk-index-febrile-neutropenia).
4747

4848
> [!NOTE]
49-
> How is the data being processed and stored? NeutroFeverGuard use [Spezi Local Storage](https://github.com/StanfordSpezi/SpeziStorage) to store lab results and medication data locally. Other health data is stored in [Healthkit](https://github.com/StanfordSpezi/SpeziHealthKit). For cloud storage, all data is stored as [FHIR](https://github.com/StanfordSpezi/SpeziFHIR) elements on [Firebase](https://github.com/StanfordSpezi/SpeziFirebase).
49+
> How is the data being processed and stored? NeutroFeverGuard uses [Spezi Local Storage](https://github.com/StanfordSpezi/SpeziStorage) to store lab results and medication data locally. Other health data is stored in [Healthkit](https://github.com/StanfordSpezi/SpeziHealthKit). For cloud storage, all data is stored as [FHIR](https://github.com/StanfordSpezi/SpeziFHIR) elements on [Firebase](https://github.com/StanfordSpezi/SpeziFirebase).
5050
5151
> [!NOTE]
5252
> Want to understand how CORE Sensor connection, and continuous temperature data flow work? Check out the detailed explanation in [Working with CORE Sensor - Bluetooth Connection](Documentation/BluetoothSensor.md).
5353
5454
2. **Visualization:**
55-
Interactive graphs display trends for: heart rate, temperature, and oxygen saturation. Visuals include trend lines and daily average readings to help users and clinicians better understand health fluctuations. Data is automatically loaded and read from HealthKit.
55+
Interactive graphs display trends for: heart rate, temperature, oxygen saturation, and absolute neutrophil count. Visuals include trend lines and daily average readings to help users and clinicians better understand health fluctuations. Data is automatically loaded and read from HealthKit.
5656

5757
### II. Notifications & Alerts
5858
1. **Critical Health Alerts:**
@@ -82,9 +82,9 @@ NeutroFeverGuard is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ec
8282

8383

8484
## User Instructions
85-
1. **Setup:** Use [TestFlight](https://testflight.apple.com/join/CAuYHs84) to download NeutroFeverGuard. Following the instruction when onboarding: sign the consent form, give permissions to health data and notification, sign up and provide your data.
86-
2. **Connect to Sensor:** If you have a CORE Sensor, make sure your sensor and bluetooth is on, go to Connect tab and our app will automatically connect, read and save your body temperature data through the CORE Sensor. If you don't have this sensor, this page will suggest you to add your data manually.
87-
3. **Dashboard:** Visualize your heart rate, body temperature, and oxygen saturation trends. The data syncs with the Health app, including readings from Bluetooth sensors and manual entries. Click on each scatter plot data to see a summary of what day it was recorded on and what the average, minimum, and maximum values for that measurement that day was. Note that the Apple Watch doesn’t measure absolute body temperature continuously, only [nightly wrist temperature](https://support.apple.com/en-us/102674), which isn’t supported. For body temperature, you can use the [CORE sensor](https://corebodytemp.com/) or other sensors/apps that push body temperature data to Apple Health app.
85+
1. **Setup:** Use [TestFlight](https://testflight.apple.com/join/CAuYHs84) to download NeutroFeverGuard. Following the instructions when onboarding: sign the consent form, give permissions to health data and notification, sign up and provide your data.
86+
2. **Connect to Sensor:** If you have a CORE Sensor, make sure your sensor and Bluetooth are on, go to Connect tab and our app will automatically connect, read and save your body temperature data through the CORE Sensor. If you don't have this sensor, this page will suggest you add your data manually.
87+
3. **Dashboard:** Visualize your heart rate, body temperature, oxygen saturation, and absolute neutrophil count trends. The data syncs with the Health app, including readings from Bluetooth sensors and manual entries. Click on each scatter plot data to see a summary of what day it was recorded and what the average, minimum, and maximum values for that measurement that day was. Note that the Apple Watch doesn’t measure absolute body temperature continuously, only [nightly wrist temperature](https://support.apple.com/en-us/102674), which isn’t supported. For body temperature, you can use the [CORE sensor](https://corebodytemp.com/) or other sensors/apps that push body temperature data to Apple Health app.
8888
4. **Add Data:** Manually log health metrics, including temperature, heart rate, oxygen saturation, and blood pressure — these will also sync to the Health app. You can record lab results for neutropenia-related tests, track medication intake with timestamps, log symptoms like nausea or fatigue, and take MASCC Risk Index survey.
8989
5. **Records:** View past entries in two tabs — Lab Results and Medications. The Lab Results tab shows your latest Absolute Neutrophil Count (ANC) and provides a detailed history where you can view and delete records. In the Medications tab, you can view, edit, or delete your medication logs.
9090

@@ -94,7 +94,6 @@ Enjoy!
9494

9595
- **Manual data entry validation:** While our manual data entry feature warns users against entering invalid values (e.g., negative blood pressure), it still accepts unrealistic values (e.g., heart rate of 300 bpm). This validation should be improved in future iterations, and [SpeziValidation](https://github.com/StanfordSpezi/SpeziViews/tree/main/Sources/SpeziValidation) can be used.
9696
- **Real-Time data issues with HealthKit when the App is not in the foreground:** As discussed with the Apple Health Research Team, retrieving real-time data from HealthKit while the app is in the background is inconsistent, which is a known issue on their end. Currently, the app receives near-real-time updates even if it is not in the foreground, with HealthKit pushing data approximately once per hour. To enable truly real-time fever monitoring when the app is not in the foreground, the system could query locally stored Bluetooth data instead of relying on HealthKit observer queries.
97-
- **Adding ANC visualization over time**: Currently, we visualize vitals, however it might be good to add ANC count over time as well.
9897

9998
## Contributing
10099

0 commit comments

Comments
 (0)