Skip to content

Commit f5838dd

Browse files
rptaborptabo
committed
Copyedit markdown documents
1 parent e47d059 commit f5838dd

2 files changed

Lines changed: 60 additions & 63 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,60 @@
11
# demo-dr-form
2-
Demonstrator for Dr requested data with Form
2+
Demonstrator for doctor-requested data with a form
33

44
## Context
55

6-
A doctor sends a link to a patient.
6+
A doctor sends a link to a patient.
77

8-
From this link the patient
8+
From this link the patient:
99

10-
- Sees a short presentation of HDS including a link to HDS web site for more details.
11-
- Can register to HDS or Sign-in
10+
- Sees a short presentation of HDS including a link to the HDS web site for more details.
11+
- Can register for HDS or sign in
1212

13-
When signed in the patient sees a from to complete. If the patient is returning to the form he can update exsiting data.
13+
When signed in the patient sees a form to complete. If the patient is returning to the form he can update existing data.
1414

15-
- As an opt-in the patient can allow HDS to access non medical data in order to present HDS concept and capabilities during patient webinars.
15+
- As an opt-in the patient can allow HDS to access non-medical data in order to present HDS concepts and capabilities during patient webinars.
1616

17-
The patient also has a page to see who has or had access to his data.
17+
The patient also has a page to see who has or had access to his data.
1818

19-
The doctor has a page where he can see individual's data and aggregated data and export it
19+
The doctor has a page where he can see individuals' data and aggregated data and export it.
2020

21-
## Logic drafting
21+
## Logic drafting
2222

