Giter Site home page Giter Site logo

d4l-data4life / covapp Goto Github PK

View Code? Open in Web Editor NEW
98.0 15.0 48.0 2.39 MB

The app lets everyone assess their symptoms using a questionnaire. The app also informs users about next steps, for example, precautionary measures or contacting healthcare providers and health authorities.

Home Page: https://www.d4l.io/blog/covapp-corona-test-app-open-sourcing/

License: Other

JavaScript 1.77% CSS 8.20% TypeScript 89.20% HTML 0.83%
covapp coronavirus covid-19 charite questionnaire webcomponents stenciljs typescript

covapp's Introduction

⚠️ Since 25 June 2021, there is a new CovApp version 2.0.0, including a new questionnaire and risk assessment developed by the Charité. This repository contains the CovApp version 1.0.0 and is outdated since June 2021.

The latest CovApp Version code is now maintained here: https://github.com/CovOpen/CovApp-2.0


CovApp

😷 Solution for assessing the risk of contagious viral infections (COVID-19)

Screenshots of the CovApp showing the start of a questionnaire, the risk assessment and the generated QR code holding the collected information

The CovApp is an application developed in collaboration by Charité – Universitätsmedizin Berlin and Data4Life. It can help users to assess their medical condition better, provide recommendations regarding doctor’s visits or coronavirus testing by answering a few questions.

Additionally, every filled out questionnaire summarizes relevant medical information for future doctor’s consultation in the form of a summary page, printout or a QR code. Institutions with the technical setup can scan the provided QR code and retrieve the patient information quickly and without any physical contact.

By implementing the CovApp, any medical institution can reduce the number of new incoming patients, avoid physical contact and speed up the patient registration process.


This repository holds a white-labeled version of the original application, free to use licensed under MIT License. Application logic, print functionality and QR code generation are still provided.

The application and underlying questionnaire logic are versioned and future updates will be provided.

⚠️ Any institution/doctor’s office is free to implement CovApp on their domains – the medical responsibility and legal liability lie with the implementing institution.

⚠️ This application is only meant to be set up by software developers. Unfortunately, we can't provide a non-technical solution now.

Technical overview

The application runs dynamically in the browser. It can be built and deployed to any service that provides a static web server with custom routing.

It is based on a JavaScript software stack and uses the following technologies:

Installation and development

To get further information on how to set up and deploy your custom CovApp application, see the development documentation.

Customization

The CovApp provides the following customization options:

  • change words or add a new language

⚠️ Note that there are several placeholder texts you must provide yourself.

⚠️ Note that the default fallback language is English (en) and it has to be available.

  • change colors
  • change the application logo

To learn more about these options, see the customization documentation.

Questionnaire answers in FHIR format

In addition to the XML representation of the questionnaire answers that is stored in the QR code, there is the possibility to generate a FHIR R4 representation. You find documentation for the FHIR version of the questionnaire and its resources on Simplifier.net. In the src/global/fhir folder, you find a module that lets you create a FHIR R4 QuestionnaireResponse resource which contains the answers.

To generate the FHIR format, add the following code to the src/components/qr-code/qr-code.tsx file:

import { createFHIRQuestionnaireResponse } from '../../global/fhir';

createFHIR = () => {
  const valuePairs = this.generateValuePairs(this.answers);
  const fhir = createFHIRQuestionnaireResponse(valuePairs, this.language);
  return fhir;
};

Note: Since you’re changing the code outside of the general customization process, this might bring merge conflicts for future app updates.

Support and contributing

Due to today's urgency and dynamic nature, we cannot offer support for this repository. We'll continue the development of the official CovApp internally. Changes and releases will be white-labeled and propagated into this repository.

We won't be able to react to issues and/or pull requests, but we would still encourage you to provide feedback. We will monitor the appearing problems, new ideas and possible feature requests and might consider them for future releases. Feel free to collaborate and work on your forks to move forward with custom development.

Before you open an issue, see the customization documentation.

Application updates

While the development of the original CovApp continues internally, we'll provide regularly updated GitHub releases. If you followed the setup instructions and created a fork of this repository on GitHub, an automation process will open pull requests in your repository whenever then application and the underlying questionnaire received an update. This way, you'll be informed about updates and the development process stays as easy as possible.

Additionally, GitHub provides documentation on how to sync forks manually.

Frequently asked questions

If you have further questions, you can find additional information on d4l.io.

Code of conduct

Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

License

The CovApp is MIT licensed.

Copyright

Copyright 2020 by Charité Universitaetsmedizin Berlin and D4L data4life gGmbH

Contributors: Dr. Alexander Henry Thieme and others

covapp's People

Contributors

anikina avatar burtchen avatar chaeringer avatar data4life-web avatar dependabot[bot] avatar meduzen avatar radibit avatar stefanjudis avatar timwalz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

covapp's Issues

Bug fix for issue with app.css in stencil.config.ts, color customization not working!

There's a bug in the stencil.config.ts file which prevents any color customization!

The following code at line 14 f.:

