diff --git a/docs/App-screens.md b/docs/App-screens.md index 7b481ab7..29d3f4fe 100644 --- a/docs/App-screens.md +++ b/docs/App-screens.md @@ -13,28 +13,28 @@ table row. | # | Action | Screen | Description | | - | ------ | ------ | ----------- | -| 1 | App opened the first time | | Login screen with data provider selection | -| 2 | _Get data_ πŸ‘† | | Alert for login redirect | -| 3 | _Continue_ πŸ‘† | | Rectedirect to Keycloak login page | -| 4 | _Sign In_ πŸ‘† | | Back to app, import was successful | -| 5 | _Continue_ πŸ‘† | | Onboarding (screen 1 of 5) | -| 6 | _Next_ πŸ‘† | | Onboarding (screen 2 of 5) | -| 7 | _Next_ πŸ‘† | | Onboarding (screen 3 of 5) | -| 8 | _Next_ πŸ‘† | | Onboarding (screen 4 of 5) | -| 9 | _Next_ πŸ‘† | | Onboarding (screen 5 of 5) | -| 10 | _Get started_ πŸ‘† | | Initial active drug selection | -| 11 | _Continue_ πŸ‘† | | Gene report, showing all genes that can be mapped to PGx guidelines | -| 12 | _CYP2D6_ tile πŸ‘† | | Gene details; the notice about influence of other drugs is only shown for genes where drug-gene interactions are implemented | -| 13 | _Amitriptyline_ tile πŸ‘† | | Drug with unknown guideline detail; shown in green since standard dosing is applied without guidelines (_note for this example: the guideline for this genotype was not published in the backend at time of screenshot creation, which is why the guideline in missing in this case_) | -| 14 | _Drugs_ navigation tab πŸ‘† | | Drug search page | -| 15 | _?_ icon πŸ‘† | | Tooltip explaining search feature; tooltips look the same on all pages | -| 16 | Filter icon πŸ‘† | | Available search filters | -| 17 | _Clopidogrel_ tile πŸ‘† | | Drug with known guideline | -| 18 | ⏬ | | At the bottom of a drug, a link to the underlying guideline is given; this link redirects the user to the guideline website | -| 19 | Share icon (in header) πŸ‘† | | Create a PDF document to share with others | -| 20 | _FAQ_ navigation tab πŸ‘† | | FAQ page | -| 21 | First FAQ list item πŸ‘† | | Extended FAQ item | -| 22 | ⏬ | | "Contact us" at the end of the FAQ in case of more questions; will open the user's default email app with the development team address pre-filled | -| 23 | _More_ navigation tab πŸ‘† | | "More" page with settings and further information; "Onboarding" will start the onboarding again (screens 5 to 10) | -| 24 | #23 _About us_ πŸ‘† | | "About us" page; "Privacy policy" and "Terms of use" have the same page style (currently only lorem ipsum) | -| 25 | #23 _Delete app data_ πŸ‘† | | Deletes all app data and redirects to screen 1; continuing is only possible when the checkmark was clicked | +| 1 | App opened the first time | login | Login screen with data provider selection | +| 2 | _Get data_ πŸ‘† | login-redirect | Alert for login redirect | +| 3 | _Continue_ πŸ‘† | keycloak-login | Redirect to Keycloak login page | +| 4 | _Sign In_ πŸ‘† | import-success | Back to app, import was successful | +| 5 | _Continue_ πŸ‘† | onboarding-1 | Onboarding (screen 1 of 5) | +| 6 | _Next_ πŸ‘† | onboarding-2 | Onboarding (screen 2 of 5) | +| 7 | _Next_ πŸ‘† | onboarding-3 | Onboarding (screen 3 of 5) | +| 8 | _Next_ πŸ‘† | onboarding-4 | Onboarding (screen 4 of 5) | +| 9 | _Next_ πŸ‘† | onboarding-5 | Onboarding (screen 5 of 5) | +| 10 | _Get started_ πŸ‘† | drug-selection | Initial selection of current medications | +| 11 | _Continue_ πŸ‘† | gene-report | Gene report, showing all genes that can be mapped to PGx guidelines | +| 12 | _CYP2D6_ tile πŸ‘† | cyp2d6 | Gene details; the notice about influence of other medications is only shown for genes for which phenoconversion implemented | +| 13 | _Amitriptyline_ tile πŸ‘† | amitriptyline | Medication with unknown guideline detail; shown in green since standard dosing is applied without guidelines (_note for this example: the guideline for this genotype was not published in the backend at time of screenshot creation, which is why the guideline in missing in this case_) | +| 14 | _Medications_ navigation tab πŸ‘† | drug-search | Medication search page | +| 15 | _?_ icon πŸ‘† | drug-search-tooltip | Tooltip explaining search feature; tooltips look the same on all pages | +| 16 | Filter icon πŸ‘† | drug-search-filter | Available search filters | +| 17 | _Clopidogrel_ tile πŸ‘† | clopidogrel | Medication with known guideline | +| 18 | ⏬ | clopidogrel-scrolled | At the bottom of a medication, a link to the underlying guideline is given; this link redirects the user to the guideline website | +| 19 | Share icon (in header) πŸ‘† | pdf-export | Create a PDF document to share with others | +| 20 | _FAQ_ navigation tab πŸ‘† | faq | FAQ page | +| 21 | First FAQ list item πŸ‘† | faq-first-item | Extended FAQ item | +| 22 | ⏬ | faq-contact | "Contact us" at the end of the FAQ in case of more questions; will open the user's default email app with the development team address pre-filled | +| 23 | _More_ navigation tab πŸ‘† | more | "More" page with settings and further information; "Onboarding" will start the onboarding again (screens 5 to 10) | +| 24 | #23 _About us_ πŸ‘† | about-us | "About us" page; "Privacy policy" and "Terms of use" have the same page style (currently only lorem ipsum) | +| 25 | #23 _Delete app data_ πŸ‘† | delete-app-data | Deletes all app data and redirects to screen 1; continuing is only possible when the checkmark was clicked | diff --git a/docs/GLOSSARY.md b/docs/GLOSSARY.md index e54ba8ed..47e39a91 100644 --- a/docs/GLOSSARY.md +++ b/docs/GLOSSARY.md @@ -11,13 +11,9 @@ understanding of this project's code.
PGx is an abbreviation of pharmacogenetics, the study of how pharmacology is affected by individual genes.
-
Drug
-
Linguistically synonymous to the term medication, but preferred - for this project. Ibuprofen is an example of a drug.
-
RxNorm, RxCUI
-
RxNorm is a US-specific standardized naming system for drugs. - RxNorm also defines IDs for drugs, known as +
RxNorm is a US-specific standardized naming system for + medications. RxNorm also defines IDs for medications, known as RxCUIs.
Trivia: Rx stems from the latin word recipe meaning "take". The first doctor to @@ -26,7 +22,7 @@ understanding of this project's code. "Rx concept unique identifier".
Indication
-
Defines the reason a drug is used, e.g. fever for ibuprofen.
+
Defines the reason a medication is used, e.g. fever for ibuprofen.
## Biomedical terms diff --git a/docs/User-instructions.html b/docs/User-instructions.html index a3eed8d9..e80c77fc 100644 --- a/docs/User-instructions.html +++ b/docs/User-instructions.html @@ -45,7 +45,7 @@

