|
|
@@ -1,6 +1,9 @@
|
|
|
-### Setup
|
|
|
+# Usage
|
|
|
|
|
|
-CRFs are always part of a study. So, create study as you would normally do.
|
|
|
+## Initial setup
|
|
|
+
|
|
|
+CRFs are always part of a study. So, create study as you would normally do, keep subject
|
|
|
+identifier to ParticipantId, which is the default.
|
|
|
|
|
|
Once you do, you should enable CRF module.
|
|
|
See [LabKey documentation][labkeyEnableModule] on how to enable a module.
|
|
|
@@ -20,6 +23,102 @@ The initial set of setup lists is part of the distribution. Copy
|
|
|
and import list archive to Labkey in the study. You will get list of lists by
|
|
|
clicking on setup wheel at the top of the screen and selecting Manage lists.
|
|
|
|
|
|
+Create demographicData dataset as part of the study. Copy fields from demographicData list.
|
|
|
+Create reviewComments dataset. Copy fields from reviewComments list.
|
|
|
+Fields are copied by selecting a list, pushing Design button, scrolling to the bottom,
|
|
|
+clicking on Export Fields and Ctrl-C-ing the content of the pop-up window. Fields are
|
|
|
+paste into the pop-up window that opens by selecting a dataset, pushing Edit design,
|
|
|
+scrolling to the end and clicking on Import Fields.
|
|
|
+
|
|
|
+Add at least one site to the site list.
|
|
|
+
|
|
|
+Add at least one crfEditor and one crfReviewer, particularly adding yourself is a good idea.
|
|
|
+Adding is the same ass adding lines to the respective lists.
|
|
|
+
|
|
|
+## Setting up a form
|
|
|
+
|
|
|
+### Datasets
|
|
|
+
|
|
|
+Create a dataset as a list. Go to Wheel->Manage Lists and Create List. Setup fields as you would normally do.
|
|
|
+Three additional fields are required:
|
|
|
+
|
|
|
+- participantCode (String)
|
|
|
+- submissionDate (DateTime)
|
|
|
+- crfRef (String)
|
|
|
+
|
|
|
+[Here][exampleList] is an example included with the list archive.
|
|
|
+
|
|
|
+All datasets should be registered by adding them to the inputLists list. The sample
|
|
|
+dataset should already be a part of the inputList.
|
|
|
+
|
|
|
+### Forms
|
|
|
+CRF consists of a series of forms, contained in the Forms list.
|
|
|
+Each form is a logical assembly of datasets. Each form has a setup, which is a
|
|
|
+list which specifies which datasets are part of the form, and a title.
|
|
|
+The only programatical feature that a form has is that all its datasets
|
|
|
+should be completed before the form is submitted for review.
|
|
|
+Each form can be reviewed independently.
|
|
|
+
|
|
|
+Some fields are set to default values for historical reasons:
|
|
|
+
|
|
|
+- formUrl: visit0
|
|
|
+- reviewFormUrl: reviewVisit0
|
|
|
+- viewURL: visit0.view
|
|
|
+
|
|
|
+The last field, master query is to be set to the created dataset list. Each form
|
|
|
+has a master query that contains
|
|
|
+a participantCode field, and that is the field that will be used as the participant
|
|
|
+assignment field for all datasets in the form. The
|
|
|
+sample Forms list already has an entry for demographicsData dataset.
|
|
|
+
|
|
|
+### Form setup
|
|
|
+
|
|
|
+A form setup is a list of datasets in the form and contains the following fields:
|
|
|
+
|
|
|
+![setup list][setupList]
|
|
|
+
|
|
|
+For a new setup list entry, set Query Name to the dataset name with Title that can be any string.
|
|
|
+Other fields are set to NONE by default.
|
|
|
+
|
|
|
+![setup list example with NONE][setupListExample1]
|
|
|
+
|
|
|
+A more complex dataset layout might contain a sub-list, say list of medication, which
|
|
|
+is enabled by a flag which is part of the dataset. The name
|
|
|
+of the flag, which is a variable in the dataset, must be given as showFlag, the value
|
|
|
+where list is to be filled is the showFlagValue, and showQuery is the sublist query which will
|
|
|
+be shown, as the following example shows:
|
|
|
+
|
|
|
+![setup list example][setupListExample]
|
|
|
+
|
|
|
+## Filling the form
|
|
|
+
|
|
|
+Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Portal web part. This will show all forms that we will create. If the setup
|
|
|
+worked, the Demographics form should appear in the CRF tab.
|
|
|
+
|
|
|
+Once you click on create new, a new form is added to the list and the form
|
|
|
+completion portal opens. If you reload the CRF tab, or go back, you should
|
|
|
+see a new yellowish square which corresponds to the form just created. You can edit
|
|
|
+the form until you are ready to Submit it for further review
|
|
|
+
|
|
|
+## Submitting the form
|
|
|
+
|
|
|
+### Prepare datasets
|
|
|
+When the form gets submitted, a dataset should be created that will get filled with
|
|
|
+data from the (temporary) dataset list. To do that, go to Manage Datasets in
|
|
|
+Study management, and create a dataset. When asked for fields, click on Import fields and copy
|
|
|
+the output of Export fields, performed in the Design view of the List. For each list
|
|
|
+that gets filled, a mirror dataset is required. Then Submiting the list works.
|
|
|
+
|
|
|
+### Setup the review portal
|
|
|
+Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Review Portal web part. This will show all forms that were submitted. If the setup
|
|
|
+worked, the completed Demographics form should appear in the CRF Review tab.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
[studyParameters]: img/studyParametersSnapshot.png
|
|
|
+[exampleList]: img/exampleListSnapshot.png
|
|
|
[listArchive]: setup/initialLists.zip
|
|
|
-[labkeyEnableModule]: https://www.labkey.org/Documentation/wiki-page.view?name=enableModuleInFolder
|
|
|
+[labkeyEnableModule]: https://www.labkey.org/Documentation/wiki-page.view?name=enableModuleInFolder
|
|
|
+[setupList]: img/setupList.png
|
|
|
+[setupListExample]: img/exampleSetupList.png
|
|
|
+[setupListExample1]: img/exampleSetupList1.png
|
Andrej Studen
