Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Out of date Risk Assessment document #453

Closed
MikeMcC399 opened this issue Oct 30, 2020 · 31 comments
Closed

Out of date Risk Assessment document #453

MikeMcC399 opened this issue Oct 30, 2020 · 31 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation mirrored-to-jira This item is also tracked internally in JIRA

Comments

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Oct 30, 2020

Where to find the issue

Document title
How does the Corona-Warn-App identify an increased risk? found on
https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-risk-assessment.md

and translated document title
Wie ermittelt die Corona-Warn-App ein erhöhtes Risiko?
https://github.com/corona-warn-app/cwa-documentation/blob/master/translations/cwa-risk-assessment.de.md

Describe the issue

The document cwa-risk-assessment.md makes no mention of the use of the onset of symptoms date which is used in the submission process starting from Version 1.5 of the CWA app. In the example, Anton's and Aisha's submissions on different days are treated differently although their symptoms started on the same day. They should now be treated the same in terms of the start date, even though the test results are submitted on different days.

According to the blog entry "Start of Symptoms" date or range of dates is now a possible captured parameter in the test result submission process.
New features: Corona-Warn-App Version 1.5 is now available for download
Janina Hoerdt on October 19, 2020
https://www.coronawarn.app/en/blog/2020-10-19-version-1-5/
Section "Symptom Recording" including the set of submission screen shots:

submission screen shots

Suggested change

The document should explain how the onset of symptoms information is used in assessing risk.

Edit:
The document has become completely out-of-date due to the release of CWA 1.9 on Dec 9, 2020 using v2 / Exposure Window mode for Exposure Risk calculations.

The document now includes a temporary header with the following information:


Later calculation improvements

Improvements to the risk assessment calculations were made in app versions V1.5 (Symptom Recording) and V1.9 (Exposure Notification Framework v2) after this document was published. The FAQ section Risk Assessment answers related questions.


Internal Tracking ID: EXPOSUREAPP-3548

@MikeMcC399 MikeMcC399 added bug Something isn't working documentation Improvements or additions to documentation labels Oct 30, 2020
@heinezen heinezen added the mirrored-to-jira This item is also tracked internally in JIRA label Nov 1, 2020
@heinezen
Copy link
Member

heinezen commented Nov 1, 2020

Hey @MikeMcC399

Thanks for pointing out the inconsistency. I have created a Jira ticket (EXPOSUREAPP-3548) to address the missing information in the risk assesment docs. The devs will now have a look at the documentation and update it accordingly.

CH


Corona-Warn-App Open Source Team

@SebastianWolf-SAP
Copy link
Member

Needs to be addressed together with #426.

@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Nov 7, 2020

The app itself, in the detailed risk card "Risk of Infection" section, refers to FAQ entry https://www.coronawarn.app/en/faq/#encounter_but_green which in turn refers to https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-risk-assessment.md.
The string name is risk_details_explanation_faq_link.

So CWA users are currently being led to out-of-date reference material.

@MikeMcC399
Copy link
Contributor Author

It would be good to get this central piece of documentation updated. Is there any news?

@dsarkar
Copy link
Member

dsarkar commented Nov 19, 2020

Dear @MikeMcC399,

I had a quick look at the internal ticket: The information will be updated in coordination with the RKI.

Best wishes,
DS


Corona-Warn-App Open Source Team

@MikeMcC399
Copy link
Contributor Author