23-
Based on [Pryv.io](https://api.pryv.com)
23+
Based on [Pryv.io](https://api.pryv.com)
2424

25-
- Dr has an HDS "controlling account" where the credentials to access to patient's data will be kept
26-
- The link sent to patient contains the necessary credentials to
25+
- Doctor has an HDS "controlling account" where the credentials to access patients' data will be kept
26+
- The link sent to a patient contains the necessary credentials to:
2727
- Get the list of specific questions (for the doctor)
28-
- Allow patients to post credentials to access their data
28+
- Allow patients to post credentials to access their data
2929

3030
### Inspiration
3131

3232
**2 demo apps**
3333
1- [Collect web app](https://pryv.github.io/example-apps-web/collect-survey-data/?pryvServiceInfoUrl=https://demo.datasafe.dev/reg/service/info) to login / register and collect data
34-
2- [View and share web app](https://pryv.github.io/example-apps-web/view-and-share/index.html?pryvServiceInfoUrl=https://demo.datasafe.dev/reg/service/info) to view the data and create a share link
34+
2- [View and share web app](https://pryv.github.io/example-apps-web/view-and-share/index.html?pryvServiceInfoUrl=https://demo.datasafe.dev/reg/service/info) to view the data and create a share link
35+
3536
Base concepts are present, but the flow needs to be adapted
3637

3738
## Contents
3839

39-
### Text to be translated in English to present HDS
40+
### Overview of HDS
4041

41-
Le Health Data Safe est une initiative à but non lucratif visant la protection et la valorisation des données de santé, à commencer par celles des femmes utilisant les méthodes d’observation du cycle (MOC). Cet outil permettra aux utilisatrices et utilisateurs un contrôle complet de l’utilisation de leurs données aux seules fins de l’amélioration de leur santé personnelle ou de recherches médicales validées par un Comité éthique. Les bénéficiaires de cette solution pourront contrôler à tout moment l'accès à leurs données et leur participation à telle ou telle recherche. Ce portail de données sera pleinement compatible avec les solutions déjà en place et permettra une utilisation aisée et sécurisée des organisations participantes. Avec cet outil, les partenaires (soignants, accompagnateurs) ancrés dans une vision hippocratique de la médecine pourront considérablement accélérer la recherche médicale sur le cycle féminin et mettre à disposition de toutes et tous des solutions innovantes pour améliorer la santé féminine et la connaissance du cycle féminin.
42+
Health Data Safe is a non-profit initiative aimed at protecting and enhancing health data, starting with that of women using cycle observation methods (COMs, also known as FABM or NFP). This tool will give users complete control over the use of their data for the sole purpose of improving their personal health or for medical research validated by an ethical committee. Beneficiaries of this solution will be able to control access to their data and their participation in specific research projects at any time. The data portal will be fully compatible with existing solutions, enabling participating organizations to use it easily and securely. With this tool, partners (caregivers, companions, etc.) rooted in a Hippocratic vision of medicine will be able to considerably accelerate medical research into the female cycle, and make innovative solutions to improve women's health and knowledge of the female cycle available to all.
4243

4344
### Questions list
4445

4546
* First Name *
4647
* Last Name *
47-
* Maid name
48+
* Maiden name
4849
* Country
49-
* Date of birth *
50+
* Date of birth *
5051
* City
51-
* Sexe
52+
* Sex
5253
* Email *
5354
* Height
54-
* Weight
55-
* Number of born children
56-
* Number of miscarriages
55+
* Weight
56+
* Number of children born
57+
* Number of miscarriages
5758
* Trained in FABM/NFP yes/no/precise
5859

5960
Creighton (CrM)
@@ -64,28 +65,25 @@ Billings
6465

6566
FEMM
6667

67-
Other cervical fluid only method : precise
68+
Other cervical fluid only method: precise
6869

6970
Sensiplan
7071

7172
Neo Fertility
7273

7374
Cervical fluid associated with the Natural Cycles° App
7475

75-
Other Symptothermal method : precise
76+
Other Symptothermal method: precise
7677

7778
Marquette
7879

7980
Boston Cross Check
8081

81-
Other Cervical Fluid + Hormonal Test Methods, precise
82+
Other Cervical Fluid + Hormonal Test Methods: precise
8283

8384
Other Calendar Based Methods
8485

85-
Other : precise
86+
Other: precise
8687

87-
* Estimated number of feminine cycle charted so far
88+
* Estimated number of feminine cycles charted so far
8889
* TTC / TTA scale : https://fertilityawarenessmethodofbirthcontrol.com/fertility-intentions-scale/
89-
90-
91-

‎Technical_flow.md‎

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
1-
First version
1+
First version
22

3-
## Dr Account
3+
## Doctor Account
44

5-
Dr has an HDS account to
5+
A doctor has an HDS account to:
66

77
1. Collect the authorization to access data by patients.
8-
2. Define forms (will be done in a second steps)
9-
- The forms content should be encoded in JSON providing the necessary information for the WebApplication for patient give information on the data collected and provide from to the patient.
10-
- In the First demo release, the form will be hard-coded in the App.
8+
2. Define forms (will be done in a later step)
9+
- The forms content should be encoded in JSON providing the necessary information for the patient web application to give information on the data collected and provided by the patient.
10+
- In the first demo release, the form will be hard-coded in the app.
1111

1212
```
13-
Streams structure of a Dr Account
13+
Streams structure of a doctor account
1414
- patients
15-
- patients-inbox: where new patients are posting
16-
their credentials to access the data.
15+
- patients-inbox: where new patients are posting
16+
their credentials to access the data.
1717
For the demo this may be sufficient
18-
- patients-validated: contains validated patient
18+
- patients-validated: contains validated patient
1919
(credentials are moved from Inbox in this stream)
2020
- Forms
2121
- Questionnaire A
2222
- Questionnaire B
2323
- Questionnaire ...
24-
2524
```
2625

27-
### Patient accounts
26+
### Patient Accounts
2827

2928
They contains personal data with the following streams
3029

3130
(emails are already used for registration)
3231

3332
```
3433
- profile
35-
- profile-name: Name / Surname
34+
- profile-name: First name / Last name
3635
- event of type "contact/name-surname" & "contact/maiden-name" or "contact/vcard"
3736
- profile-address: - event of type "contact/country"
3837
- profile-date-of-birth: - event of type "date/iso-8601"
@@ -43,13 +42,13 @@ They contains personal data with the following streams
4342
- fertility
4443
- fertility-miscarriages: events of type "count/generic"
4544
- awarness-training: events of type "training/fabm-v1"
46-
Event or streams content to be defined (see bellow)
45+
Event or streams content to be defined (see below)
4746
- fertitity-cycles
4847
- fertitity-cycles-charted-estimation: "generic/count"
49-
- ttc-tta: "fertility-intention/ttc-tta" (see bellow)
48+
- ttc-tta: "fertility-intention/ttc-tta" (see below)
5049
- body
51-
- body-height: -event of type "length/*" meters or ...
52-
- body-weigth: -event of type "mass/*" kg or ...
50+
- body-height: - event of type "length/*" meters or ...
51+
- body-weigth: - event of type "mass/*" kg or ...
5352
- demo-dr-form: (stream to track states and usage of this app)
5453
- inbox
5554
- accepted
@@ -58,41 +57,41 @@ They contains personal data with the following streams
5857

5958
##### Tracking fertility awareness contents
6059

61-
Here we have the possibilty to create either 1 specific event type containing a string with the method or a stream per method and add more information afterwards. As this is a prototype, we'll have to discuss what's the easiest implementation considering Front-end perspective.
60+
Here we have the possibility to create either 1 specific event type containing a string with the method or a stream per method and add more information afterwards. As this is a prototype, we'll have to discuss what's the easiest implementation considering the frontend perspective.
6261

6362
##### Tracking fertility intention
6463

65-
Create an event type of `fertility-intention/ttc-tta` based on https://fertilityawarenessmethodofbirthcontrol.com/fertility-intentions-scale/
66-
64+
Create an event type of `fertility-intention/ttc-tta` based on https://fertilityawarenessmethodofbirthcontrol.com/fertility-intentions-scale/
6765

6866

6967
### Technical flow
7068

7169
#### **Requirements**
7270

73-
For each form, an `apiEndpoint` is created upfront with the following credentials
74-
*For the demo, this will be hand made, in the future, this will be created from Dr's FrontEnd*
71+
For each form, an `apiEndpoint` is created up-front with the following credentials
7572

76-
```
73+
*For the demo, this will be hand made; in the future, this will be created from the doctor's frontend*
74+
75+
```
7776
[
7877
{streamId: "patients-inbox", level: "create-only"},
7978
{streamId: "questionnary-x", level: "read"}
8079
]
8180
```
8281

83-
This will allow the Patient's app to publish it's authorization to the Dr's Account
82+
This will allow the patient's app to publish its authorization to the doctor's account.
8483

85-
##### Flow Patient Web App
84+
##### Patient web app flow
8685

87-
The link to the patient webApp contains in its query the Doctor's apiEndpoint
86+
The link to the patient web app contains in its query the doctor's apiEndpoint.
8887

89-
1- The WebApp query HDS to figure out which questionnaire to display (hardcode 1st version)
88+
1- The web app queries HDS to figure out which questionnaire to display (hardcoded in the 1st version)
9089

91-
2- The WebApp present the description of HDS, the recipient of the form (the Dr) and propose to register or login in
90+
2- The web app presents the description of HDS, the recipient of the form (the doctor), and prompts to either register or login in
9291

93-
3- After Log-In the App receives and API endpoint
92+
3- After log-in the app receives an API endpoint
9493

95-
- The app check the state of this form with the latest event in `demo-dr-form` stream event-type `demo-dr-form-state/questionnary-x`
96-
- If this is the first time the use logs-in with this form the WebApp creates and `sharing` api-endpoint for the Dr and publish it in his `inbox` stream
94+
- The app checks the state of this form with the latest event in the `demo-dr-form` stream event-type `demo-dr-form-state/questionnary-x`
95+
- If this is the first time the user logs in with this form, the web app creates a `sharing` api-endpoint for the doctor and publishes it in his `inbox` stream
9796

98-
4- The form is presented to the patient with "pre-filled" data from eventual existing info.
97+
4- The form is presented to the patient with "pre-filled" data from any existing info.

0 commit comments

Comments
 (0)