CovApp open-sourcing FAQ
Answers for the coronavirus app (CovApp) open-sourcing
Note: There is also a German language version of this FAQ blog post.
For which scenarios is the CovApp intended?
The CovApp is intended for use in the following scenarios:
Using the CovApp and querying SARS-CoV-2-related symptoms, people check whether there is a recommended course of action for them and whether they have to investigate suspected illnesses.
Using the answers as a medical history, admission staff can receive the information from the questionnaire during the admission process. Staff can then transfer the information to the clinical system.
Important: The CovApp doesn't provide diagnostic services. The app serves to simplify the procedures in care.
For which users is the CovApp intended?
The CovApp user is primarily the patient. To support the admission process in the form of taking a medical history, the admission staff is an additional user. The staff ensures that the patient’s answers are transferred to the clinical system.
How does the CovApp support clinical processes?
The CovApp offers everyone a way to assess whether they may have been infected with SARS-CoV-2 by answering a questionnaire. The answers to this questionnaire are provided in the form of a machine-readable QR code. This code can be transferred to a clinical system using a suitable QR code scanner. This workflow supports and accelerates the process of assessing medical history information. In addition to the QR code, the questions and their associated answers can be displayed as a list and can be printed out.
Where are answers in the questionnaire saved?
The answers to the questionnaire are saved on the device of the user. Answers can be reused later if users open the CovApp on the same device. From a technical perspective, the questionnaire and the answers are stored in the local storage of the web browser using cookies. This means that deleting cookies also deletes all answers.
How is the questionnaire developed?
The CovApp questionnaire was developed in cooperation with the Robert Koch Institute (RKI). Together with the RKI, we continuously evaluate the questions and expand and adapt them as needed.
Can I use the CovApp myself?
Yes, we offer the CovApp open-source solution on GitHub. You find the source code and documentation there. If you follow the instructions, you can customize the application and offer it to your patients to support your admission process.
Which system requirements must be met?
Keep in mind that the CovApp must be available on the internet to provide access for patients who aren’t within your network infrastructure. You can find details on installing and configuring the CovApp on GitHub.
After users complete the questionnaire, the CovApp generates a QR code that can be read by a QR code scanner. To transfer the data to the clinical system, the respective interfaces must be implemented on the customer side.
Since the QR code is based on an XML structure, you need the description of the XML structure, which we provide, to implement a potential mapping function.
Which deliverables are provided by Data4Life?
You can find the CovApp source code on GitHub. The source code is subject to the open-source license MIT. You can find the license terms here.
The description of the generated XML is provided in the following ways:
Microsoft Excel file which contains all information in table form (including IDs, questions, possible answers)
Graphical representation of the decision tree (PDF file)
You find the documents on GitHub.
The Charité offers help for implementations that support the development of an interface for reading the QR code, and converting it into a parameterizable medical document (PMD). For more information, see the I work with i.s.h.med section.
Can I customize the CovApp?
Yes, the CovApp offers different configuration options for the content and the user interface. You can customize the following:
You can find a technical description on how to adapt these elements on GitHub.
Note: Custom changes to the questionnaire or the implementation of the decision tree aren't recommended and aren't officially supported. Any changes could be overwritten by future CovApp updates.
I work with i.s.h.med – is there anything I must consider?
The requirements for running the CovApp are independent of your hospital information system (HIS). For the i.s.h.med HIS, we offer solutions that have been developed together with Charité. In this case, you can obtain a parameterizable medical document (PMD) in the form of the medical history sheet. You can use this document, together with a transformation implementation that’s also offered, to transfer the XML data directly into the corresponding PMD.
If you have questions regarding the implementations and how you can make use of them, please contact Peter Heumann of Charité - Universitätsmedizin Berlin.
Is the CovApp backwards-compatible?
We ensure backward compatibility by defining the version number of the questionnaire. The version number is also incorporated into the XML structure containing the answers, also encoded as the QR code.
These are the rules for changing the questionnaire:
Retain the sequence of questions
Retain the sequence of answers
Retain the technical values of answers, like IDs
Add new questions and new answers only after existing ones
If questions are no longer needed, they aren’t displayed and their related values aren’t transmitted to the XML structure
Can the CovApp use FHIR to represent the answers?
Besides generating the XML structure for the QR code, the CovApp can also be used to generate the answers as an instance of the
QuestionnaireResponse FHIR resource. You can find the referenced FHIR
Questionnaire definition on
Note: The generated QR code still encodes the XML structure. This ensures compatibility of the QR code with the majority of QR scanners.
We try to avoid gender-specific word forms and formulations. As appropriate for context and readability, we may use feminine or masculine word forms to refer to all genders.