Getting Started with PharMe

Welcome to PharMe, an application to gain insights on your DNA's influence - on drugs! πŸ§¬πŸ’ŠπŸ€— + on medications! πŸ§¬πŸ’ŠπŸ€—

In the following, we will give you an overview on how to use the app. @@ -66,7 +66,7 @@

Getting Started with PharMe

To get started with PharMe, you first need to import your pharmacogenetic - (PGx) test data (data about your DNA and drugs you are taking) from your + (PGx) test data (data about your DNA and medications you are taking) from your data provider.

@@ -83,17 +83,17 @@

Getting Started with PharMe

After successfully importing data, you will get an overview about PharMe's - backgound and capabilities in a short onboarding. + background and capabilities in a short onboarding.

In the initial medication selection you can tell PharMe which medications - you are currently taking – if your PGx test data includes drugs you are - taking, they will be pre-selected here. + you are currently taking – if your PGx test data includes current + medications, they will be pre-selected here.

- Later in the app, you will be able to filter for drugs you are currently - taking; also, some drugs can influence your results for other drugs. Please - take your time here to make the most of PharMe. ☺️ + Later in the app, you will be able to filter for medications you are + currently taking; also, some medications can influence your results for + other medications. Please take your time here to make the most of PharMe. ☺️ @@ -120,9 +120,9 @@

Getting Started with PharMe



Selecting a gene will take you to its detail page, with further information - about your result and drugs that are influenced by this gene. For technical - terms (like "genotype"), you can always find explanations by tapping on the - question mark. + about your result and medications that are influenced by this gene. For + technical terms (like "genotype"), you can always find explanations by + tapping on the question mark. @@ -133,19 +133,21 @@

Getting Started with PharMe

- You can also view your PGx results by drug on the Drugs screen. - Here, you can search for drugs by their generic name, brand names, or drug - class. You can also filter the list by medications you are currently taking - and by warning levels (❌ ⚠️ βœ…). + You can also view your PGx results by medications on the Medications + screen. Here, you can search for medications by their generic name, brand + names, or class. You can also filter the list by medications you are + currently taking and by guideline result (❌ consider alternatives, + ⚠️ use with caution, and βœ… standard precautions).

- Selecting a drug (also on the gene detail page) leads to the drug's detail - page. + Selecting a medication (also on the gene detail page) leads to the + medication's page with further details.

- Here you see some general information about the drug and a short statement - what PGx guidelines say about your DNA and this drug. Fore more information, - the respective guideline is linked at the bottom of each drug page. + Here you see some general information about the medication and a short + statement what PGx guidelines say about your DNA and this medication. For + more information, the respective guideline is linked at the bottom of each + medication page. @@ -173,7 +175,7 @@

Getting Started with PharMe

We hope by using PharMe you will learn useful information about your DNA and - drugs! Have fun! πŸ’« + medications! Have fun! πŸ’«

diff --git a/pharme.code-workspace b/pharme.code-workspace index 45f9b56a..529bf466 100644 --- a/pharme.code-workspace +++ b/pharme.code-workspace @@ -36,14 +36,21 @@ "anni", "bupropion", "cinacalcet", + "clopidogrel", "CPIC", + "diplotype", + "diplotypes", "drugclass", "duloxetine", + "haplotype", + "haplotypes", "Hasso", + "Keycloak", "MedlinePlus", "Metabolizer", "Pharmacogenetics", "PharMe", + "phenoconversion", "Plattner" ] }