Skip to content

Commit

Permalink
Update SOP_DISEASES.md
Browse files Browse the repository at this point in the history
Changed instructions to define fields to adding the disease to the "New disease" column instead of editing the "Diseases" column
  • Loading branch information
MateStrysewske authored Nov 11, 2019
1 parent 442641d commit c033df3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions SOP_DISEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This file defines the SOP (Standard Operating Procedure) that should be followed
### Step 1: Download the Data Dictionary
Download the latest [Data Dictionary](https://github.com/hzi-braunschweig/SORMAS-Project/raw/development/sormas-api/src/main/resources/doc/SORMAS_Data_Dictionary.xlsx) from this repository and open it. Please never use a version of the Data Dictionary that you downloaded earlier as it is very likely that its contents have changed in the meantime.

You will use the Data Dictionary to define all the details of the new disease. Please change the background of every row that you're editing (e.g. to a subtle red) to make sure that we don't miss any of the information you have provided.
You will use the Data Dictionary to define all the details of the new disease. Please make sure to mark every addition or change (e.g. by colorizing the text or background of the row in a subtle red) so we don't miss any of the information you have provided.

### Step 2: Define Basic Disease Details
Open the **Case** tab of the Data Dictionary and scroll down to the tables that have a blue background. These tables define *enumerations*, which are basically data types with fixed values. Examples include the different case classifications, the gender of a person or the diseases that are used in SORMAS. Find the **Disease** enumeration table (refer to the *Type* column) and add a new row to it. Enter the following details:
Expand All @@ -32,23 +32,23 @@ Use the *Description* column to answer the following question(s):
* If yes, for **how many days** should contact follow-up be done?

### Step 3: Define Existing Case Fields
Look through the rows in the first table of the **Case** tab (which has a grey background). This table defines all the fields that are displayed in the *Case Information* tab in the SORMAS application. The *Caption* column defines the name of the field as it is displayed in the user interface, while the *Diseases* column specifies which diseases use this field. In general, you won't have to care about the fields that are used for *All* diseases as it's very likely that your new disease will also use them. However, for all fields that are only used for a subset of the diseases in SORMAS, consider whether they are relevant for your new disease. If so, add the name or, if available, short name of the new disease to the *Diseases* column.
Look through the rows in the first table of the **Case** tab (which has a grey background). This table defines all the fields that are displayed in the *Case Information* tab in the SORMAS application. The *Caption* column defines the name of the field as it is displayed in the user interface, while the *Diseases* column specifies which diseases use this field. Please add the name (or, if available, short name) of your new disease to the "New disease" column of every row that represents a field that is relevant for it and colorize it.

### Step 4: Define Existing Person Fields
Open the **Person** tab and repeat step 3 for the first table containing the fields that define the details of a person in SORMAS. Again, your new disease will most likely use most of these fields, but you will have to add the name of your new disease to the rows that specifically define a subset of diseases.
Open the **Person** tab and repeat step 3 for the first table containing the fields that define the details of a person in SORMAS.

### Step 5: Define the Relevant Symptoms
Open the **Symptoms** tab which lists all the symptoms that are currently used in SORMAS. This is a very long list and you will have to go through every single row and define whether this symptom should be tracked for your new disease or not. For rows that define a subset of diseases in the *Diseases* Column, simply add the name or short name of your new disease to the end of the list (and change the row background) or leave it as it is if it should not use the symptom. For rows that specify *All* in the *Diseases* column, you can leave them as they are if your new disease should also use them. If your disease should **not** use a symptom that is currently used by all other diseases, please change the row background and add the name of your disease to the *Diseases* column with a preceding **NOT**. This will make sure that we properly exclude the disease from the list.
Open the **Symptoms** tab which lists all the symptoms that are currently used in SORMAS. This is a very long list and you will have to go through every single row and define whether this symptom should be tracked for your new disease or not.

It's possible that your new disease uses one or more symptoms that are currently not part of SORMAS. In that case, you need to add a new row for each of these symptoms to the bottom of the table and provide the **name of the symptom** in the *Caption* column.

Most symptoms in SORMAS are simple *Yes/No/Unknown* fields where *Yes* means that the symptom is present, *No* that the symptom is not present and *Unknown* that there is no information about whether the symptom is present or not. If your symptom can simply be defined by this pattern, you don't have to specify anything else. However, if your symptom is more complex (e.g. there are a number of pre-defined values that the user should choose from), please provide all the necessary details about how the symptom should be specified by users in the *Description* column.

### Step 6: Define the Relevant Epidemiological Data
Open the **Epidemiological data** tab which lists all fields that are used to collect information about the epidemiological background of the case, e.g. whether they visited burials, had contact with a confirmed case or animals. Repeat step 5 for all rows in the first table, and add new rows if your new disease requires information that is not currently collected within SORMAS. As new fields in this tab are likely to be more complex than basic symptoms, make sure to define as much information about how they should function in the *Description* column.
Open the **Epidemiological data** tab which lists all fields that are used to collect information about the epidemiological background of the case, e.g. whether they visited burials, had contact with a confirmed case or animals. Repeat step 3 for all rows in the first table, and add new rows if your new disease requires information that is not currently collected within SORMAS. As new fields in this tab are likely to be more complex than basic symptoms, make sure to define as much information about how they should function in the *Description* column.

### Step 7: Define Health Conditions
Open the **Health conditions** tab which contains a list of pre-existing conditions that are not symptoms of the disease, but are still relevant especially for case management purposes in a hospital. Repeat step 5 for all rows in the first table, and add new rows if there are health conditions relevant for your new disease that are not part of SORMAS yet. As always with new fields, make sure to provide all relevant details in the *Description* column.
Open the **Health conditions** tab which contains a list of pre-existing conditions that are not symptoms of the disease, but are still relevant especially for case management purposes in a hospital. Repeat step 3 for all rows in the first table, and add new rows if there are health conditions relevant for your new disease that are not part of SORMAS yet. As always with new fields, make sure to provide all relevant details in the *Description* column.

### Step 8: Define New Fields in Other Areas
It is possible that your disease requires further information to be collected that is not supported by SORMAS yet, e.g. new details about the person, specific information about its hospitalization, or even very important fields that should directly go into the case information. You can use the same process you used to define new symptoms, health conditions or epidemiological data fields by opening the tab in question and adding new rows to the topmost table.
Expand Down

0 comments on commit c033df3

Please sign in to comment.