globalStyle: process.env.LAYOUT === 'OFFICIAL_COLLABORATION_BZGA' ? 'src/global/app-collaboration-bzga.css' : 'src/global/app.css',

should be replaced by:

globalStyle: 'src/custom/styles/app.css',

Took me a day to finally track down the problem and find the solution.
Hope this is helpful for others who run into the same issue! :)

Incorrect date format on US iPhone when setting the app language to German

To reproduce this issue:

  1. Use an iPhone configured for the US market. Could potentially be reproduced on a German iPhone configured for US language settings too.
  2. Install the CovPass app from the US app store
  3. In the Settings app, configure the CovPass app to use "German" as the preferred language

CovPass-SettingsGerman

  1. Open the CovPass app. Notice that the date of the certificate is shown in Month/Day/Year format (the default for US english) instead of the expected Day.Month.Year format.
    CovPass-WrongDateFormat

Fallback language failed

If 'en' is not part of the SUPPORTED_LANGUAGES-Const in .env, the fallback language breaks the app if the the default language of the browser is 'en'.

Build not working

Hi, I tried to set it up.
But it is running into errors:

npm run start

> [email protected] prestart C:\Develop\GitHub\CovOpen\covapp-1
> npm run prepare-customization


> [email protected] prepare-customization C:\Develop\GitHub\CovOpen\covapp-1
> node ./scripts/prepare-customization.js


> [email protected] start C:\Develop\GitHub\CovOpen\covapp-1
> stencil build --dev --watch --serve --no-open

[28:33.2]  @stencil/core v1.11.3
[28:37.1]  build, app, dev mode, started ...
[28:37.1]  transpile started ...
[28:45.8]  transpile finished in 8.69 s

[ ERROR ]  Component Tag Name "ia-recommendation" Must Be Unique
           Please update the components so "ia-recommendation" is only used once:
           ./src/components/recommendation/recommendation.tsx ./src/components/views/recommendation/recommendation.tsx

[28:45.8]  build failed, watching for changes... in 8.71 s

[28:45.8]  http://localhost:3333/

After removing the module:

npm run start

> [email protected] prestart C:\Develop\GitHub\CovOpen\covapp-1
> npm run prepare-customization


> [email protected] prepare-customization C:\Develop\GitHub\CovOpen\covapp-1
> node ./scripts/prepare-customization.js


> [email protected] start C:\Develop\GitHub\CovOpen\covapp-1
> stencil build --dev --watch --serve --no-open

[27:12.4]  @stencil/core v1.11.3
[27:18.5]  build, app, dev mode, started ...
[27:18.5]  transpile started ...
[27:26.1]  transpile finished in 7.54 s

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:1:10
           Module '"../../../../../../../Develop/GitHub/CovOpen/covapp-1/src/global/fhir"' has no exported member
           'CATEGORIES_VALUESET'.

      L1:  import { CATEGORIES_VALUESET } from '.';
      L2:  import { KeyValue } from '../../components/qr-code/utils';

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:9:3
           Module '"../../../../../../../Develop/GitHub/CovOpen/covapp-1/src/global/fhir/types"' has no exported member
           'FHIRValueCoding'.

      L8:  FHIRQuestionnaireResponse,
      L9:  FHIRValueCoding,
     L10:  FHIRValueDate,

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:10:3
           Module '"../../../../../../../Develop/GitHub/CovOpen/covapp-1/src/global/fhir/types"' has no exported member
           'FHIRValueDate'. Did you mean 'FHIRValueSet'?

      L9:    FHIRValueCoding,
     L10:    FHIRValueDate,
     L11:  } from './types';

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:86:7
           Property 'type' is missing in type '{ linkId: string; text: any; item: any[]; }' but required in type
           'FHIRQuestionnaireItem'.

     L86:    let item: FHIRQuestionnaireItem = {
     L87:      linkId: answers[0].key[0],

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:102:31
           Property 'split' does not exist on type 'string | number'.Property 'split' does not exist on type 'number'.

    L101:  answerItem = {
    L102:    valueDate: answer.value.split('.').join('-'),
    L103:  };

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:116:5
           Type '{ linkId: string; text: any; answer: any[]; }' is not assignable to type
           'FHIRQuestionnaireItem'.Object literal may only specify known properties, and 'answer' does not exist in
           type 'FHIRQuestionnaireItem'.

    L115:    text: LANGUAGE_RESOURCES[language].translation[`q_${answer.key}_text`],
    L116:    answer: [answerItem],
    L117:  };

[ ERROR ]  TypeScript: ./src/global/fhir/response.ts:124:19
           Property 'AGE' does not exist on type '{ POSTAL_CODE: string; ABOVE_65: string; HOUSING: string; CARING:
           string; WORKSPACE: string; CONTACT_DATE: string; OUT_OF_BREATH: string; SYMPTOM_DATE: string; DATA_DONATION:
           string; }'.

    L123:  switch (answer.key) {
    L124:    case QUESTION.AGE:
    L125:      return 'http://fhir.data4life.care/covid-19/r4/CodeSystem/age-group';

[27:26.1]  build failed, watching for changes... in 7.57 s

[27:26.1]  http://localhost:3333/

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.