Now with the release of CWA 1.9 (see https://www.coronawarn.app/en/blog/2020-12-16-corona-warn-app-version-1-9/) the cwa-risk-assessment.md document (and German translation cwa-risk-assessment.de.md) needs to be updated to cover the transition to Apple's v2 Exposure Notification Framework and Google's Exposure Notification System Exposure Window Mode which replaces the Legacy v1 mode.

@MikeMcC399
Copy link
Contributor Author

Happy New Year everybody! 🥳

@tklingbeil
Can we get the risk assessments documents updated please so they describe the v2 implementation?

It looks like the links to the configuration files at the bottom of the document are also obsolete.

Congratulations for your great presentation at rC3!

Blog entry which links to:

@dsarkar
Copy link
Member

dsarkar commented Jan 1, 2021

@MikeMcC399 Happy New Year ! I forwarded your message to devs/tklingbeil. Best, DS

@tklingbeil
Copy link
Member

@MikeMcC399

A happy new year to you as well and thank you for the feedback on the session!

We will definitely update the various components of the documentation, so that the adapted risk calculation (as well as some other things) are properly represented there.

@dsarkar dsarkar added the Fix 1.12 Fix is planned for 1.12 label Jan 18, 2021
@MikeMcC399
Copy link
Contributor Author

@tklingbeil

We will definitely update the various components of the documentation, so that the adapted risk calculation (as well as some other things) are properly represented there.

If the update to the documents is delayed, could we get a note added at the top of the document to cover the immediate future? That should explain:

  • The document is under revision
  • Improvements were made in v1.5 and v1.9 of the app to increase the accuracy of the risk assessment
  • The FAQ article https://www.coronawarn.app/en/faq/#encounter_19_calc contains a summary of the risk assessment in app version 1.9 and later

Both the English language and German language documents are affected:

I can submit a PR for this change if that would be helpful.

@MikeMcC399 MikeMcC399 changed the title Onset of symptoms data input not covered in document "How does the Corona-Warn-App identify an increased risk?" Out of date Risk Assessment document Jan 19, 2021
@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Jan 19, 2021

I have submitted PR #513 to bridge the gap until the documents can be fully updated.

PS The checks ran on the PR from the fork, catching a markdownlint issue that I was able to correct. It is good that this is now working before a PR is merged. That is much better than previously. 👍

@MikeMcC399
Copy link
Contributor Author

The risk assessment documents:

How does the Corona-Warn-App identify an increased risk?
https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-risk-assessment.md
and
Wie ermittelt die Corona-Warn-App ein erhöhtes Risiko?
https://github.com/corona-warn-app/cwa-documentation/blob/master/translations/cwa-risk-assessment.de.md

which describe a core function of the CWA app have been waiting for an update for the past 6 months. Updates are made necessary, firstly due to the introduction of Onset of Symptoms followed by the transition from v1 to v2 / ExposureWindow mode, thereafter with continual optimization of risk assessment parameters using v2 / ExposureWindow mode.

The label on this issue is "Fix 2.0" and the app version 2.0.x was released today, April 21, 2021, so that implies that the documents will now be republished.

I cannot see any update so far. Please revise the planning information if the documents will not be updated this week.

@dsarkar dsarkar removed the Fix 2.0 Fix is planned for 2.0 label Apr 21, 2021
@dsarkar
Copy link
Member

dsarkar commented Apr 21, 2021

@MikeMcC399 Will try to get info. Thanks.

@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Apr 26, 2021

The risk assessment document does not include information about how risks resulting from using Event Registration, introduced in CWA 2.0, are assessed. This is described in FAQ https://www.coronawarn.app/en/faq/#check_in_qr_warning.

@ndegendogo
Copy link

Thanks @MikeMcC399 for linking this information here.

@MikeMcC399
Copy link
Contributor Author

The Solution Architecture document, Section: Risk Calculation discusses the use of Onset of Symptoms data for risk assessment. This is not mentioned in the cwa-risk-assessment.md document. At least there should be a cross-reference added from the cwa-risk-assessment.md document to the Solution Architecture document if the cwa-risk-assessment.md is not going to be otherwise updated.

mlenkeit added a commit that referenced this issue Jan 25, 2022
consistently use 5 and 9 minutes as thresholds throughout the diagram.
additionally, re-generates the pdf for the svg

related to #586, #453, #818
@mlenkeit mlenkeit assigned mlenkeit and unassigned JoachimFritsch Jan 28, 2022
mlenkeit added a commit that referenced this issue Jan 28, 2022
- add deprecation notice to document
- add reference to solution architecture

related to #453
@MikeMcC399
Copy link
Contributor Author

How does the Corona-Warn-App identify an increased risk? found on
https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-risk-assessment.md

is to be deprecated, and by implication the translated document also:

Wie ermittelt die Corona-Warn-App ein erhöhtes Risiko?
https://github.com/corona-warn-app/cwa-documentation/blob/master/translations/cwa-risk-assessment.de.md

Once the documents have had a deprecation notice added, then this issue can be closed.

The replacement is the Solution Architecture document, section Mobile Applications.

@mlenkeit
Copy link
Member

mlenkeit commented Feb 2, 2022

@MikeMcC399 can we close this issue because of #829?

@MikeMcC399
Copy link
Contributor Author

This issue is now resolved. See previous #453 (comment).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working documentation Improvements or additions to documentation mirrored-to-jira This item is also tracked internally in JIRA
Projects
None yet
Development

No branches or pull requests

9 participants