-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsample_data.txt
More file actions
1984 lines (1488 loc) · 374 KB
/
sample_data.txt
File metadata and controls
1984 lines (1488 loc) · 374 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Q1: How much experience with programming, networking and/or database construction is required to use REDCap?
A1: No programming, networking or database experience is needed to use REDCap. Simple design interfaces within REDCap handle all of these details automatically.It is recommended that once designed, you have a statistician review your project. It is important to consider the planned statistical analysis before collecting any data. A statistician can help assure that you are collecting the appropriate fields, in the appropriate format necessary to perform the needed analysis.
--------------------
Q2: Where can I suggest a new REDCap feature?
A2: You can suggest a new REDCap feature by clicking on the "Suggest a New Feature" link located at the bottom of the left hand pane of a project. The link is under the "Help & Information" header.
--------------------
Q3: Can I still maintain a paper trail for my study, even if I use REDCap?
A3: You can use paper forms to collect data first and then enter into REDCap. All REDCap data collection instruments can also be downloaded and printed with data entered as a universal PDF file.
--------------------
Q4: Can I transition data collected in other applications (ex: MS Access or Excel) into REDCap?
A4: It depends on the project design and application you are transitioning from. For example, there are a few options to get metadata out of MS Access to facilitate the creation of a REDCap data dictionary:For Access 2003 or earlier, there is a third-party software (CSD Tools) that can export field names, types, and descriptions to MS Excel. You can also extract this information yourself using MS Access. Table names can be queried from the hidden system table "MSysObjects", and a table's metadata can be accessed in VBA using the Fields collection of a DAO Recordset, ADO Recordset, or DAO TableDef.The extracted metadata won't give you a complete REDCap data dictionary, but at least it's a start.Once you have a REDCap project programmed, data can be imported using the Data Import Tool.For additional details, contact your local REDCap Administrator.
--------------------
Q5: Is it possible to transfer a project to a different person?
A5: There is no project user right in REDCap called "Owner." You could create a role called "Owner" - which would clearly designate which user is the project owner in the User Rights section (with appropriate permissions). Usually the owner is the user with the right to grant project access to other users.Add the new owner to the project as a user with appropriate rights and remove old owner in the User Rights section of the project.For purposes of project identification - you might also want to change the "Name of PI (if applicable)" in "Modify project title, purpose etc."
--------------------
Q6: What are the password rules for table-based accounts?
A6: The REDCap password for users in the table-based authentication mode must be at least 9 characters in length and must consist of at least one lower-case letter, one upper-case letter, and one number.
--------------------
Q7: Why are date, time and number formats in user preferences not applied on instruments?
A7: This is the expected behavior. A field's date or number format is part of the field definition that you set in the Online Designer or Data Dictionary.Personal user preference is used essentially anywhere else (outside surveys and data entry forms and reports). This includes displaying numbers for stats, timestamps in the log and so on..
--------------------
Q8: Can I use copyrighted materials in my REDCap project?
A8: Copyrighted materials can be used in REDCapif1) you have permission from the copyright holder (when required); and 2) you follow all terms the holder specifies. The REDCap Shared Library provides a curated library of instruments with copyrights approved for use in REDCap, in accordance with the provided terms of use that you must sign. If you have specific questions about your usage of a library instrument, including the terms of use, please reach out to the copyright holder directly.
--------------------
Q9: What is form display logic?
A9: Form display logic is an advanced feature that uses conditional logic to disable specific data entry forms in the user interface on the Record Status Dashboard, Record Home Page, or record-level form list on the left-hand menu. Forms that have conditions specified will remain disabled until one of its conditions is met.Form display logic is set up in the Online Designer after instruments have been built in the project. You will select what forms you would like to disable and supply logic saying when they should be available. A form can be selected in multiple conditions, but will be enabled if at least one of the conditions is met.Please note that form display logic does not affect data imports and is not utilized by the Survey Queue. However, it can affect the behavior of the Survey Auto-Continue feature if certain optional settings are enabled.
--------------------
Q10: Does the order of fields matter when you use field embedding?
A10: Field embedding best practice would be to put the parent/container field (where the field(s) are embedded) BEFORE the fields being embedded. This is especially true when dealing with field embedding and branching logic.
--------------------
Q11: What happens to ASI's Alerts/Notification and other emails when the system is set to offline?
A11: When REDCap is offline, automation like ASI, Alerts & Notifications are disabled. When your system is brought back online the cron job will run and catch up on the automation that should have been evaluated when it was offline.
--------------------
Q12: What are Automated Survey Invitations?
A12: For any survey in your REDCap project, you may define your conditions for Automated Survey Invitations that will be sent out for a specified survey. This is done on the Online Designer page. Automated survey invitations may be understood as a way to have invitations sent to your survey participants, but rather than sending or scheduling them manually via the Participant List, the invitations can be scheduled to be sent automatically (i.e. without a person sending the invitation) based upon specific conditions, such as if the participant completes another survey in your project or if certain data values for a record are fulfilled.Below are some guidelines to keep in mind when creating automated survey invitations:The 'today' variable should be used only in conjunction with datediff. Comparing 'today' to a date is unreliable.It's a good practice to set up a field that can be used to explicitly control whether or not any invitations should be scheduled for a record. This allows for logic like the following:datediff([surgery_arm_2][surgery_date], 'today', 'd', true) >= 6 and [enrollment_arm_1][prevent_surveys] != '1'All fields in all forms on all arms are always available to the conditional logic of an ASI rule. If there is no value saved for that field, an empty string is used.
--------------------
Q13: Do automated survey invitations preclude manual survey invitations?
A13: Automated survey invitations do not preclude manual survey invitations or vice versa. An automated survey invitation will not be scheduled if an automated survey invitation has previously been scheduled, but if an automated survey invitation's logic is checked and found to be true, a survey invitation will be scheduled regardless of whether or not a survey invitation has been previously scheduled manually. Likewise, if an automated survey invitation has been scheduled, one can still schedule a survey invitation manually.
--------------------
Q14: When are automated survey invitations sent out?
A14: Automated Survey Invitations are survey invitations that are automatically scheduled for immediate or future sending when certain conditions are true.Creating an automated survey invitation requires:Composing an email message.Specifying the conditions that will trigger an email to be scheduled.Specifying how to schedule the triggered email (such as: immediately, after a delay, on a specific day).NOTE: In previous versions, conditions that used the "today" variable would require extra effort to make sure they were checked every day, but REDCap now detects and checks those conditions daily. The conditions are checked every twelve hours. The specific times they are checked during the day varies from one instance of REDCap to the next and changes over time.
--------------------
Q15: Is there any tool that can help me figure out how to set up ASI?
A15: This linkSurvey Wizard: Automated Survey Invitations (ASIs)will take a user to a survey algorithm that was created by the Training Collaboration Committee using REDCap version 8.8.1. It addresses general ASI how to with components and examples of different setups.(URL:https://redcap.vumc.org/surveys/?s=LKM4DPEHL4)
--------------------
Q16: Can you base ASI on Calendar/Event dates?
A16: No. Dates generated by the calendar application cannot be used in Automated Survey Invitation (ASI) logic.ASIs can be scheduled using the same "days offset" parameters defined for your events in four ways using the send-time option.Option 1: X days after: the exact time the automated invitation was triggeredOption 2: X days after: the same day (beginning at midnight) that the automated invitation was triggedOption 3: X days after: a date fieldOption 4: X days after: a date/time fieldExample days/times an ASI will be sent for each optionIf a baseline survey is completed for the baseline event on January 1 at 12:00 pm, and a follow-up event (offset by two days) has an ASI configured to send 2 days after the baseline survey is completed:Option 1: January 3 at 12:00 pmOption 2: January 3 at 12:00 amOption 3: January 3 at 12:00 amOption 4: January 3 at the time captured on the date/time field
--------------------
Q17: How can I schedule a survey invitation to go out at a specific time?
A17: You can use a form of scheduling that allows you to specify next day, next Monday, etc. However that form of scheduling will not allow you to specify a lapse of a certain number of days.
--------------------
Q18: What mathematical operations can be used in the logic for Automated Survey Invitations?
A18: + Add- Subtract* Multiply/ Divide
--------------------
Q19: How do I use the datediff function with ASI syntax for conditional logic?
A19: You can calculate the difference between two dates or times by using the function:datediff([date1], [date2], "units", returnSignedValue)[date1] and [date2] are fields (variables) in your project.units"y"years1 year = 365.2425 days"M"months1 month = 30.44 days"d"days"h"hours"m"minutes"s"seconds· Both datesMUSTbe in the same format (i.e., M-D-Y, Y-M-D, or D-M-Y) in calculated fields in instruments. The exception to this rule is the use of thedatedifffunction in Automated Survey Invitations (ASIs) (see examples below).· For comparing two Time HH:MM fields, the date format is irrelevant.returnSignedValuefalse(default)true· The parameterreturnSignedValuesets the result to be signed or unsigned (absolute value), in which the default value isfalse, which returns the absolute value of the difference. For example, if [date1] is later than [date2], then the result will be negative if returnSignedValue is set totrue. If returnSignedValue is not set or is set tofalse, then the result will ALWAYS be a positive number. If returnSignedValue is set tofalseor not set, then the order of the dates in the equation does not matter because the resulting value will always be positive.Examples:Calculating the Difference Between 2 Date Fieldsdatediff([dob],[date_enrolled],"y")Calculated Field in an InstrumentThe [dob] and [date_enrolled] fields must be entered in the same format (i.e., M-D-Y, Y-M-D, or D-M-Y). This equation yields the number of years between the date of birth and date enrolled. Since the returnSignedValue has been left blank, it defaults to false, which means the result will be positive only.datediff([dob],[date_enrolled],"y")>=5Automated Survey InvitationsWhen the same equation (with added conditional logic “>=5”) is used in an Automated Survey Invitation (ASI), the formats of the two date fields can differ. The equation will work regardless of whether or not the two date fields match in format. It is still best practice to use the same date format for all dates in the project if possible.If used in an ASI, this equation states the invitation will be sent when the number of years between the date of birth and date of enrollment is greater than or equal to 5.Calculating the Difference Between a Date Field and a Static Datedatediff([date_enrolled],"08-31-2020","d",true)Calculated Field in an InstrumentWhen this datediff equation is used in a calculated field in an instrument, it yields the number of days between August 31, 2020, and date enrolled. Setting the static date as “08-31-2020” assumes the [date-enrolled] field is also entered in M-D-Y format. If the format of the [date_enrolled] field is Y-M-D or D-M-Y, the format of the static date (August 31, 2020) must match. Because returnSignedValue is set to true, the value will be negative if the [date_enrolled] field value is more recent than August 31, 2020.datediff([date_enrolled],"2020-08-31","d",true)>=0ORdatediff([date_enrolled],"08-31-2020","d","mdy",true)>=0Automated Survey InvitationsWhen the same equation (with added conditional logic “>=0”) is used in an Automated Survey Invitation (ASI), you have 2 options:(1) Enter the static date (August 31, 2020) inY-M-D format, regardless of the format in which [date_enrolled] is entered. The field [date_enrolled] can be entered in a different format than Y-M-D.(2) Enter the static date in any format you wish, but then add the matching date format parameter in quotes between the “unit” and true/false. For example, if you format the static date as M-D-Y, you would add the parameter “mdy” between “d” and true. The field [date_enrolled] can be entered in any format. Again, it is still best practice to use the same date format for all dates in the project if possible.If used in an ASI, this equation states the invitation will be sent to participants whose date of enrollment was on or before August 31, 2020, but not to participants who enroll after August 31, 2020.
--------------------
Q20: If I create a timestamp field, including hours, minutes, and days, can I create an automated survey invitation that will detect how many days it has been since the timestamp?
A20: It's possible, but if you do this be aware that the server-side (PHP) datediff function always treats the 'today' keyword as being the first second of the day. If your timestamp value is at six pm (18:00:00), then an ASI checking the datediff on the same day as that timestamp will actually return a result of 0.75 days. On the next day it will return 0.25 days, regardless of what time of day it is checked. On succeeding days it will return 1.25, 2.25, 3.25, etc.
--------------------
Q21: How can I use automated survey invitations to send invitations a specific number of days after a date given by a variable?
A21: Suppose you want to send a followup survey seven days after a surgery. You could define the condition of an automated survey invitation rule to detect that six days have passed since the surgery date and then schedule the survey invitation to be sent on the next day at noon. By checking for the sixth day instead of the seventh day, you gain the ability to set the specific time to send the invitation and you gain the opportunity to stop the sending of the invitation, if it turns out that you don't really want to send it.The conditional logic would look like: datediff([surgery_date], 'today','d',true) >= 6You could, instead, check that one day has passed and then set the invitation to be sent six days later, but you would lose the ability to set the specific time that the invitation is sent.
--------------------
Q22: Is there any way to send a survey prior to a specific date e.g. if a surgery is scheduled 60 days from now and they would want the survey to be sent 14 days prior to that?
A22: There are two ways to get this done:Method 1:One is to use the option, "Send the invitation X days Y hours Z minutes before [date_field]" in the Automated Survey Invitation (ASI) setup. Choose the "date of surgery" field as the reference field. Note that this field needs to be date- or datetime- validated to appear in the field dropdown. Set up the options so it reads "14 days before [surgery_date]" to finish configuring Step 3.To configure Step 2, you will need to define how the ASI will be triggered / scheduled. The ASI should be set up to trigger *after* your "date of surgery" field is populated:To schedule the invite when a particular survey is completed, choose the survey from the dropdown menu.To schedule the invite when a non-survey form is marked as complete, use the ASI logic:[your_form_name_complete] = '2'To schedule the invite once the surgery date is populated and saved, use the ASI logic:[surgery_date] <>''Method 2:The "classic" method is to define adatediffcalculation in Step 2, under "When the following logic becomes true." By computing number of days between 'today' (or 'now') and the surgery date, you could have it so the invitation is scheduled when 'today' is 14 days before the date of the surgery, like so:datediff('today', [baseline_arm_1][surgery_date], 'd', true) <= 14datediff('now', [baseline_arm_1][surgery_date_and_time], 'd', true) <= 14Since (1) usingdatediffwith 'now' and a datetime field can return days in a decimal format (e.g., 14.123) and (2) to resolve timing issues when "Ensure logic is still true" option is checked off, it is a best practice to use the "less than or equal to" (<=) operator so the ASI triggers as expected.To configure Step 3 in this method, you can choose "Send Immediately," or select "Send on next < day> at < time>" to customize when you would like the invitation to be sent once the ASI triggers.Regardless of the method chosen, if you have conditional logic set up in Step 2's "When the following logic comes true," another consideration is WHETHER to check the"Ensure logic is still true"box. In general, it is advisable not to check the "Ensure logic is still true" box if the Step 3 delay is short (e.g., if you chose "Send Immediately"). In other cases, you WANT to re-check.Additionally, an emergency "kill switch" for ASIs is recommended. This would be a radio or a checkbox field that stops ALL ASIs for a person. This is useful if a participant drops out of the study or otherwise is no longer interested in your emails. For example, with a kill switch, your ASI logic may look like the following:datediff('now', [baseline_arm_1][surgery_date_and_time], 'd', true) <= 14AND [baseline_arm_1][stop_emails(1)] = '0'Another tip is to use a Data Quality rule to "test" your ASI logic. Build a few test records with various surgery dates and run your custom DQ rule to make sure it is triggering when you want. Trying to test with the REAL ASI is problematic as it only fires once per record ID.
--------------------
Q23: How do variables included via piping interact with an automated survey invitation?
A23: Piped variables are included in a survey invitation ONLY at the point that the ASI determines that an invitation should be scheduled. If the invitation is scheduled to be sent in the future, and a piped variable is later changed before the scheduled invitation is sent, that change will NOT be included in the already scheduled invitation.
--------------------
Q24: How often does REDCap check to see if Automated Survey Invitations (ASI) are ready to be scheduled?
A24: Every time a record is created or modified (through the user interface or via data imports), it checks to see if an ASI invitation is ready to be scheduled. But for specific ASIs that have logic using the "datediff" function with either "today" or "now" (which means that the result of the ASI logic can change on its own from day to day), there is a cron job in REDCap that runs every 4 hours which will check these to see if an ASI invitation should be scheduled. Once the invitation is scheduled, a different cron job checks every minute to see if there are any survey invitations ready to send and sends them.
--------------------
Q25: If a survey has already been completed, will the scheduler still send out survey invitations?
A25: There are a variety of reasons why survey invitations might be in the schedule to be sent even though a survey is already completed. The survey invite might have been both manually scheduled and automatically scheduled. The survey invite might have been scheduled but then the URL for the survey sent to the participant directly.Regardless, the scheduler will not send out a survey invitation for an already completed survey.
--------------------
Q26: Do participants with partially completed surveys receive the automated survey invitation reminders?
A26: Yes, participants will continue to receive automated survey reminders if they have not completed the survey or they have a partially completed survey response.
--------------------
Q27: How do you stop survey reminders?
A27: First, change the ASI so that no more reminders get scheduled. Then delete the reminders from the Survey Invitation Log, either individually or by selecting the batch you want to delete and using the "Delete all selected" button.
--------------------
Q28: How can I use REDCap to support a network of investigators?
A28: A local installation of REDCap can support a grant-supported network of investigators if your institution holds the network grant even though investigators may be running sub-projects at other institutions. However, you should be very deliberate up front in determining the inclusion/exclusion criteria for projects and investigators who can utilize the local REDCap installation. In your model, you need to ensure that you don't have one set of support policies/pricing for 'local' researchers and another for 'non-local' researchers (presumably you'll have network grant funding covering infrastructure and training support for the entire network).You should think about how you will discontinue services and handle study data closeout should the network be disbanded at some point in the future. Finally, from a practical standpoint, it is recommended that you make sure you are proactive about establishing data sharing policies across the institutions within your network. In some cases, failure of such policies to meet the needs of all network members has caused the group of network sites to install separately licensed versions of REDCap for data hosting, but still maintain economy of scale by setting up a unified training/support core for network investigators.
--------------------
Q29: Who, other than members of my institution, can use my licensed REDCap software?
A29: If you are coordinating a multi-center study where the PI is at your local institution, you are well within your rights to use REDCap to support the study. On the other hand, if you want to use your local REDCap installation to support researchers at another institution (for single- or multi-center studies) where you don't have a local researcher involved in the study, this can be a violation of the licensing agreement.Offering external research teams the use of a REDCap installation on a fee-for-service basis (or even gratis) is strictly forbidden under the licensing model.
--------------------
Q30: Does REDCap work on mobile devices like tablets and smart phones?
A30: Yes! REDCap is entirely web-based; you can access it from any browser, anywhere on the planet, at any time.No separate app, download, or software installation is needed. The view will automatically be optimized for whatever device is being used.REDCap is compatible with (and can be used on) desktop computers, laptops, tablets (including iPads), smart phones (both Android and Apple), and any other device having an internet connection. There are no specific requirements to run REDCap on any of these devices and no known compatibility issues.On most tablets, the default view is the same as a desktop computer. All features are available.On most phones, the default view is REDCap Mobile - a view focusing on data entry. Not all features are available in this view. Any time you are on a smart phone, you can switch to desktop view at any time to get the full use of REDCap.NOTE: REDCap can also be used on mobile devices in areas having no internet connection. Refer to the section 'Q: What is the REDCap mobile app?' to learn more about this separate feature.
--------------------
Q31: I won't have internet access where I need to use REDCap. Is there an offline version?
A31: If you don't have internet access, you cannot use online REDCap. In such a situation, there are three potential methods to collect data for use in REDCap later. Those three methods are described below.The lack of internet coverage in remote areas could be a significant challenge to using REDCap. There are absolutely success stories in similar situations. We know of several studies operating REDCap in the field in South Africa and in rural areas of South America. But only you can determine which of the following options is feasible for your work.1) The REDCap Mobile App can be downloaded to any mobile device (e.g. smart phones, tablets) and used for offline data collection. It's available in both Android and Apple app stores. The App is a true data collection tool; it has REDCap's primary functionality, just offline. (It's therefore slightly more limited functionality to online REDCap.) The App can 'sync' your offline data back to your real REDCap project when you return to internet connectivity. The 'sync' is a mass import of all the data you collected while offline. The App can send that back to your online REDCap project. Refer to the section 'Q: What is the REDCap mobile app?' to learn more about this separate feature.2) Data can certainly be stored in another format and then uploaded into REDCap when the internet connection is reliable. This can be another alternative - to temporarily store the data in another file type and then transfer into REDCap incrementally. Though not ideal, you use another program offline (or even have paper copies of the instruments) to collect data in areas of low internet coverage. You could then enter that data in REDCap when the connection is more stable and use REDCap for an electronic record and to prepare the data for analysis.3) Depending on your specific project, you might also be able to invest in purchasing a portable wireless router to act as an internet hotspot and enter data online in the field. This would allow you full use of the application from any low-coverage area. REDCap is accessible from any device having internet access, including the browsers of any smart phones or tablets (no Mobile App needed here). By providing your own internet access, the data could be stored securely (and directly in REDCap) from the start and there's no need to transfer it from hard copies later.
--------------------
Q32: What types of projects can I create?
A32: Once a project is created, on the Project Setup page you will be able to "enable" two "Main project settings" (1) the longitudinal feature (repeating forms)and/or (2) surveys for data collection. In a longitudinal project, for each instrument which is designated a survey, data can be entered directly by a participant for any/all events in the project.
--------------------
Q33: Are there specific requirements to set up a project?
A33: For projects with surveys, you must complete the "Set up my survey" step in order to activate the Survey URL. If this step is not complete, the following message will appear to on the "Survey Distribution Tools page: "Enable my surveys(s) NOTICE". You cannot utilized the "Survey Distribution Tools" page until you have first enable one or more surveys..."The survey-related options, like Survey Settings and Notifications, can be accessed on the Project Setup > Online Designer page.For ALL projects, you must define aunique identifieras the first field on your first data entry form. The data values entered into this field must be unique. The system will not allow for duplicate entries. If you do not have a specific unique identifier, you can enable the option "Auto-numbering for records".Examples of Unique Identifiers:Study-assigned IDExamples of Non-Unique Identifiers:Names, Dates of Birth, Consent DatesThe unique identifier must be a 'text' field. In addition, please note that unique identifier values will be visible at the end of the URL -- and likely cached in web browsers -- as individual records are viewed or entered. (Example URL:https://www.example.com/redcap/redcap_vx.x.x/data_entry.php?pid=xxx&page=xxx&id=ID_VARIABLE_VALUE.)It is strongly recommended that you do not use Protected Health Information (PHI) Identifiers such as MRN or DOB+initials as the unique identifier.This is an additional precaution to preserve research participant confidentiality from displaying in the URL and becoming cached.
--------------------
Q34: What steps do I have to complete to set up a project?
A34: Depending on which project settings are enabled, you will have the following steps/modules to complete on the Project Set-up page:SurveysClassicLongitudinalMain Project SettingsYesYesYesDesign Data Collection InstrumentsYesYesYesSurvey-related options > Survey settingsYesDefine Events and Designate InstrumentsYesEnable optional modules and customizationsYesYesYesUser Rights and PermissionsYesYesYesMove to ProductionYesYesYes
--------------------
Q35: What are Project Statuses?
A35: Project status reflect where in your project lifecycle your REDCap project is.Development:All projects when first created start in Development. In Development, you can design, build, and test your REDCap projects. All design decisions can be made in real time and are implemented immediately to your project. All survey and data entry features/functions can and should be tested.Production:When you have completed thorough testing, you should move your project from Development to Production status by clicking the button at the bottom of the Project Setup page. All survey and data entry features/functions will be exactly the same as they are in Development with the exception of certain Project Setup features.To make any form design changes you will need to enter Draft Mode to be able to edit your instruments. Changes to data collection instruments in Draft Mode are not made to your project in real time. After making updates, you must submit the changes for review. Depending on your institution’s policies, some changes are processed automatically, whilst others will need approval by a REDCap Administrator. These settings, as well as review and approval times will vary as they are institution specific. They are intended to protect from unintentional impacts to existing data and data structures in a live production project.From Production, you can move the projects to the following statuses on the Project Setup > Other Functionality page:Development: Only an administrator can move your production project back to development from production.Analysis/Cleanup:Move the project to Analysis/Cleanup status if data collection is complete. This will disable most project functionality, although all collected data will remain intact. Once in Analysis/Cleanup status, the project can be moved back to production status at any time.When a project is in Analysis/Cleanup, it is assumed that formal data collection has ended, except for cleaning and analyzing the data already collected. Many features are disabled, such as surveys, Alerts & Notifications, Automated Survey Invitations, and other features typically used during data collection. Also, no new records can be created while in this status.Modify data locking modeWhile the project is in Analysis/Cleanup status, you may set the data in the project to be either;1) Editable (existing records only), or2) Read-only/Locked. If set to Read-only/Locked mode, then no data in the project will be able to be modified in any way.When in Analysis/Cleanup you can move the project back to Production or to Completed status.Completed: If you are finished with a project, sure that no one needs to access it anymore, but you want to ensure that the project and its data remain intact, it can be marked as Completed. A Completed project can only be accessed by a REDCap administrator and only they can change its status back to Analysis/Cleanup.Marking a project as Completed takes it offline and hides it from everyone's project list. It can only be seen again by clicking the smallShow Completed Projectslink at the very bottom of the My Projects page. Clicking this link will make your completed projects appear in the same project folders that they were originally allocated to.Changes to project statusProject statuses were changed from version 9.8.0 standard release and 10.0.5 LTS, and some changes automatically made to projects which were in the olderInactiveandArchivestatuses.Projects which had been in the olderInactiveproject status, are updated to a project status of "Analysis/Cleanup". This is to help reinforce that cleaning and analysing the data is the next logical step after data collection in Production status.Projects in the olderArchivedstatus were originally located in anArchivefolder at the bottom of the My Projects page.This Archive folder is renamed to “My Hidden Projects" folder. Projects with Archive status which were previously in this folder are updated to have a status of Analysis/Cleanup. A user can move these projects out of the “My Hidden Projects" folder in the usual way by going to the Organize button at the top of the My Projects page and reallocating them to a chosen folder.
--------------------
Q36: Why do I have to "move" my project to production?
A36: Moving your project to Production once you start collecting study data ensures you're maintaining data accuracy and integrity. The post-production change control process provides an additional check to ensure that data which has already been collected is not deleted, re-coded or overwritten unintentionally. See FAQ topic "Making Production Changes" for additional details.
--------------------
Q37: After my project is created, can I change the name and/or purpose of my project?
A37: Yes. After your project is created, you can navigate to the Project Setup page. Click on the "Modify project title, purpose, etc.". Here you can update Project Title and Purpose during any project status.
--------------------
Q38: If the unique identifier is arbitrary to me, can the system auto-assign a unique value to each of my records?
A38: Yes. You can enable auto-numbering for naming new project records on the Project Setup > Enable optional modules and customizations page. This option will remove the ability for users to name new records manually and will instead provide a link that will auto-generate a new unique record value. The value is numeric and increments from the highest numeric record value in the project. If no records exist, it will begin with '1'.
--------------------
Q39: How do I add new form to an existing (production) project and make it the first form?
A39: 1.Put the project into Draft mode.2.Add the new form to the project.3.Reposition the new form to be first in the project4.Make sure the first field in the new form is the same record ID form as it was before the forms were moved5.If the new form or the form it is replacing are surveys, make sure the correct forms are enabled as surveys and correct any changes to survey settings. Remember that the first form in the project is what the public survey link will link to-if the former first form was using the public survey link, you cannot move it without changing what the public survey link moves to6.Put the changes into production.
--------------------
Q40: What can REDCap Administrators do that REDCap end users can't?
A40: REDCap administrators, also known as superusers, oversee the REDCap system and its settings. They often have the ability to do things that REDCap end users (regular users) can't do directly. Each REDCap system is overseen by a different group of administrators because each system is independently maintained and supported. The following is a list of some common administrator capabilities and responsibilities. Please contact your system's REDCap administrators if you would like to explore which of the following capabilities are available for your system.Project-specific tasksAt some institutions, only superusers can create projects.At some institutions, only superusers can move a project to production.Add custom text to the top of the Home page of a project.Add custom text to the top of all Data Entry pages of a project.Add custom logo and institution name to the top of every page of a project.Add grant to be cited.Display a different language for text within a project. The languages available vary by institution.Turn Double Data Entry on and off.Customize the date shift range for date shifting de-identification.Approve API token requests.Delete all API tokens.Create an SQL field, generally used to create a dynamic dropdown list with data drawn either from the same project or another.Additional project-specific tasks for projects in production statusAt some institutions, only superusers can approve some or all production changes, a.k.a. moving drafted changes to production.Delete events.Uncheck instruments from events.Enable/Disable Main Project Settings: Use Longitudinal and Use SurveysErase all data.Move the project back to development status.Delete the project.User-specific tasksSuspend and unsuspend users from all of REDCap. (Note, however, that expiring a users' access to a specific project does not require a REDCap administrator.)For sites that use REDCap's table-based, local authentication, reset the password for a user.Update the email address associated with an account for a user, in case that user is neither able to log in nor has access to the email address associated with their account.Cross-project tasksCreate project templates.
--------------------
Q41: How can I set the default auto-numbering to start at a particular number such as 2000?
A41: You can disable auto-numbering and add the first record using the ID number as the start value. Once this record is saved, you can enable the auto-numbering customization.
--------------------
Q42: If I enter data while I am testing my forms in Development, will it remain when I move to Production?
A42: It is strongly recommended that you test your projects prior to moving to Production, either by entering test data or real study data. Entering and saving data is the only way to test that the branching logic and calculated fields are working properly.When you click the "Move project to Production" button on the Project Setup page, a pop-up will prompt you to "Delete ALL data, calendar events, documents uploaded for records/responses, and (if applicable) survey responses?". Check the option to delete data. Uncheck the option to keep all data.
--------------------
Q43: Can I download a single combined PDF of all instruments in my project without data?
A43: In Project Setup, under "Design your data collection instruments", click "Download PDF of all data collection instruments".
--------------------
Q44: What's the difference between the unique identifier, secondary unique identifier and the redcap_survey_identifier?
A44: The first variable listed in your project is theunique identifierwhich links all your data.For any type of project, you must define the unique identifier field. This is the first field of the first instrument and if not using a template, the default isRecord ID[record_id]. For projects where a survey is the first data collection instrument, the value must be numeric and auto-increments starting with the highest value in the project. If no records exist, it will begin with '1'.Users can define a unique identifier value that is not numeric (ex: Site-001) and does not auto-increment for projects with surveys: Instead of enabling the FIRST instrument as a survey, have a data collection instrument with data entry fields, then collect data via subsequent surveys.Thesecondary unique fieldmay be defined as any field on the data collection instruments. The value for the field you specify will be displayed next to the your unique identifier when choosing an existing record/response. It will also appear at the top of the data entry page when viewing a record/response. Unlike the value of the primary unique identifier field, it will not be visible in the URL.The data values entered into the secondary unique field must also be unique. The system will not allow for duplicate entries and checks values entered in real time. If a duplicate value is entered, an error message will appear and the value must be changed to save/submit data entered on the data entry instrument.Theredcap_survey_identifieris the identifier defined for surveys when utilizing the Participant Email Contact List and sending survey invitations from the system. The "Participant Identifier" is an optional field you can use to identify individual survey responses so that the participant doesn't have to enter any identifying information into the actual survey. This field is exported in the data set; the email address of the participant is not.NOTE: redcap_survey_identifier values cannot be used with "piping". If you want to send surveys to participants and pipe in values (ex: first and last name); create a data entry instrument prior to the survey. Add your required fields and an email address to be used for the invitations (on the Project Setup page > Designate An Email). Then you can enter or import your participants' information and send the invitations using piping.
--------------------
Q45: How can I delete a project?
A45: Project users can delete projects that are in Development status by navigating to the 'Other Functionality' tab and then clicking on the 'Delete the project' button. Project users can request that projects in Production status be deleted by navigating to the 'Other Functionality' tab and clicking on 'Request delete project'. Clicking "Request delete project" sends a request to the REDCap Administrator.NOTE: After a REDCap Administrators deletes a project, it is only permanently removed from the database backend 30 days after deletion. Until that time, REDCap Administrators can undelete the project. The files associated with the project do not get deleted permanently at the same time, but will then be put into *another* 30-day wait until they are actually deleted from the server. So it takes a total of 60 days for the files themselves to get deleted from the time that a user "deletes" a project.
--------------------
Q46: When a "stop action" condition is met, can I customize text to display to participants prior to the survey closing?
A46: Yes, you can customize both the "End the survey?" pop-up window as well as an alternate survey completion text that is only displayed when a stop action triggers the end of the survey.The "End of survey?" pop-up window that appears after a stop action is triggered may be edited using Multi-Language Management (MLM). MLM gives you the ability to edit the title, text, and instructions but not the buttons associated with the pop-up. Customizing the language of the "End of survey?" pop-up is on the project level, meaning you are unable to customize different pop-up language per stop action if you have multiple stop actions in the project. To edit the pop-up language, create at least one language under MLM. Under "User Interface" search for "End the survey" to filter items on the page to the title, text, and instruction fields and enter the customized text under "Enter translation" for each customized text. If you leave the translation blank, the default text will appear.Alternate survey completion text is customized through the survey settings page of the instrument under "Options related to Survey Stop Actions". The survey completion text will appear only when a stop action is triggered, the survey was ended through the end of survey pop-up, and before the survey is closed. If the alternate survey completion text is left blank, the standard completion text (if applicable) will be used. Since alternate survey completion text is customized per instrument, you may have different customized text per instrument instead of per project like the pop-up customization using MLM above.
--------------------
Q47: How can I track the length of time to complete a survey?
A47: To track the amount of time a participant spends taking a survey, you can use the smart variables [survey-duration:instrument:units] or [survey-duration-completed:instrument:units] to pipe the values into field (using @DEFAULT or @SETVALUE), or you can pipe the value into a descriptive field, alert text, or anywhere else you pipe values. [survey-duration] will tell you the difference between the survey start time and the completion time (if completed) or the current time (if not completed). [survey-duration-completed] specifically returns total time it took to complete the survey. If the survey is not complete, it will return a blank value.You can also use the smart variables [survey-time-started:instrument]/[survey-date-started:instrument] and [survey-time-completed:instrument]/[survey-date-completed:instrument] to capture the survey start and completion times.
--------------------
Q48: For surveys with multiple pages, can participants go back to a previous page to change answers?
A48: Project designers may choose to give participants the ability to return to a previous section on multi-page surveys. In survey settings under "Pagination", the optional 'Hide the "Previous Page" button (i.e, Back button) on the survey page' checkbox will control the ability for participants to update previously entered data. The default unchecked behavior will allow participants to select the "Previous Page" button at the bottom of the survey screen. If you select the 'Hide the "Previous Page" button...' checkbox it will remove the previous page button from pages and not allow the participant to return to the previous page of answers. Once selected even if a participant tries to select the web-browser's back button, they will see a generic "You have partially completed this survey" message and inform them to start over.
--------------------
Q49: Is there any way to make a survey available for a specific time window for a specific record-for example, 24 hours before and after an appointment?
A49: The best way to do this is to go to Survey Settings --> Survey Access --> Time Limit for Survey Completion (optional). Here you can set a period of time the survey is available.The amount of time that each respondent has to complete the survey based on when they were initially sent the survey invitation. Note: This feature excludes public survey links and is not applicable for survey links sent via Alerts & Notifications.If you need more customization, within the survey itself, you can use branching logic to hide questions based on your date's conditions. You can set up the questions to only be visible within a range that works with your relative dates using a datediff calculation. You would then have a descriptive field stating that the survey is unavailable display if the datediff calculated value falls outside of your accepted range.
--------------------
Q50: Is it possible to designate a Secondary Unique Field using a "Multiple choice - drop down list (single answer)" variable?
A50: The secondary unique field is usually used to ensure that a text entry field, such as MRN or Study ID, is unique across the projects record, which is why it is setup to accept text fields only.If you want to ensure only one person selects each multiple choice response, such as for a booking system, you can use the action tag @MAXCHOICE and allow one response per answer choice. After someone selects an answer choice, it will be disabled for future data entry and surveys.
--------------------
Q51: How do I enable surveys for my project?
A51: Surveys can be enabled at any time in development mode by a project user with "Project Design & Setup" User Rights.On the Project Setup tab, in the Main Project Settings step at the top, click "Enable" button for "Use surveys in this project?". This feature must be enabled in order to use surveys.After enabling surveys, go to the Online Designer. A link to that page is on the Project Setup tab, in a lower step on the page. On the Designer, designate which instruments should be surveys by clicking the 'Enable' button next to them. You can enable surveys on as many instruments as you wish.Each time you designate an instrument as a survey, you will be prompted to define some additional features of the survey. Be sure to scroll down and save those settings. You can return to them at any time to review and modify them as needed, even in production mode. They are found in the 'Survey Settings' buttons that will appear next to each survey instrument in the Online Designer.To enable surveys for a project in "production" status, you must contact your REDCap Administrator.
--------------------
Q52: Can I create multiple surveys in the same project?
A52: Yes, you can have multiple surveys in the same project. The multiple surveys will be linked to a single participant. If your surveys are for different cohorts or populations, you will want to create separate projects for each survey.
--------------------
Q53: For Survey + Data Entry Projects, is it possible to start entering data on a data entry form for an individual prior to their completion of the survey?
A53: Yes, you can have multiple surveys and data entry forms in the same project. You can start with a data entry form and enable the second instrument to be a survey.
--------------------
Q54: How do I know which survey delivery option is right for my project?
A54: It depends on if you have the need for future scheduling or conditional logic. Use this grid to determine the best option for you:Delivery OptionAllows for Future SchedulingAllows for Conditional LogicManualYesNoAuto-continueNoNoSurvey queueNoYesASIYesYes
--------------------
Q55: Is there any tool that can help me figure out how to set up my survey?
A55: This link [Survey Wizard: The Basics] will take a user to a survey algorithm that was created by the Training Collaboration Committee using REDCap version 7.6.3. It addresses when to enable survey functionality, what to consider when choosing a survey model, and reviews survey setting options.(URL:https://redcap.vumc.org/surveys/?s=43TD4MRF8A)
--------------------
Q56: Can I collect anonymous survey data from participants?
A56: Responses can only be collected anonymously using the Survey Distribution Tools > Public Survey Link.The survey questionnaire must not contain any questions asking the participants for identifying data (ex: What is your email? name? address?).Multiple Surveys: Be mindful that projects with multiple surveys present potential challenges to anonymous data collection. If you are analyzing data in aggregate, you can having multiple REDCap projects, each using the Public Survey Link. If you need to track individual responses over time, using the Public Survey Link for each survey (pre, post, follow-ups) requires that you collect data points within the survey questionnaire to later export and merge. The data points should not be identifying information, but specific enough question(s) that a participant will enter answers consistently (ex: last 5 digits of their first phone number; color of first car).Projects containing data entry forms and surveys cannot be considered anonymous. Manually entered data needs to be identified by the team to be properly associated and linked with survey responses.
--------------------
Q57: How can I send multiple surveys to participants and link their responses?
A57: If the responses need to be anonymous, please see the section Surveys: Anonymous.If responses do not need to be anonymous, you must at some point collect individual email addresses to send participants multiple surveys and have the data linked. You can do this in a few ways:1. Project's first instrument is a Survey & Use of Public URL & Designate an email field:If you want to utilize the Public URL to distribute an initial survey and invite participants, the survey MUST contain a text field with validation = email to collect the participant's email address.On the Project Setup page > Enable optional modules and customizations > Enable: Designate an email field to use for invitations to survey participants. Designate the email address you are collecting on the first survey.When participants complete the first survey, their email addresses will pre-populate the Participant Lists and will allow you to send additional surveys for the same record.Surveys will be automatically linked by record ID. Participant Identifier on Participant List will not be editable.Additional Notes: You will still be able to use the Participant List to send emails to the first survey, if needed. Participant will be prompted to enter their email address on the survey itself. You can also create new records using the Data Entry feature to populate the first survey and manually enter email addresses.LIMITATION:Only participants that answer the first survey with an email address will be able to respond to the follow-up surveys.2. Project's first instrument is a Survey & Use of Participant List:If have individual email addresses, you can create a project with multiple surveys. You would add individual emails to the Participant List with or without a Participant Identifier. Then you can send the survey invites through "Compose Survey Invitations".LIMITATION:Only participants that answer the first survey will be able to respond to the follow-up surveys. If you wish to collect additional surveys for the non-responders, you will need to create additional REDCap projects with the follow-up surveys. Because of this limitation, you may want to try method #3:3. Project's first instrument is Data Entry & Use of "Designate an email field":If you know your email addresses and want participants who haven't completed the first survey to be able to complete the second survey (within the same project), then you can do the following:1. The first form is a data entry form (ex: "Email Form"). On the "Email Form", at minimum, you can have the participant ID number field and an email field: a text field with validation = email2. On the Project Setup page > Enable optional modules and customizations > Enable: Designate an email field to use for invitations to survey participants3. Select the email field you created on the "Email Form"4. You can either import (Data Import Tool) or enter the email addresses directly into the data entry "Email Form". Entering the emails here will automatically populate the Participant Lists for all surveys in the projectYou can send your invites to any surveys regardless of participant's responses and survey completions.Advantages:You can import a list of pre-defined record IDs and email addresses. Record IDs do not have to be assigned incrementing values by REDCap.
--------------------
Q58: Where can I setup survey reminders?
A58: You can setup survey reminders in the same modules that REDCap allows you to send out a survey invitations: Automatic Invitations, Participant List, Compose Survey Invitations.
--------------------
Q59: Can I send more than 5 survey reminders?
A59: The current maximum for reminders is 5 in order to prevent spamming people.
--------------------
Q60: What is the Survey Queue?
A60: The survey queue displays a list of the surveys in your project, functioning as a “To-Do” list for your survey participants.The survey queue is set up in the Online Designer after surveys have been enabled in the project. You will select which surveys in your project you want to use with the queue, and supply logic saying when they should be available. Surveys can become available when another survey is complete, when specific logic is met, or both. You can also enable the “Auto start” option. This means the survey will launch as soon as the previous one is completed, creating a seamless survey experience for the participant similar to the “Auto-continue” option in the Survey Settings.Please note that the survey queue and the “Auto-continue” in the Survey Settings cannot be used for the same survey; the “Auto-continue” option will always take precedence over survey queue logic and may result in surveys being launched even though the survey queue logic says they should not be.
--------------------
Q61: Can the respondent see the survey queue even if that survey is not in the queue?
A61: Yes. If the survey queue has surveys in it, the respondent will see the link for the queue and be able to access it and any surveys that are not locked. This is true even if the survey respondent received the survey trough the "Survey-specific invitation field" option and is not the main respondent for that record, because the survey queue exists on the same level as the record itself, not the individual forms. If there will be multiple respondents for a record and you are concerned about them accessing inappropriate surveys via the survey queue, then you should not use the survey queue for that project.
--------------------
Q62: If a participant answers a question in a certain way, can they be taken to the end of the survey if the rest of the questions are not applicable?
A62: Yes, you can indicate "Stop Actions" for survey fields only. The survey participant will be prompted to end the survey when programmed criteria are selected. Stop Actions will not be enabled on the data entry form when viewing as an authenticated user. Stop Actions can only be enabled for drop-down, radio, checkbox, yes/no, and true/false field types.
--------------------
Q63: What are the differences between the Survey Auto-Continue and Survey Queue features?
A63: Both Survey Auto-continue and Survey Queue can be used to direct the flow of surveys in a project.Generally,Survey Auto-Continueredirects participants to the next available survey, whileSurvey Queueenables participants to see a "table of contents" of all available surveys, after submitting a survey response.That said,Survey Queuecan also be set up to automatically redirect to the next available survey in the queue, bypassing the "table of contents" view, if the "Keep the Survey Queue hidden from participants?" option is selected.As a rule of thumb, given the overlap in functionality, it is suggested that you activate only one of these features and leave the other turned off.Survey Auto-Continue:Is easier for many users.Optional conditional logic is used to control if the *next* survey is redirected to after the current survey is submitted.Simpler, less granular controls - One config per survey applies to the survey across all events.Survey Queue:Provides a landing page for a pt. showing surveys they've already taken and available to be taken.Optional conditional logic is used to control whether the current survey is visible in the queue or hidden/skipped over.More granular controls - One config per "survey x event" - need to activate and configure the survey across each of its eventsLimitations of Auto-Continue:No landing page / "table of contents" viewLimitations of Survey Queue:If a lot of events, slow to load.Can be a challenge in multi-arm projects.Survey styling doesn't apply to the table-of-contents view.The Survey Queue link at the upper-right corner of surveys and the "Summary" on the end-of-survey page cannot be selectively disabled; either they are both disabled (using "Keep the Survey Queue hidden" option) or both remain visible.
--------------------
Q64: Why doesn't the Survey Queue work when I have Auto-Continue enabled?
A64: The Auto-continue survey setting overrides the Survey Queue logic. If you want to utilize the Survey Queue, disable the Auto-continue feature first.Note: Survey Queue only works on instruments that are 'enabled' in the queue. You could potentially have a mix of Auto-continue and Survey Queue. However, it is true that if a survey is enabled in the Survey Queue, it is probably not good to have that same survey (or the survey before it) set up with auto-continue.
--------------------
Q65: How can I send survey invitations based on logic?
A65: The best way to send survey invitations based on logic is to create an Automated Survey Invitation (ASI) that schedules when your logic becomes true.To do this, go to the Online Designer and find your survey. In the far right column next to the survey, select “Automated Invitation.” There will be three sections to fill out:The email text, subject and from address,The logic that should trigger the invitation to be sent (so if you only wanted to invite people if [consent]=1, then this is where you'd do this) andThe timing, when to send the email, whether it's at an exact time, a certain delay period, or immediately, and any remindersOnce an ASI is created and enabled, it will schedule when any record is saved with the logic you set as true. If it contains a datediff in that logic, REDCap will check multiple times a day to see if the logic has become true and schedule when it does.You can also create an Alert that triggers based on logic using “Alerts and Notifications” on the sidebar under Applications. This works very similarly to an ASI, but you will need to provide your own smart variables for the invitation.
--------------------
Q66: Can I schedule Automated Survey invitations (ASI) after data has been collected?
A66: Best practice is to create your ASIs before any data is collected, but you can create or modify them after data collection has begun.If you create or edit an ASI after data collection has started, you will need to resave records to have the ASI logic evaluated—REDCap will not go back and automatically check all records to see if any meet the new/updated logic. If an invitation has already been scheduled for a record, but not sent, the invitation wording and scheduling will not be changed to reflect new wording/logic.The exception to this is if your new logic contains a datediff equation. REDCap contains a ‘cron job’ that runs multiple times a day to check if any datediff calculations in ASIs have become true. If you change an ASI to include a datediff, REDCap will check to see if it is true for your records on the same schedule it is checking all other ASIs with datediff calculations, and it will schedule the invitation appropriately when the logic becomes true.
--------------------
Q67: What is the Survey Login feature?
A67: To provide improved security to your surveys, you can require the participant to enter specified login credentials in order to begin a survey and if the "Save & Return Later" feature is enabled to return to a previously entered survey response.To enable the Survey Login feature, there is a button at the top of the instrument list on the Online Designer that will open up the Survey Login settings popup. Users who wish to enable Survey Login may choose one, two, or three fields in their project to be used as the login credential fields for surveys in their project.The Survey Login can be enabled for ALL surveys in a project or just selected surveys. For selected surveys, navigate to the Survey Settings page to enable.If Survey Login has been enabled and a record does not exist yet for the respondent (e.g., if they are beginning a Public Survey), then the survey page will display directly without the login page. However, once the record exists, the respondent will always be prompted to log in to the survey.Note: If a survey has the "Save & Return Later" feature enabled, Return Codes will not be used to return to the survey, but it will use the Survey Login's login credentials instead.Note: Survey Login cannot be used with a public survey, which requires a Return Code if "Save & Return Later" is enabled.
--------------------
Q68: Can I receive a notification when a survey has been completed?
A68: Yes. On the Online Designer page, choose 'Survey Notifications' located in the Survey Options section. You may indicate which users should be notified when a survey is complete.
--------------------
Q69: Why am I getting duplicate notifications when a survey has been completed?
A69: REDCap specifically checks to ensure it doesn't send a double email to someone. However duplicate notifications can be sent if another user on that project has a slightly different version of your email address on their REDCap account e.g.jane.J.doe@vanderbilt.eduvsjane.doe@vanderbilt.edu. There is another possibility. After a survey participant finishes a survey he or she may refresh the acknowledgement page. This could result in another batch of emails being sent.
--------------------
Q70: How do I automatically display the current date/time on a survey?
A70: Every survey that is submitted is date/time stamped. This completion date and time are available in the data export and data entry forms. However it's not possible to display the current date on the survey while it's being taken by participants.You can add a question onto your survey to indicate "Today's Date". The calendar pick list will have a button for "Today" or "Now" that the participant can easily click.Action tags are a relatively new addition to REDCap and can be applied to any variable (see Action Tags info for additional details). These options are available:@NOWAutomatically provides the user's current time as the value of a Text when the page is loaded. Once the value is captured, it will not be changed when visiting the page at a later time. If the field has validation, the value will conform to the date/time format of the field. The field will be disabled and will not allow users to edit the value. NOTE: The time will be the user's local time, which is derived from their device/computer.@TODAYAutomatically provides the user's current date as the value of a Text when the page is loaded. Once the value is captured, it will not be changed when visiting the page at a later time. If the field has validation, the value will conform to the date/time format of the field. The field will be disabled and will not allow users to edit the value. NOTE: The date will be the user's current date, which is derived from their device/computer.@READONLYMakes the field read-only (i.e., disabled) on the survey page, the data entry form, and in the REDCap mobile app so that its value cannot be changed
--------------------
Q71: What happens when I take the survey "offline"? What does the participant see if they click on the link?
A71: When a survey is "offline" participants will no longer be able to view your survey. They will navigate to a page that displays "Thank you for your interest, but this survey is not currently active." Project users will still have access to the project, all the applications and survey data.
--------------------
Q72: What happens when a REDCap Administrator takes the system "offline" for routine upgrades and/or expected downtime? What does the participant see if they click on the survey link?
A72: When the REDCap system is "offline", participants will no longer be able to view your survey. They will navigate to a page that displays "REDCap is currently offline. Please return at another time. We apologize for any inconvenience.If you require assistance or have any questions about REDCap, please contact your REDCap Administrator.
--------------------
Q73: If my survey is really long, can I create page breaks?
A73: Navigate to Project Setup --> Design your data collection instruments & enable your surveys --> Online Designer --> Survey Settings (next to the survey name in the Online Designer). In the "Survey Customizations" section, set "Question Display Format" to "One section per page". Then on your questionnaires, you can create page breaks by adding in fields (field type = "Begin New Section (with optional text)") where you would like those breaks to occur.
--------------------
Q74: If I enable "Display Questions" = "One section per page", do answers get saved after the respondent hits "next" to go on to the next page?
A74: Yes. Answers are committed to the database as you hit "Next". So if responders quit the survey before finishing, you'll have all the data up to that point (partial responses).
--------------------
Q75: When "Display Questions" = "One section per page" is enabled and entire sections/questions are hidden due to branching logic, are blank pages displayed to the participant?
A75: No, sections (as separate survey pages) where ALL questions are hidden due to branching logic will be skipped while in survey view. However, this is not true for the last page of any survey, in which the last page will always be displayed, even if all questions are hidden on the page.
--------------------
Q76: For surveys with multiple pages, can the "Previous Page" button be disabled?
A76: Yes. The "Previous Page" button option can be disabled on the Online Designer > Survey Settings page.
--------------------
Q77: For surveys with multiple pages, is there a progress indicator on the survey?
A77: Yes. There is a "Page # of #" at the top right of the survey, so respondents know how many pages they have left. You can hide/display this feature on the Online Designer > Survey Settings page. The progress bar is not a feature of REDCap.
--------------------
Q78: My survey has matrix fields and it's creating undesirable page breaks. What is causing this?
A78: Matrix fields contain a "Matrix Header Text" which is actually a Section Header. Using this field will cause a survey page break. To avoid this, instead of entering text into the header field, add a new "descriptive text field" above your matrix question and enter your text there.
--------------------
Q79: Will a value entered for a field on one page of a survey be removed if another page of that survey later hides that field?
A79: Fields on a survey that are hidden by branching logic due to a new value being entered on that same page will have any already-entered values removed, but fields on other pages will not.While not ideal, this is currently the expected result due to technical limitations.This situation arises if:A survey is configured to show one section per pageA value is entered for a field on one pageOn another page, a value is entered that causes branching logic to hide the field on the first page.
--------------------
Q80: What is "Designate an email field to use for invitations to survey participants" option?
A80: Project users may designate a field in their project to be the survey participant email field for capturing the email address to be used. The field must be validated as an email to be used for this purpose.The field can be designated in the "Enable optional modules and customizations" section of the Project Setup page.Once designated, if an email address is entered into that field for any given record, users will then be able to use that email address for any survey in the project to send survey invitations.
--------------------
Q81: Is there a way to get rid of the red "must provide value" message for required fields?
A81: Yes, but only in survey mode. You can change this setting in the survey settings. The fields will still be required and the survey will display a warning if they are not filled out, but the red text will be gone.
--------------------
Q82: How do I turn text to speech on for a specific survey?
A82: You can turn on text to speech on in the survey settings of each survey under "survey customizations".
--------------------
Q83: Are there different languages available for the text to speech feature?
A83: Currently, only English is supported.
--------------------
Q84: How to do I set a survey expiration date for a specific survey?
A84: You can set the survey expiration date for any survey in the survey settings. REDCap will deactivate the survey at the specified time point.Note: The survey will be deactivated for all instances of that survey in all arms and events. It's currently not possible to put expiration dates on specific surveys in specific events.
--------------------
Q85: Can I extend the time limit on a survey?
A85: Yes, you can. If you set a time limit (for example, 2 weeks) on a survey and want to change it, you can go back and extend the length of time. If the survey had already closed and you extend the time limit, the old surveys will be re-opened if they are within the new time limit.
--------------------
Q86: Can survey respondents save, leave, and then go back to a survey to complete the questions?
A86: Yes. You must enable the "Save and Return Later" option in the Modify Survey Settings section of the Project Setup tab. This option allows participants to save their progress and return where they left off any time in the future. They will be given a Return Code, which they will be required to enter in order to continue the survey.Note: If a project has the "Survey Login" feature enabled, Return Codes will not be used to return to the survey, but it will use the Survey Login's credentials instead.If participants forget their Return Code and contact you, you have access to participants codes on their Survey Results page. You will only be able to distribute lost codes if the survey responses capture identifiers. If the survey is "anonymous" you will not be able to recover the Return Code for the participant.
--------------------
Q87: Can my participants go back to a previously completed survey and make edits?
A87: Yes, but this feature is turned off by default for each survey. You will need to turn it on manually in the survey settings for each survey.
--------------------
Q88: Can survey respondents return and modify completed surveys?
A88: Yes. This feature can be enabled on the Online Designer > Survey Settings page under the "Save & Return Later" section. Once enabled, a respondent will be able to return to their response and make any edits to it even if they have fully completed the survey.Once enabled as part of the "Save & Return Later" feature, respondents will need to provide a Return Code in order to make edits to a completed survey. If the Survey Login feature is enabled for the survey, then instead of using a Return Code, they will use their login credentials to return to the survey.If enabled, participants who have completed the survey will still appear in the Participant List in the Compose Survey Invitations popup to allow their invitations to be resent to edit their completed response. Additionally, their survey link and survey return code will also remain in the Participant List for this same purpose.Note: If Survey Notifications have been enabled for a survey that has the "Edit Completed Responses" option enabled, then whenever the respondent returns to the survey again and completes the survey again, it will again trigger the Survey Notifications to send an email to those users selected.
--------------------
Q89: Where are the archived PDFs of my consents stored?
A89: The archived PDFs are stored in the project’s file repository on the “PDF Survey Archive” tab. If you do not see a link for the File Repository under Applications on the left-hand sidebar, check your user rights to see if you have access to this feature.
--------------------
Q90: Can anyone alter a consent form after it is submitted with the eConsent framework?
A90: Whether anyone can alter a consent form after submission is determined by the researcher setting up the consent. The eConsent Framework has the option “Allow e-Consent responses to be edited by users?” If this option is checked, any user with rights to edit the survey responses would be able to edit the consent form. If it is unchecked, no one will be able to alter the submitted consent.
--------------------
Q91: How do I setup a survey confirmation email?
A91: You can setup a confirmation email in the survey settings of each email in the survey termination section. Select "Yes" on the dropdown and fill in the "From", "Subject" and "Body" sections. You can also add an optional attachment.Note: REDCap must have an email field defined for the project in order to send out the survey confirmation automatically.
--------------------
Q92: Can I pipe in information from the survey into my confirmation email?
A92: Yes, you can pipe in any information from the survey or any other form associated with the record.
--------------------
Q93: What kind of attachment can I send with a survey confirmation email?
A93: You can send one file of any type as long as it isn't bigger than the size limit set by the local administrator. This is usually around 16 MB.
--------------------
Q94: Do the remaining reminders get canceled once a participant fills out a survey?
A94: Yes, Once the specific survey gets filled out by the participant or a REDCap user, all remaining reminders get cancelled automatically.
--------------------
Q95: What happened to the "Preview survey" feature?
A95: This feature is no longer available because branching logic or calculated fields would not always work correctly. To preview your surveys, it is recommended to view the survey as a test participant when testing the project while in development status.
--------------------
Q96: How does Twilio interact with REDCap to send calls and SMS messages?
A96: The REDCap/Twilio interaction looks like this:
--------------------
Q97: What is a Longitudinal project?
A97: A longitudinal project is similar to a traditional data collection project in that multiple data entry forms are defined. However unlike the traditional model, forms in a longitudinal project can be completed repeatedly for a single record. The longitudinal model allows any data entry page to be repeated any given number of times across pre-defined time-points, which are specified by the user before data is collected. So rather than repeating a data entry form multiple times in the Data Dictionary, it can exist only once in the Data Dictionary but be repeated N number of times using the longitudinal model.The longitudinal project lets you define "events" for your project that allow the utilization of data collection forms multiple times for any given database record. An "event" may be a temporal event in the course of your project such as a participant visit or a task to be performed. After events have been defined, you will need to designate the data entry forms that you wish to utilize for any or all events, thus allowing you to use a form for multiple events for the same database record. You may group your events into "arms" in which you may have one or more arms/groups for your project. Each arm can have as many events as you wish. You may use the table provided to create new events and/or arms, or modify existing ones. One arm and one event will be initially defined as the default for all databases.
--------------------
Q98: How can I establish the events and scheduling intervals for my project?
A98: The Define My Events page allows you to establish the events and scheduling intervals for your project. An "event" may be a temporal visit in the course of your project such as a participant visit or a task to be performed. After events have been defined, you may use them and their Days Offset value to generate schedules. For data collection purposes, you will additionally need to designate the data entry forms that you wish to utilize for any or all events, thus allowing you to use a form for multiple events for the same database record. You may group your events into "arms" in which you may have one or more arms/groups for your project. Each arm can have as many events as you wish. To add new events provide an Event Name and Date Offset for that event and click the Add New Event button.If you will be performing data collection on this project then once you have defined events in the Define My Events page, you may navigate to the Designate Instruments For My Events page where you may select the data collection instruments that you with to utilize for each event that you defined.
--------------------
Q99: In longitudinal projects, how can I set up linkages between events and data entry forms?
A99: You can use the Designate Forms for my Events page to create linkages between events and data entry forms. In the Designate Forms for my Events page each arm of your study has its own tab. Choose an arm and click the Begin Editing button to link data entry forms to events. Check off boxes to indicate the forms which should be completed for any given event and then click the Save button. You will see a grid that displays the data entry forms that are assigned for completion during each event. Take care to designate forms for your events while the project is in development mode. These associations can only be changed by the REDCap Administrator after the project is in production and should be made with caution to ensure existing data are not corrupted.
--------------------
Q100: Can I add more events or instruments to a longitudinal project that is in production?
A100: Yes, once you are in production you can add more events and instruments, and assign instruments to new events. To delete an event or an instrument from an event, you will need the help of an administrator to help prevent accidental data loss.
--------------------
Q101: How is longitudinal data stored?
A101: In the traditional data collection model and for surveys, each project record is stored independently as a separate row of data, which can be seen when exported. But for longitudinal projects, each row of data actually represents that particular time-point (event) per database record.For example, if four events are defined for the project, one record will have four separate rows of data when exported. The data export will include a column "redcap_event_name" indicating the unique event name for each row.Longitudinal projects are most commonly created for clinical and research data. A longitudinal project is created by selecting the "Longitudinal / repeating forms" collection format for data entry forms when creating or requesting a new project.
--------------------
Q102: How can I register a subject in a multi-arm study before the determination as to which arm they belong in can be made?
A102: You can set up an arm as a "screening and enrollment" arm. Once a subject becomes enrolled he or she can be added to an "active" arm.
--------------------
Q103: Can you transfer a subject from one arm to another?
A103: First, export the data that you want to transfer out of REDCap. Save as a new CSV file and update the information in redcap_event_name to match the new event name. If you need to find this in REDCap, go to the "Define My Events" page and look for "Unique event name" in the last column. Make sure the variable names match the variables the data will go in, if you are also moving the data to a different form. Save the CSV and go to the "Data Import Tool" under Applications on the sidebar. Choose to upload you CSV and review the data to make sure it is all included and going into the correct variables, event, and arm before finalizing the import.
--------------------
Q104: What is the scheduling module and how does it work with the calendar?
A104: The scheduling module uses the information in the “Date Offset” column of the “Define My Events” section in a longitudinal project to allow you to schedule the dates actions in different events should occur. You will select a start date for an individual record and REDCap will develop a schedule based on the days offset you specified, flagging any dates that would occur on a weekend in red. You will have the option to edit these dates, then create a schedule.These schedule events will appear on the calendar (under Applications on the sidebar). When you click on a scheduled event on the calendar, a popup will open allowing you to specify the event status, time, and notes and providing quick links to the different forms for that record in that specific event.
--------------------
Q105: How can I remove a subject in a multi-arm study from one arm, but not all arms?
A105: Go to the first form in the arm from which the subject will be removed and delete the record. This will remove the subject from that arm, but not other arms.
--------------------
Q106: Can I create a copy of my project?
A106: Yes. If you have the right to create/request new projects, you can navigate to the Project Setup > Other Functionality page and request a "Copy" of the project.
--------------------
Q107: What is migrated over when a project is copied?
A107: When you copy a project, REDCap will show you a checkbox list of data, settings, and modules you can bring over, including records, users and their user rights/roles, alerts & notifications, and so forth. REDCap will only give you the option to select a box for a setting or module that is used in the existing project. Importantly, project logging isnevercopied into the new project, so anything in the logs will not migrate to the new project. This includes when records are created and updated, survey timestamps, and information about project management and design tasks.
--------------------
Q108: How do I move a project between different REDCap installations?
A108: Provided that both your origin REDCap installation and your destination REDCap installation are on a REDCap version of 6.12.0 or higher, you can perform a CDISC ODM export of the project's metadata on the Other Functionality tab of the Project Setup page.You have two options for export:- A export of just the full project setup (including all the variables, forms and settings)- A export with the full project setup plus all the data captured so far.Note: Both export options do not include log files or user rights.To load a CDISC ODM export in your destination REDCap installation, Create or Request a new project and select the "Upload a REDCAp project XML file" option.This option will allow you to upload your previously downloaded XML file.Note: Do not upload a data dictionary file during project creation, the system only accepts the CDISC ODM format.
--------------------
Q109: What is the e-Consent Framework?
A109: The e-Consent Framework in REDCap helps you obtain participant consent electronically using a REDCap survey. This module is located in the Online Designer under the "e-Consent and PDF Snapshots" button in the Data Collection Instruments header box. The e-Consent Framework offers standardized tools to create and store electronic consent forms, including a certification screen and automatic generation of a PDF copy of the signed form. The official consent document is this generated PDF, which includes a footer containing critical information for regulatory compliance. Always consult your local IRB or regulatory body to ensure that your e-Consent process meets all necessary legal and ethical standards.
--------------------
Q110: How do I setup the e-Consent Framework in REDCap?
A110: Enabling the e-Consent Framework:Navigate to the Online Designer.Enable e-Consent Framework:Click "e-Consent and PDF Snapshots" in the Data Collection Instruments header box.Enable the e-Consent Framework for a survey.Configuring Settings:Primary Settings:Allow user edits and specify name fields.Additional Settings:Add date of birth field, custom headers/footers, and signature settings.Specify save locations and customize file names.Save your settings.Adding Consent Versions:Add a New Consent Version:Click "Add consent form," specify the version number, and provide the consent form.Save the new version.Note: Always consult your local IRB or regulatory body to ensure compliance. The generated PDF is the official consent document, containing necessary regulatory information.
--------------------
Q111: Can anyone alter an e-Consent form after submitting it within the e-Consent Framework?
A111: e-Consent PDF Integrity: The official e-Consent is the generated PDF, which can never be changed or modified after it is created.Editing Data in REDCap: The real question is whether the data in REDCap can be altered. This depends on your instance's settings:- Admin-Controlled Editing: Some instances allow only admins to control the ability to edit e-Consent forms at the project level. If your instance does not have this option enabled, contact your local REDCap administration team to discuss their policies.- Project-Specific Settings: If your instance allows editing, enabling the "Allow e-Consent responses to be edited by users" option will let users with editing rights modify the form. If this option is not enabled, the consent form cannot be altered after submission.3. Best Practices: Never alter a signed e-consent. If you are using the module for non-traditional purposes (e.g., not for consenting), best practices depend on your specific use case. Editing the form or survey data will generate a new PDF snapshot, preserving the original and modified versions without altering the PDF.
--------------------
Q112: Is there a specific question or field type for people to sign their name for e-Consent?
A112: REDCap offers a "Signature" field type that allows the participant to sign their name electronically. This "Scribble Signature" field captures a handwritten signature using a mouse, stylus, or touchscreen. In many regulatory contexts, including the U.S. Electronic Signatures in Global and National Commerce (ESIGN) Act and the EU's eIDAS regulation, a scribble signature is considered equivalent to a wet signature, meeting the requirements for electronic signatures.Example regulations include:- U.S. ESIGN Act: Provides legal recognition of electronic signatures for transactions and documents, ensuring they are as valid as handwritten signatures.- EU eIDAS Regulation: Establishes a framework for electronic identification and trust services, recognizing electronic signatures and providing guidelines for their legal acceptance.However, always verify with your IRB or regulatory body to ensure compliance with specific laws and regulations governing your study.
--------------------
Q113: Do I have to use a signature field for e-Consent? Or can people just type their name to sign the consent?
A113: The requirement for a signature field can vary based on your project's regulations. While some studies may require a scribble signature, others may allow participants to type their name. Consult your IRB or regulatory body to determine the specific requirements for your study.
--------------------
Q114: Can participants edit their responses after completing the e-Consent form?
A114: Participants can edit their responses if the "Allow respondents to return and modify completed responses" setting is enabled in the survey settings. However, it's important to note that the official e-Consent is the generated PDF, which cannot be changed or modified once created.If participants modify their responses, a new PDF snapshot will be generated, resulting in two versions in the file repository: the original and the modified version. This ensures that all versions of the consent form are preserved and no data is lost. For compliance and best practices, always ensure that your e-Consent process meets all necessary legal and ethical standards as advised by your local IRB or regulatory body.
--------------------
Q115: How do I manage user access to e-Consents?
A115: To manage user access to e-consents in REDCap:Navigate to the "User Rights" section of your project.Assign user roles with specific permissions for viewing, editing, and managing e-consents.Utilize Data Access Groups (DAGs) to restrict access to e-consent forms based on user groups, ensuring that only authorized personnel can access sensitive data.
--------------------
Q116: What is version control for e-Consent?
A116: Version control in the e-Consent framework tracks changes to consent forms over time, allowing you to manage different versions as the study progresses. This ensures compliance with regulatory requirements by maintaining a complete audit trail.To use version control in your e-Consent form:Enable the e-Consent Framework:Navigate to the Online Designer, enable the e-Consent Framework for your consent instrument, and configure the necessary settings to use it to collect consent.Create a field for your consent:Create a descriptive field in the consent form that you will use for your consent PDF or text.Click "Add consent form" on the e-Consent Framework page under your survey:Add your consent number, specify the field that contains your consent document, and make any rules for DAGs or specific languages. The either provide the consent form as rich text or upload a PDF of your consent form document in the "Consent Form (Rich Text)" or "Consent Form (Inline PDF)" tabs. This will automatically appear in the field that you specified as containing your consent document.To update your consent form: Click on the "Add consent form" button under the survey in the e-Consent Framework settings. Give it a new consent version and provide the new consent document in the "Consent Form (Rich Text)" or "Consent Form (Inline PDF)" tabs.Viewing all versions: Use the "View all versions" link under the survey in the e-Consent Framework Settings to view all past consents and to set the current consent form as inactive.When using the version control, be aware that all versions go live immediately after activation and cannot be reverted.Always contact your IRB or regulatory body to ensure compliance with specific laws and regulations governing your study.
--------------------
Q117: Can I use the e-Consent Framework if I have multiple consents?
A117: If your study requires multiple consents (e.g., different consent for different study phases or participant groups), you can manage each consent form independently using the e-Consent Framework. Here are two approaches to handle multiple consents effectively:Multiple Instruments:Independent Management: Create separate instruments for each consent form and enable the e-Consent Framework for each instrument independently. This allows each consent form to have its own version control and PDF snapshot settings, ensuring that all consents are properly tracked and stored.Branching Logic:Dynamic Display: Use branching logic within a single instrument to display the appropriate consent form based on participant responses or study phase criteria. This ensures that participants see the correct consent form tailored to their specific situation.Framework Integration: Enable the e-Consent Framework for the instrument and configure the branching logic to ensure the correct consent form is presented and managed.Always contact your IRB or regulatory body to ensure compliance with specific laws and regulations governing your study.
--------------------
Q118: Can I use e-Consent Framework if I have multiple signatures?
A118: The e-Consent Framework supports capturing multiple signatures across different forms. Each form can independently use the e-Consent Framework and generate its own PDF snapshot. For scenarios requiring multiple signatures on the same form, follow these steps to ensure that each signature field is properly configured and captured in the PDF snapshot:Create Separate Consent Forms (if needed):If your study requires signatures from different stakeholders (e.g., participant and guardian), create separate consent forms for each stakeholder. Each form should independently use the e-Consent Framework.Enable e-Consent Framework for Each Form:In the Online Designer, enable the e-Consent Framework for each form that requires a signature. Configure the settings for each form, including the signature fields and any other required fields.Configure Signature Fields:Ensure that each signature field is properly configured in the form. Use the 'Signature' field type for capturing scribble signatures.Set Up PDF Snapshots:Navigate to the e-Consent Framework and PDF Snapshots button from the Online Designer.Select the PDF Snapshots tab and add a new trigger.Define the conditions for the trigger, specifying the forms that will be included in the snapshot. Ensure that all relevant signature fields are included for multiple signatures on the same form.Choose the storage location for the snapshot (File Repository or specified field).Customize the file name template for the snapshot, if desired.Save the trigger settings.Generate PDF Snapshots:The system will automatically generate PDF snapshots based on the configured triggers. Each snapshot will include the captured signatures and any other relevant information.Verify Setup:Run a test to verify that the PDF snapshots are generated correctly and include all required signatures. Ensure that the snapshots are stored in the specified location and are accessible for audit and compliance purposes.Always contact your IRB or regulatory body to ensure compliance with specific laws and regulations governing your study.
--------------------
Q119: Can I use the e-Consent Framework with the Data Access Groups (DAG)?
A119: The e-Consent Framework supports Data Access Groups (DAGs), allowing you to manage consent forms for different groups of users. Each version of the consent form can be associated with specific DAGs, ensuring that only authorized users within the designated groups can access and manage the consents. Here's how to set it up:Enable Data Access Groups:Ensure that DAGs are enabled in your REDCap project. This can be done through the project settings or by contacting your REDCap administrator.Create Consent Forms:In the Online Designer, create your consent form, ensuring it includes all necessary fields, such as participant name, date of birth, and signature fields.Enable e-Consent Framework for the Consent Form:In the Online Designer, enable the e-Consent Framework for the consent form.Configure the settings for the e-Consent Framework, including the primary settings and signature fields.Add Consent Versions for Each DAG:Within the e-Consent Framework settings, add a new consent version for each DAG.When adding a new consent version, specify the DAG associated with that version. This ensures that the version log will track the DAG for each consent form version.Configure PDF Snapshots:Navigate to the e-Consent Framework and PDF Snapshots button from the Online Designer.Select the PDF Snapshots tab and add a new trigger.Define the conditions for the trigger, specifying the forms and DAGs that will be included in the snapshot.Choose the storage location for the snapshot (File Repository or specified field).Customize the file name template for the snapshot, if desired.Save the trigger settings.Assign Users to DAGs:In the User Rights section of your REDCap project, assign users to the appropriate DAGs. This will restrict access to consent forms based on the user's DAG membership.Ensure that only authorized users within the designated DAGs can access and manage the consent forms.Verify Setup:Run tests to verify that consent forms are correctly restricted to users within the appropriate DAGs.Ensure that the PDF snapshots are generated correctly for each DAG version and are stored in the specified location.Track Version and DAG in Version Log:The version log within the e-Consent Framework will automatically track the DAG associated with each version of the consent form. This helps maintain a clear record of which DAG was responsible for each version.
--------------------
Q120: What is the PDF Snapshot feature in REDCap?
A120: The PDF Snapshot feature in REDCap allows you to automatically generate and store PDF copies of completed surveys and consent forms. This feature ensures secure and organized storage of survey responses and consent documents, meeting regulatory requirements and improving data integrity.
--------------------
Q121: How do I set up a PDF Snapshot trigger?
A121: Navigate to the Online Designer:Go to the Online Designer page in your REDCap project.Access e-Consent Framework and PDF Snapshots:Click on the e-Consent Framework and PDF Snapshots button.Select the PDF Snapshots tab.Add New Trigger:Click the "Add new trigger" button.Define the conditions for the trigger (e.g., survey completion, specific field value).Specify Forms and Storage Location:Specify which forms and/or surveys will be included in the snapshot.Choose where the snapshot will be stored (File Repository, specified field, or external storage).Customize File Name:Customize the file name template for the snapshot, using static text or piping, appended with the date-time of the snapshot generation.Save the Trigger:Save the newly configured PDF snapshot trigger.Test the setup to ensure everything is configured correctly.
--------------------
Q122: Can I modify or copy an existing PDF Snapshot trigger?
A122: Yes, you can modify or copy an existing PDF Snapshot trigger. To do this:Navigate to the PDF Snapshots Tab:Go to the Online Designer and select the PDF Snapshots tab.Modify a Trigger:Locate the trigger you want to modify.Click the edit button next to the trigger to make changes.Copy a Trigger:Locate the trigger you want to copy.Click the copy button next to the trigger to duplicate it.Make any necessary changes to the copied trigger and save it.
--------------------
Q123: Can I use conditional logic with PDF Snapshots?
A123: Yes, the PDF Snapshot feature supports enhanced conditional logic integration. You can define conditions for the snapshot trigger based on specific events or field values. This allows for more granular control over when and how PDF snapshots are generated.
--------------------
Q124: Where can I store the generated PDF snapshots?
A124: PDF snapshots can be stored in multiple locations, depending on your project needs:File Repository:The default storage location for PDF snapshots is the project's File Repository.Specified Field:You can choose to store the snapshot in a specified field within the project.External Storage:If external storage is enabled (e.g., SFTP, WebDAV, Azure, S3), PDF snapshots can also be stored on an external file server for additional security and compliance.
--------------------
Q125: How do I customize the file names of PDF snapshots?
A125: To customize the file names of PDF snapshots:Navigate to the PDF Snapshots Tab:Go to the Online Designer and select the PDF Snapshots tab.Edit or Add a Trigger:When configuring or adding a new trigger, you can define the file name template.Customize File Name Template:Use static text, smart variables, and piping to customize the file name.The file name will automatically include the date-time of the snapshot generation.
--------------------
Q126: How do I ensure compliance and security with PDF Snapshots?
A126: Ensuring compliance and security with PDF Snapshots involves multiple aspects typically managed at the admin level based on site-specific policies and procedures. Here's what you need to know:Data Encryption: The REDCap administrators generally configure data encryption settings according to your institution's policies. Users should contact their local REDCap admin team to understand their instance's encryption settings and procedures.Access Controls:Access to PDF snapshots is controlled through project design and user rights.Project Design Control: This affects how consents are created, associated with surveys, and used.User Rights: These settings determine who can access the file repository where PDF snapshots are stored. Special user rights such as Data Access Groups (DAGs) can also restrict access to specific users.Users should ensure that appropriate permissions are set within their project to maintain security and compliance.Audit Trails: REDCap automatically logs all actions related to PDF snapshot generation. Regularly reviewing these audit logs can help monitor for unauthorized access or modifications. - For detailed information on your instance's logging policies, contact your local REDCap admin team.Best Practices:Always consult with your local REDCap administration team to understand your instance's settings, policies, and procedures to ensure compliance and security for your PDF snapshots and overall project data.Always contact your IRB or regulatory body to ensure compliance with specific laws and regulations governing your study
--------------------
Q127: Can I customize the header and footer of the PDF consent form?
A127: REDCap can customize the header and footer of the PDF consent form. This can be done in the e-Consent Framework settings:Navigate to the Online Designer:Go to the Online Designer page in your REDCap project.Access the e-Consent Framework:Click on the e-Consent Framework button.Select the survey for which you want to customize the header and footer.Customize Header and Footer:In the e-Consent settings, you can add static text, smart variables, and piping to the header and footer sections.Customize the content as needed to include relevant information such as participant IDs, study names, and dates.
--------------------
Q128: How do I manage user access to PDF snapshots?
A128: User access to PDF snapshots can be managed through:The "User Rights" section where permissions for accessing the File Repository and specific fields can be set.Ensuring that only authorized users have permission to view, download, or manage PDF snapshots stored in the File Repository or specified fields.
--------------------
Q129: How are audit trails managed for e-consents and PDF snapshots?
A129: REDCap automatically logs all actions related to e-consents and PDF snapshots, creating a comprehensive audit trail. This includes:The creation, modification, and viewing of e-consent forms.The generation and storage of PDF snapshots.User interactions with e-consents and PDF snapshots, ensuring all activities are recorded for compliance and review.
--------------------
Q130: How can I review the audit trails for e-consents and PDF snapshots?
A130: To review audit trails:Navigate to the "Logging" section in your REDCap project.Filter logs to view specific actions related to e-consents and PDF snapshots.Use the audit logs to verify compliance with regulatory requirements and ensure all actions are properly documented.
--------------------
Q131: Are there any restrictions to what you can name a variable/field?
A131: The terms "variable name" and "field name" are used interchangeably in REDCap. Variable names can only contain lowercase letters, numbers, and underscores. It is important to note that while numbers are allowed within a variable name, it is not possible to start a variable name with a number. Although the technical limit for a variable name is extremely long, best practice is to keep them short while still being meaningful. You may receive a pop up warning when a variable name exceed 26 characters; as this length could potentially lead to complications when exporting data to certain statistical software packages.Additionally, there are a few more restrictions enforced on variable names. While it is possible to include some of these terms in a variable name, it is not possible to name a variable any of the following:redcap_event_namefield_labelclassredcap_csrf_tokenevent_idenumredcap_survey_timestamphidden_edit_flagcatchredcap_survey_identifiernewthrowredcap_survey_return_codereturndocumentredcap_data_access_groupcontinuesuperredcap_repeat_instanceinstancefocusredcap_repeat_instrumentswitchelementsform_1_return_codeactiontargetform_1_timestampcasesubmit
--------------------
Q132: Are there any restrictions to what you can name a data collection instrument?
A132: Naming instruments using the Online Designer do not have restrictions. Naming instruments using the Data Dictionary is restricted to lowercase and may contain only letters, numbers, and underscores.
--------------------
Q133: Are there restrictions to the number of data collection instruments you can have in one project?
A133: Currently, there are no restrictions on the number of data collection instruments per project.
--------------------
Q134: Are there restrictions to the number of fields you can have in one instrument?
A134: No. There are no restrictions on the length or number of fields per instrument. The best practice is to keep instruments fairly short for easier data entry, and to ensure that you're saving data to the server more frequently.For long surveys, you can use section headers and enable the feature "Display Questions" = One Section Per Page. This will allow participants to save each section when they click "next page".
--------------------
Q135: Can multiple users build/edit a project at the same time/simultaneously?
A135: Multiple users can build or edit a project simulataneously, but it is not a best practice, especially if they are working on the same part of the project. It is very easy to make changes the other person isn't aware of, to make changes the contradict the changes the other person is making, or to make changes that will affect the data in ways you don't expect--especially when paired with the other person's changes. If multiple people are making changes at the same time, they need to communicate very closely, and the changes need to be tested very carefully.
--------------------
Q136: What is the difference between a data entry form and a survey?
A136: REDCap defines Data Collection Instruments as "data entry forms" and "surveys".With "surveys" you can collect data directly from participants. Participants will access your questions via a secure webpage. No authentication is required; however, you can enable the Survey Login feature if needed.With "data entry forms", data is entered by authorized REDCap project users. REDCap log-in access and project rights are required to view and edit the data entry forms.
--------------------
Q137: Can I insert a smiley face or emoticon or an image into a field choice label?
A137: You can hardcode emoticons into the label--you can find a list of the codes here:https://emojiguide.org/If you use this option, make sure to test using the data dictionary and test it in different browses to make sure they all recognize the codes you're using.The other option is to create a descriptive field with images in the proper places and put it above the radio buttons of LH alignment.
--------------------
Q138: How to set/unset that changes to a record require providing a reason for the change?
A138: Project Setup tab -> Enable optional modules and customizations section -> click on "Additional customizations" button -> check/uncheck "Require a 'reason' when making changes to existing records?"Require a 'reason' when making changes to existing records?Require users to enter a reason (200 character max) in a text box when making any data changes to an already existing record on a data collection instrument. The prompt is triggered when clicking the Save button on the page. Any 'reasons' entered can then be viewed anytime afterward on the Logging page.
--------------------
Q139: Is it possible to change the format (colors, text) of the form, field or text display?
A139: The general data entry templates are static and cannot be changed. Survey Themes in the Survey Settings page allows you to customize the font and background colors for many sections of a survey.REDCap does allow the use of some HTML and CSS in the Field Label and Field Notes. Please note that HTML tags print as text on the pdf exports/forms and do not print the formats created with the HTML tags.Check out this example survey for formatting ideas:https://redcap.vumc.org/surveys/?s=JA3AXMHYC7
--------------------
Q140: How can I improve the layout of my form/survey for data entry? What is field embedding?
A140: The best way to improve the layout of your form or survey is with field embedding. Field embedding is a way to customize data entry forms and surveys to make them look exactly how you want. Field Embedding allows you to reposition field elements on a survey page or data entry form so that they get embedded in a new location on that same page. For example, you may place fields in a grid/table for a more compact user-friendly page, or you can position some fields close together in a group if they are related. You do this by including the variable name in { } brackets where you want it to display on a form. For example: {var1}You can see examples and read a longer explanation of field embedding inside any REDCap project. Look for the yellow “Field embedding” button on the Project Setup page in the “Design your data collection instruments & enable your surveys” box, at the top of the page when you edit a form in the Online Designer, or under the Variable Name box when you are editing a specific field. You can also see a more detailed explanation here:https://redcap.vumc.org/redcap_v15.4.3/DataEntry/field_embedding_explanation.phpNote: When you download a .pdf file of an instrument with Field Embedding, you will see the instrument as it appears in Online Designer, not as a survey respondent or data entry person will see the instrument when creating a record.
--------------------
Q141: How can I put the "other" text box by my answer choice in a multiple choice question?
A141: You can do this with field embedding. Create both your multiple choice question with all of your answer choices, and create a separate text field where people can enter the “Other” answer clarification.In your multiple choice question, go down to the list of answers. You want to add the variable name for your “other” text box in { } next to the “Other” answer choice. For example:99, Other {other_answer}
--------------------
Q142: Can I use field embedding to have a free text field next to an option in a dropdown question?
A142: It is possible to embed a free text field (for example, a text box next to an "Other" option) next to an answer choice in a radio question, but not in a dropdown question. To do this with a dropdown, you first need to create a secondary field that is a descriptive field and then embed both the dropdown and the text box in the same descriptive field.
--------------------
Q143: Is it possible to use branching logic to skip an entire form or forms?
A143: While branching logic is only available on a field-by-field basis, REDCap does have what could be considered a form-level branching logic called Form Display Logic. Form display logic is located on the online designer page of your REDCap project. Form display logic may be used to disable an entire instrument(s) for data collection until certain conditional logic is met. The form will still appear on the record status dashboard (unless you hide the form using a custom record status dashboard), but the form will be inaccessible and greyed out. During data collection, the "Save & Go To Next Form" button will save the current form and skip any forms that should be disabled by form display logic.In the case of surveys, you may skip entire surveys by using either the Survey Queue (located on the online designer page) or Conditional logic for Survey Auto-Continue (located in the individual instruments survey settings).
--------------------
Q144: Is it possible to use branching logic to skip an entire section?
A144: Branching logic is only available on a field-by-field basis. While it cannot be applied at once to a section within an instrument, you could skip an entire section of a form using branching logic. To skip an entire section, you would need to create branching logic on ALL fields within two section header fields on the instrument. Section headers themselves, do not allow for branching logic. If branching logic hides all fields within two section headers the first section header will also be hidden. This would hide or skip that entire section on the instrument.If the section can be separated into a different instrument without other fields not related to the branching logic, REDCap does have what could be considered a form-level branching logic called Form Display Logic. Form display logic may be used to disable the entire instrument for data collection until certain conditional logic is met. The form will still appear on the record status dashboard, but the form will be inaccessible and greyed out (unless you hide the form using a custom record status dashboard).In the case of surveys, you may skip entire surveys by using either the Survey Queue (found in the online designer) or Conditional logic for Survey Auto-Continue (found in the individual instruments survey settings).
--------------------
Q145: What is the Field Annotation?
A145: This metadata field was added in v6.5. An annotation can be added to any field via the Online Designer or Data Dictionary (column R). It can be used for several purposes, such as for the bookkeeping of a project's field structure (as metadata about the given field) for reference purposes regarding what the field represents or how it should be used (during data entry, analysis, etc.). Field annotations are not displayed on any page but are merely for reference. Field annotations can also be used to map the field to various standards (e.g., CDISC, SNOMED, LOINC) using whatever notation the user sees fit (e.g., using a simple ID code for the standard or a complex XML structure containing information about how to transform the data to the standard). Since it is an annotation for reference purposes, REDCap will not do anything with the field annotation text on its own, but the annotation can be obtained by users at any time for any purpose (typically accessed via the Data Dictionary download or via the API metadata export).
--------------------
Q146: I get an error message when I attempt to upload a really large data dictionary. Does REDCap set a limit on the file size of an imported data dictionary?
A146: REDCap can be configured to allow large files to be uploaded. You'll need to contact your local REDCap Administrator about your institution's file upload limits.
--------------------
Q147: What is the Data Dictionary?
A147: The Data Dictionary is a specifically formatted spreadsheet in CSV (comma separated values format) containing the metadata used to construct data collection instruments and fields. The changes you make with the data dictionary are not made in real time to the project (off-line method). The modified file must first be uploaded successfully before changes are committed to the project.
--------------------
Q148: What is the Online Designer?
A148: The Online Designer will allow you to make create/modify/delete data collection instruments and fields (questions) very easily using your web browser. Changes are made in real time and available immediately for review and testing.
--------------------
Q149: How do I make edits to a data dictionary for a project in development or already in production?
A149: 1. If the project is still in development, then download the current data dictionary and save as Version 0. This step is not necessary for a project already in production since REDCap stores all previous versions of the data dictionary (since moving to production) in "Project Revision History".Note: If study records already exist in the database, then it is good practice to export the raw data before proceeding. It is important to have a backup of your project as it currently exists should you need to go back to the original version.2. Make a copy of the Version 0 database and save as Version 1 in CSV format.3. Make edits/additions/deletions to Version 1 and save.4. Upload the entire revised Version 1 data dictionary to your project.Warning: Uploading the new data dictionary will overwrite, not update, the original data dictionary (Version 0), so it is necessary to upload the revised file in its entirety. If you have multiple developers on a project, it is also important to communicate and coordinate revisions. You do not want to be working on an outdated "local" version of your data dictionary if others have been updating the project in REDCap. Always download a new current version prior to making changes.
--------------------
Q150: How do I define a biomedical ontology lookup in the data dictionary?
A150: Setting up a biomedical ontology in the data dictionary is done by first defining a variable with the text field type without any other validations attached.You will also have to define which ontology you want for this variable. You do this by inserting the text "BIOPORTAL:" plus the correct shorthand code into the "choices, Calculations, OR Slider Labels" column in the data dictionary (typically column F).E.g. A lookup for the ICD-10 ontology would need to be coded as "BIOPORTAL:ICD10".Be careful to make sure that the entire code is in all caps and does not contain the quotation marks.The ontology lookup short hand codes can be found in two ways:1) In the online designer, look for the biomedical ontology dropdown (only visible in text variables). Each ontology will have the shorthand code displayed before the dash.e.g. Entry: "ICD10 - International Classification of Diseases, version 10". The "ICD10" part is the shorthand code.2) Go to thebioportal websiteand look for your ontology of choice. In the description of any ontology, there will be a field for "acronym". That acronym is what REDCap uses as a shorthand code.
--------------------
Q151: How can I combine multiple instruments in one project?
A151: Download the data dictionary for the project. Make sure the forms are all next to each other and change the instrument name for all the instruments you want to combine to the same name. Save the data dictionary as a CSV and upload it back into REDCap. The forms will now be one form with the new name.
--------------------
Q152: Can I populate radio buttons, dropdowns and checkbox field choices using an "if then" statement?
A152: There is currently no way of populating field choices dynamically. You can create multiple fields and response option lists and hide or display them using branching logic. In certain circumstances, you may be able to populate a dropdown list from another REDCap field, but this is a very specific use case and requires contacting a REDCap Admin.
--------------------
Q153: What are the field types?
A153: The Field Type dictates how the field will be shown on the data entry form or survey and what data type will be collected.Options include:Unstructured Fields:Unstructured data such as text and notes fields collect information that does not have a pre-defined data model such as dates, numbers, and strings of text.TEXTSingle-line text box that allows strings of text or used with validation for numbers, emails, dates, etc.NOTESLarge text box that has multiple lines for textStructured Fields:Structured data is a pre-defined data model with an established set of answer choices in a standardized format.YESNORadio buttons with yes and no options; coded as 1, Yes | 0, NoTRUEFALSERadio buttons with true and false options; coded as 1, True | 0, FalseDROPDOWNDropdown menu with optionsRADIORadio buttons with optionsCHECKBOXCheckboxes to allow selection of more than one optionSLIDERVisual analogue scale; coded numerically on a scale specifiedUnique Fields:The unique field types collect data that does not align with structured/unstructured data but are each distinct in the type of data collected such as documents, interactive image capturing, or calculations.FILEUpload a document or imageSIGNATUREDraw a signature with finger or mouse. Please note that when you use the data dictionary, the field type is "FILE" with Text Validation Type "signature"CALCPerform real-time calculations resulting in anumerical valueon data entry forms and surveys using standard math and/or built-in REDCap special functions.Descriptive Fields:Descriptive fields are fields that do not collect data but rather provide information on data entry forms and/or surveys.DESCRIPTIVEDisplay string of text with optional image/file attachment for instructional or informational purposesDynamic Query (SQL) Fields:Only REDCap administrators can program SQL fields. If you would like more information about SQL fields at your institution, please reach out to your REDCap administrator.SQLSelect query statement to dynamically populate dropdown choices
--------------------
Q154: What are the possible Text Validation Types?
A154: Certain text validation types must be enabled by a REDCap Admin. If you do not see an option below in your instance, contact your REDCap Administrator.Validation AnnotationExampleNotesdate_dmy31-12-2008date_mdy12-31-2008date_ymd2008-12-31datetime_dmy16-02-2011 17:45datetime_mdy02-16-2011 17:45datetime_ymd2011-02-16 17:45datetime_seconds_dmy16-02-2011 17:45:23datetime_seconds_mdy02-16-2011 17:45:23datetime_seconds_ymd2011-02-16 17:45:23emailjohn.doe@vanderbilt.eduinteger1, 4, -10whole number with no decimalalpha_onlynameletters only, no numbers, spaces or special charactersnumber1.3, 22, -6.28, 3.14e-2a general number or scientific notation (no spaces)number_1dp_comma_decimalnumber to 1 decimal place - comma as decimalnumber_1dpnumber to 1 decimal placenumber_2dp_comma_decimalnumber to 2 decimal place - comma as decimalnumber_2dpnumber to 2 decimal placenumber_3dp_comma_decimalnumber to 3 decimal place - comma as decimalnumber_3dpnumber to 3 decimal placenumber_4dp_comma_decimalnumber to 4 decimal place - comma as decimalnumber_4dpnumber to 4 decimal placenumber_comma_decimalnumber comma as decimalphone_australiaphone615-322-2222Area codes start with a number from 2-9, followed by 0-8 and then any third digit.The second group of three digits, known as the central office or schange code, starts with a number from 2-9, followed by any two digits.The final four digits, known as the station code, have no restrictions.postalcode_australia21504-digit numberpostalcode_canadaK1A 0B1Format: A0A 0A0 where A is a letter and 0 is a digitssn123-12-1234Format: xxx-xx-xxxxtime_hh_mm_ss04:12:22time in hours, minutes, and seconds (HH:MM:SS)time19:30military time (HH:MM)time_mm_ss31:22Time in minutes and seconds (MM:SS)vmrn012345678910 digitsZipcode01239U.S. Zipcode
--------------------
Q155: What to consider when choosing radio button vs drop-down?
A155: Dropdown:Ability to use short cut keysLess space on forms; use when you have limited spaceRadio Button:Good when you need your choices visibleGood option for minimal response optionsAvailable with the matrix options when building forms
--------------------
Q156: Is there a question type that is a radiobutton/checkbox/dropdown with a text box for "Other, specify"?
A156: No, this specific question type is not available. You can add a text field after the question and use branching logic so that if "Other" is selected, a text box appears to capture the data.
--------------------
Q157: Can I set minimum and maximum ranges for certain fields?
A157: If validation is employed for text fields, min and max values may be utilized. Min, max, neither or both can be used for each individual field. The following text validation types may utilize min and/or max values:DATE_YMDDATE_MDYDATE_DMYTIMEDATETIME_YMDDATETIME_MDYDATETIME_DMYDATETIME_SECONDS_YMDDATETIME_SECONDS_MDYDATETIME_SECONDS_DMYNUMBERINTEGER
--------------------
Q158: What is the character limit for a variable name, field label, text typed into a "text box (short text)", and text typed into a "notes box (paragraph text)"?
A158: The maximum number of characters are:Field name: *Recommended: <26, Max: 100Field label: ~65,000Text typed into a "text box" field: ~65,000Text typed into a "notes box" field: ~65,000*Most stats packages (SAS, STATA...) will truncate variable/field names to max of 26 characters.
--------------------
Q159: Is it possible to restrict text inputs to a defined length or digit/character combination?
A159: You can restrict text inputs by using custom field validation types. Custom field validation types must be created by the REDCap Development team. Your REDCap Administrator will be able to submit requests for new custom field validation types. The request will be evaluated by the concerned team and approved requests will be fulfilled. However it is not possible to specify a deadline for meeting the request.
--------------------
Q160: Can I shorten an instrument by grouping related questions together using a columnar format?
A160: It is not possible to build survey or data entry forms in a columnar format in REDCap. You can use a combination of branching logic, section headers and descriptive text to shorten the instrument and group related questions.
--------------------
Q161: What are the Custom Alignment codes for the data dictionary?
A161: RV - right verticalRH - right horizontalLV - left verticalLH - left horizontal
--------------------
Q162: Can I upload files to attach to individual subject records?
A162: Yes, you can upload documents for individual records.To create a new document upload field in the Data Dictionary for any given REDCap project, set the Field Type = 'file'. You may add as many 'file' fields as needed to your data collection instruments.Documents can be uploaded and downloaded by navigating to the record's data entry page and clicking the file link. A document can be deleted at any time, and there is no limit to how many times the document can be replaced by uploading another file to that record's file upload field.Contact your REDCap Administrator to confirm if this field type is available and what the maximum upload file size is at your institution.
--------------------
Q163: Are data from checkbox (choose all that apply) field types handled differently from other field types when imported or exported?
A163: Yes. When your data are exported, each option from a checkbox field becomes a separate variable coded 1 or 0 to reflect whether it is checked or unchecked. By default, each option is pre-coded 0, so even if you have not yet collected any data, you will see 0's for each checkbox option. The variable names will be the name of the field followed by the option number. So, for example, if you have a field coded as follows:Race1, Caucasian2, African American3, Asian4, OtherIn your exported dataset, you will have four variables representing the field Race that will be set as 0 by default, coded 1 if the option was checked for a record. The variable names will consist of the field name. three underscores, and the choice value:race___1race___2race___3race___4Notes:when you import data into a checkbox field, you must code it based on the same modelnegative values can be used as the raw coded values for checkbox fields. Due to certain limitations, negative values will not work when importing values using the Data Import Tool, API and cause problems when exporting data into a statistical analysis package. The workaround is that negative signs are replaced by an underscore in the export/import-specific version of the variable name (e.g., for a checkbox named "race", its choices "2" and "-2" would export as the fieldsrace___2race____2A checkbox field can be thought of as a series of yes/no questions in one field. Therefore, a yes (check) is coded as 1 and a no (uncheck) is coded a 0. An unchecked response on a checkbox field is still regarded as an answer and is not considered missing.
--------------------
Q164: How do I setup standard values for missing data codes?
A164: The "Missing Data Codes" functionality can be setup in the "Additional Customizations" Menu in the Project setup page. That menu also includes additional documentation on how to best use "Missing Data Codes".It's recommended that you consult a statistician about the appropriate data codes for your data set.
--------------------
Q165: What is the Question Number (surveys only) column in the data dictionary?
A165: For surveys, you can use this column to enter number of the survey question for screen display.
--------------------
Q166: How do I create a set of variables for an unknown number of possible responses for the same question?
A166: For a question with an unknown number of answers, such as how many medications someone is taking, you may want to display the fields only as they are needed. REDCap currently is not able to dynamically create fields; however, there is a way to use branching logic to approximate this.If you can estimate the maximum number of fields you will need, you can create that many copies of your field to hide and display as needed using branching logic.Example 1: If you think 15 is a good maximum, you would create 15 copies of the field. Then, in order to only show the fields that are needed, you could create a "count" variable. Your branching logic would look like this:field1: [count]>0field2: [count]>1field3: [count]>2and so on.If your variable is medications, and the respondent takes 2 medications, you enter 2 in [count] variable, then the med1 and med2 fields appear. If they take 3, you enter that, and meds1 to med3 fields appear.Example 2a:Another method is to first create the maximum number of fields that you estimate will be needed, as above, and then hide and display each field as the previous field receives data. Using this method will cause each field to show up as needed. Your branching logic would look like:field2: [field1] <> "" or [field2] <> ""field3: [field2] <> "" or [field3] <> ""field4: [field3] <> "" or [field4] <> ""and so on.The fields in this example are text fields. If field1 "does not equal blank" (aka if data is entered for field1), then field2 will display. This example will also retain any given field that happens to have data already.Example 2b:If you want to only show a field if there is not a previous field that is empty, the branching logic will need to check every previous field:field2: [field1] <> ""field3: [field1] <> "" and [field2] <> ""field4: [field1] <> "" and [field2] <> "" and [field3] <> ""and so on.
--------------------
Q167: How do I indicate "dates" in the data dictionary?
A167: Text Validation Types: Use for text field data validationFormatExampleDATE_DMY16-02-2011DATE_MDY02-16-2011DATE_YMD2011-02-16DATETIME_DMY16-02-2011 17:45DATETIME_MDY02-16-2011 17:45DATETIME_YMD2011-02-16 17:45DATETIME_SECONDS_DMY16-02-2011 17:45:23DATETIME_SECONDS_MDY02-16-2011 17:45:23DATETIME_SECONDS_YMD2011-02-16 17:45:23
--------------------
Q168: How are dates formatted? Can I change the date format?
A168: Dates can be formatted as mm-dd-yyyy, dd-mm-yyyy, and yyyy-mm-dd by using the text field > validation. These formats cannot be modified.
--------------------
Q169: Can I change date formats if I've already entered data?
A169: Any date fields that already exist in a REDCap project can be easily converted to other formats without affecting the stored data value. After altering the format of the existing date fields, dates stored in the project will display in the new date format when viewed on the survey/form. Therefore, you change the date format of a field without compromising the stored data.
--------------------
Q170: Why can't I see the different date formats in the Online Designer?
A170: New validation types are not automatically available will need to be enabled by your REDCap Administrator. Once enabled, they'll appear in the text validation drop-down list in the Online Designer. All formats are available via the Data Dictionary.
--------------------
Q171: How are the different date formats exported?
A171: The Data Export Tool will only export dates, datetimes, and datetime_seconds in YYYY-MM-DD format. Previously in 3.X-4.0, datetimes were exported as YYYY-MM-DD HH:MM, while dates were exported as MM/DD/YYYY. By exporting only in YYYY-MM-DD format it is more consistent across the date validation field types.If exporting data to a stats package, such as SPSS, SAS, etc., it will still import the same since the syntax code has been modified for the stats package syntax files to accommodate the new YMD format for exported dates. The change in exported date format should not be a problem with regard to opening/viewing data in Excel or stats packages.
--------------------
Q172: How are the different date formats imported?
A172: While the different date formats allow users to enter and view dates in those formats on a survey/form, dates must still only be imported either in YYYY-MM-DD or MM/DD/YYYY format.
--------------------
Q173: How do I display unknown dates? What's the best way to format MM-YYYY?
A173: When you set a text field validation type = date, the date entered must be a valid completed date. To include options for unknown or other date formats, you may need to break the date field into multiple fields. For Days and Months, you can create dropdown choices to include numbers (1-31, 1-12) and UNK value. For Year, you can define a text field with validation = number and set a min and max value (ex: 1920 - 2015).The advantage of the multi-field format is that you can include unknown value codes. The disadvantages are that you may need to validate date fields after data entry (i.e. ensure no Feb 31st) and there will be additional formatting steps required to analyze your data fields.
--------------------
Q174: Can I enter dates without dashes or slashes?
A174: Date values can be entered using several delimiters (period, dash, slash, or even a lack of delimiter) but will be reformatted to dashes before saving it (e.g. 05.31.09 or 05312009 will automatically be reformatted to 05-31-2009 for MM-DD-YYYY format).
--------------------
Q175: Avoid future dates?
A175: If you have another field validated as a date and with the @TODAY (and possibly the @HIDDEN or @READONLY), then you could use a Data Quality rule with the "Execute in real time on data entry forms" checkbox checked. The DQ rule real time execution won't work on a survey, so on a survey you would need to settle for a descriptive text field that displays an error message if the date is greater than your date field with @TODAY in it.
--------------------
Q176: Is there a way to hide the "today" button on date fields when it is not applicable to the question?
A176: Yes. You can turn it off on the project level by going to "Enable optional modules and customizations" on the Project Setup page. Go to "Additional Customizations" and uncheck "Display the Today/Now button for all date and time fields on forms/surveys?"To turn it off on the field level, you can use the actin tag @HIDEBUTTON on that field.
--------------------
Q177: How do you calculate e to a power in REDCap?
A177: REDCap doesn't have a specific function for e, so you will need to use the numerical equivalent to e and calculate on that. For example:(2.718281828) ^ ([field_1]). Both sides of the exponent need to be encased in parentheses.
--------------------
Q178: What are "identifiers"?
A178: There are 18 pieces of information that are considered identifiers (also called protected health information, or PHI) for the purposes of HIPAA compliance. When you indicate a variable as an Identifier, you have the option to"de-identify" your data on data exports. In the Data Export Tool, the identifier variables appear in red and there are de-identification options you can select prior to exporting the data.The 18 HIPAA identifiers are:1.Name2.Fax number3.Phone number4.E-mail address5.Account numbers6.Social Security number7.Medical Record number8.Health Plan number9.Certificate/license numbers10.URL11.IP address12.Vehicle identifiers13.Device ID14.Biometric ID15.Full face/identifying photo16.Other unique identifying number, characteristic, or code17.Postal address (geographic subdivisions smaller than state)18.Date precision beyond year
--------------------
Q179: How do I create a matrix of fields using the Online Designer?
A179: Navigate to the Online Designer and click the "Add Matrix of Fields" button that will appear either above or below each field. It will open up a pop-up where you can set up each field in the matrix. You can supply the field label and variable name for each field in the matrix, and you may also designate any as a required field. You have the option to display a section header above the matrix. You will also need to set the answer format for the matrix, either Single Answer (Radio Buttons) or Multiple Answers (Checkboxes), and then the matrix choice columns. Setting up the choices is exactly the same as for any normal multiple choice field in the Online Designer by providing one choice per line in the text box. Lastly, you will need to provide a matrix group name for your matrix of fields. The matrix group name is merely a tag that is used to group all the fields together in a single matrix group. The matrix group name can consist only of lowercase letters, numbers, and underscores, and the group name must not duplicate any other matrix group name in the project. Once you have provided all the requisite information for the matrix, click the Save button and the matrix will be created and displayed there with your other fields in the Online Designer.
--------------------
Q180: Why isn't the header for my matrix field hidden if all of the fields in the matrix are hidden?
A180: The Matrix Field Header is really just a Section Header. Like all Section Headers, it is only hidden if all of the fields in the section are hidden. Fields that come after the matrix but before another Section Header count as being part of the section.
--------------------
Q181: How do I create a matrix of fields using the Data Dictionary?
A181: In a data dictionary, creating a matrix of fields is as easy as creating any regular radio button field or checkbox field. Create your first field in the matrix as either a radio or checkbox field type (since matrix fields can only be either of these) by adding it as a new row in the data dictionary. You must provide its variable name and form name (as usual), then set its field type as either "radio" or "checkbox". Then set its field label in column E, its multiple choice options in column F, and then lastly in column P you must provide a Matrix Group Name.The matrix group name is how REDCap knows to display these fields together as a matrix. Without a matrix group name, REDCap will display the fields separately as normal radio buttons or checkboxes.The matrix group name can consist only of lowercase letters, numbers, and underscores, and the group name must not duplicate any other matrix group name in the project.After you have created your first field for the matrix and have given it a matrix group name, you may now create the other fields in the matrix in the rows directly below that field.To save time, it is probably easiest to simply copy that row and paste it as the next immediate row in the Data Dictionary. Then you only need to modify the variable name and label for the new row. Once you have created all your fields for the matrix, you can upload your data dictionary on the "Data Dictionary Upload" page in your REDCap project, and those fields will be displayed as a matrix on your data collection instrument.NOTE: All fields in a matrix must follow the following rules:must be either a "radio" or "checkbox" field type,must have the *exact* same choices options in column F,must have the same matrix group name in column P.If these requirements are not met, the "Upload Data Dictionary" page will not allow you to upload your data dictionary until these errors are fixed.
--------------------
Q182: How do I convert existing non-matrix multiple choice fields into a matrix of fields?
A182: Any existing group of radio button fields or checkbox fields in a REDCap project might possibly be converted into a matrix of fields. In order for fields to be grouped together into a matrix, the following things are required:fields must all be a Radio Button field or all be a Checkbox field,they must have the *exact* same multiple choice options (same option label AND same raw coded value), andthey must all be adjacent to each other on the same data collection instrument (or if not, they can be moved first so that they are adjacent).A matrix can be created only if those three conditions are met. The conversion of regular checkbox/radio fields into a matrix of fields cannot be done in the Online Designer but only using the Data Dictionary. To accomplish this:Download the existing data dictionary for the project from the "Upload Data Dictionary" page.Add to column P (i.e. Matrix Group Name) the matrix group name for *every* field that will be in the matrix.Save and upload the data dictionary on the "Data Dictionary Upload" pageConfirm those fields display as a matrix on your data collection instrument instead of separate fields.NOTE on Matrix Group name: The matrix group name is a tag that is used to group all the fields together in a single matrix group. The matrix group name can consist only of lowercase letters, numbers, and underscores, and the group name must not duplicate any other matrix group name in the project. The group name is not ever displayed on the form/survey during data entry, but is used only for design and organizational purposes. The matrix group name can be any value (even an arbitrary value), but it may be helpful to name it something related to the fields in the group (e.g. "icecream" if all the matrix fields are about ice cream).
--------------------
Q183: What is a matrix of fields in REDCap?
A183: REDCap can display a matrix group of fields in either Single Answer format (i.e. radio buttons) or Multiple Answer format (i.e. checkboxes). A matrix allows you to display a group of similar multiple choice fields in a very compact area on a page. This makes data entry forms and surveys much shorter looking. Using matrix fields is especially desirable on surveys because survey respondents are much less likely to leave a survey partially completed if the survey appears shorter, as opposed to looking very long, which can feel daunting to a respondent. So having compact sections of questions can actually improve a survey's response rate.A matrix can have as many rows or columns as needed. Although the more choices you have, the narrower each choice column will be. Any field in a matrix can optionally have its own branching logic and can be set individually as a required field. A matrix can also optionally have a section header.
--------------------
Q184: Can You Add Field Notes For Fields Within A Matrix Field?
A184: The data dictionary is the only way to add/edit field notes on matrix fields.
--------------------
Q185: What is Piping?
A185: The 'Piping' feature in REDCap allows you to inject previously collected data into text on a data collection form or survey, thus providing greater precision and control over question wording. See more about piping:https://redcap.link/piping
--------------------
Q186: How can you pipe the value of a field instead of the label?
A186: When you are piping the answer *FROM* a multiple Choice radio or drop-down field, it will by default display the option label (not the coded data value) into the location where the field is piped.You can however specify that thevalueis piped instead of the label.For example if your field of Favorite Ice Cream Flavor is a radio or drop-down field coded 'Chocolate', 'Vanilla', and 'Strawberry' (coded as 0, 1, 2, respectively), and you use [flavor] in your piping, the default resulting display will be Chocolate, Vanilla or Strawberry.If you wish to pipe the value (not the label) of a multiple choice field,append ':value'to the variable name inside brackets - e.g., [flavor:value]. In the above example this would return 0,1, or 2).You should also use':value'if piping inside the @DEFAULT Action Tag if you would like to pipe the value of a multiple choice field as the default value of a field.If you wish to pipe the value (not the label) of acheckboxfield you may also append':value'to the variable to return the raw value instead of the label.For example, if the Favorite Ice Cream Flavor field is a checkbox field and a respondent checked Chocolate (0) and Strawberry (2) as preferred flavours, then use[flavor:checked:value]and[flavor:unchecked:value]to return '0, 2' and '1', respectively.To pipe a specific option code’s value use[flavor(2):value]will return the raw value of 1 when Strawberry is checked or 0 if Strawberry is not checked.Code options:Icecream Flavor checked: [flavor:checked]Icecream Flavor checked value : [flavor:checked:value]Icecream Flavor unchecked : [flavor:unchecked]Icecream Flavor unchecked value : [flavor:unchecked:value]Icecream Flavor Coded value 2: [flavor(2)]Icecream Flavor Coded value 2 value: [flavor(2):value]Returns:Icecream Flavor checked: Chocolate, StrawberryIcecream Flavor checked value: 0, 2Icecream Flavor unchecked: VanillaIcecream Flavor unchecked value: 1Icecream Flavor Coded value 2: CheckedIcecream Flavor Coded value 2 value: 1In every REDCap project, you can find a link to more information about piping by clicking on the purple “Piping” button in the “Design your data collection instruments” box on the Project Setup page.You can also go tohttps://redcap.vumc.org/redcap_v15.4.3/DataEntry/piping_explanation.phpfor more detailed documentation on piping.
--------------------
Q187: Is it possible to pipe information from a repeating event or form?
A187: Yes. You can pipe contextual data from instances using the smart variables [previous-instance], [next-instance], [first-instance], [last-instance] , and [current-instance] and appending them to the variable name. For example:[variable][previous-instance]would pipe the value in variable on the previous instance of the repeating form.You can also pipe data from specific instances by appending the instance number in brackets after the variable name. For example:[variable][3]would pipe the value in variable on instance 3.
--------------------
Q188: Can I use the Participant List's Identifier Field to pipe information into the email invite?
A188: The Participant List Identifiercannotbe used as a location to pipe information to or from. If you are using the participant list with the identifier enabled then your survey is the first form in the project and you have not collected any data about that subject to pipe from/to. If your survey form is not the first form and you are using the participant list the identifier will default to the study id of the record. You can use a data entry form as your first form with "Designate an email field to use for invitations to survey participants" enabled to build a robust participant list that could have information piped into the survey invitation and the body of the survey(s) itself.
--------------------
Q189: How can I copy an instrument within a project?
A189: You can duplicate the form by downloading the data dictionary, copying the relevant rows, changing the name of the form and the variable names on the new rows, and uploading the form.On the Online Designer, you can click the "Choose action" drop-down next to a given instrument to copy the instrument. You will be given the choice to name the new instrument and to also provide the suffix text that gets appended to each variable name to prevent duplication of variable names.
--------------------
Q190: How can I copy instruments from one project to another?
A190: You can do this by downloading the data dictionary from both projects. You can then copy and paste the fields in the forms you want from one data dictionary to the other. You can do the same for data. Just export those fields from one and then import into the other after you have uploaded the revised data dictionary.
--------------------
Q191: How can I make changes to instruments I have uploaded to the REDCap Shared Library?
A191: You just repeat the process of adding an instrument to the library. Choose Share your instrument and follow the instructions. You will see a note that says you are replacing the existing instrument. There's also an option to delete the existing instrument if you want to completely remove it.
--------------------
Q192: What are calculated fields?
A192: Calculated fields are a powerful tool in REDCap that can be used during both data entry and analysis. For data entry, for instance, a calculated field could be used to determine a current age, and then that calculated field could be used by branching logic to only show certain questions to those who are 17 and under. Examples for data analysis include assigning different values to a choice based on some other field (perhaps the weight of a choice is dependent on age or sex), or producing the summation of a set of questions.REDCap calculations can include various mathematical operations from basic (addition, subtraction, etc.) to complex (standard deviation, rounding, mean, etc.), as well as conditional (if/then/else), and follow the standard order of mathematical operation. Calculated fields always result in a number. For calculations that produce a date or text, one can us the CALCDATE and CALCTEXT action tags on a text field.You can view the functions available in REDCap at this link: https://learn.redcap.unc.edu/redcap_v15.5.15//DataEntry/special_functions_explanation.php
--------------------
Q193: What is the difference between a calculated field and using @CALCTEXT or @CALCDATE?
A193: Calculated fields can only return numerical values. You should use a calculated field any time you want REDCap to give you back a number, such as calculating a BMI or the number of days between two dates. Calculated fields always return numbers.You can find more information about using calculations in the “Calculations” section of the FAQ and by using the “How do I format the equation” link when you create a calculated field in the Online Designer. Calculated fields always return numbers.@CALCTEXT is an action tag you can use on a text field that can return a text value. For example, you can use this if you have an “if” statement and you want REDCap to display the word “TRUE” if the result is true and “FALSE” if the result is false. @CALCTEXT always returns text.You can find more details on setting up @CALCTEXT by clicking on the red “Action Tags” button on the Project Setup page, editing a form in the Online Designer, or when editing a field.@CALCDATE is an action tag you can use on text field that is validate as a date or datetime. It will calculate a date or datetime a specific amount of time away from a date you give it. For example, if you know the discharge date and want to schedule a follow up ten days later, you can use @CALCDATE to tell you what day the follow up should be. @CALCDATE always returns a date.You can find more details on setting up @CALCDATE by clicking on the red “Action Tags” button on the Project Setup page, editing a form in the Online Designer, or when editing a field.
--------------------
Q194: What mathematical operations are available for calc fields?
A194: + Add- Subtract* Multiply/ DivideNOTE: All values that are not a number (including Null or blank values) are converted to "", so when testing whether or not a field is empty, you must compare to "", such as:if ([my_field] <> "", [my_field], 0)
--------------------
Q195: Can REDCap perform advanced functions in calculated fields?
A195: Yes, it can perform many, which are listed on the Help & FAQ page under the section "List of functions that can be used in Branching Logic, Calculations, Report filtering, Data Quality Module, Automated Survey Invitations, etc.".
--------------------
Q196: Why do some calculations not provide precisely the correct result?
A196: Computers store information as a series of ones and zeros, called binary, and although it's easy to write a number like 0.1, it's impossible for a binary system to represent 0.1 exactly. Because of this, a calculation like 165 * 0.7 might lead to a result like 115.499999 instead of the expected 115.5. When this happens, REDCap is attempting to represent the concept of the 9s repeating indefinitely, which is logically the same as the expected 115.5, but since there's also a limit on how many digits can be displayed, the infinitely repeating 9s are cut off.This can lead to a problem when attempting to round a number. In the above case, if we round the number to the nearest integer, e.g. 'round(165 * 0.7),' the expected result is 116, but because of the nature of binary numbers and the inability to handle infinitely repeating decimals, the actual result is 115.One way to avoid this rounding problem is to add a very small amount to the number being rounded, e.g. 'round(value + 0.000001)'. Typically one would add a number at least a couple of decimal points smaller than the significant digits of what is being rounded. So, for instance, in the above example one might add 0.0001, such that instead of 115.499999 being rounded down to 115, 115.500099 would be rounded up to 116.
--------------------
Q197: How do I format calculated fields?
A197: In order for the calculated field to function, it will need to be formatted in a particular way. This is somewhat similar to constructing equations in Excel or with certain scientific calculators.The variable names/field names used in the project's Data Dictionary can be used as variables in the equation, but you must place [ ] brackets around each variable. Please be sure that you follow the mathematical order of operations when constructing the equation or else your calculated results might end up being incorrect.
--------------------
Q198: How should single and double quotes be used in calculations that involve comparison operators?
A198: There has been a change in how calculated fields resolve and branching logic functions between versions 9 and 10 if you use single or double quotes around a number and the comparison operators “< ”, “<=”, “>”, or “>=”. Results of calculated fields will vary depending on whether or not the inputting text fields are validated as integers or numbers, and whether or not you use quotes around a number with a comparison operator in a calculation equation. Branching logic will also vary depending on whether or not you use quotes around a number with a comparison operator in a branching logic statement. The range of different results is too varied to recount in detail.Suffice it to say, the general principle you should follow when you use numbers and the comparison operators “< ”, “<=”, “>”, and “>=” in a calculated field (typically in anifstatement) or branching logic is:A numerical value should NEVER be wrapped by single or double quotes when using the comparison operators “< ”, “<=”, “>”, and “>=”. These comparison operators are meant to be used with numerical values only, not with numbers or integers “dressed” as text by putting quotes around them. You should continue to use the symbols “=” or “<>” with numbers or integers wrapped in quotes when you are referring to a numerical choice in a radio or dropdown field.If EVERY coded choice in a multiple-choice field (i.e., radio, dropdown) is a number, then REDCap will also treat the field as if it is a numerical field(similar to calculate fields, sliders, and number/integer-validated text fields).But if you have at least one choice that is not coded as a number, REDCap treats the field as a text string,and thus it should never be used with“< ”, “<=”, “>”, or “>=”.When using these comparison operators in calculated fields or branching logic, it ishighly recommendedyou include a statement in your calculation or branching logic indicating the input field cannot be blank before proceeding with resolving the comparison operator statement, to avoid issues with calculated fields becoming populated before input fields have been completed or fields with branching logic appearing when they shouldn’t.For example, let’s say you want to square participants’ height if it exceeds 1.5 m and you want the code “999” to appear in the calculated field if height is less than or equal to 1.5 m. Initially, you enter the following statement into the Calculation Equation box of the calculated field:if([height] > 1.5, ([height])^(2), 999). But when you create a record, the code “999” will appear in the calculated field before you enter any data in the [height] field. To avoid this issue, the statement in the Calculation Equation box should read:if([height] <> "", if([height] > 1.5, ([height])^(2), 999), "").Likewise, let’s say you want the descriptive text field warning “Heart rate is out of range” to appear if the participant’s heart rate is less than 45 bpm or greater than or equal to 115 bpm. In addition to the branching logic[heart_rate] < 45 or [heart_rate] >= 115, you should add[heart_rate] <> ""if you don’t want the warning to appear before entering data into the [heart_rate] field. Thus, the complete branching logic statement would read:[heart_rate] <> "" and ([heart_rate] < 45 or [heart_rate] >= 115).In previous versions, calculated fields could only utilize either numeric fields or date/datetime fields in the calculation. In REDCap 10.0 and higher, non-numeric fields may be used inside of calculated fields--most notably inside IF statements (eg, if([field1] = "A", 0, 99)--leading to the changes in the use of quotes.
--------------------
Q199: How to calculate a score if some of the values the calculation uses may be blank?
A199: For a calculated field, if the dependent variables are simply added together, then if any of the variables are empty, the resulting calculation will be empty:[answer1] + [answer2] + ... + [answerN]If, however, you use the 'Sum' function, than the resulting calculation will not be empty:sum([answer1],[answer2], ... [answerN])You can also use an 'if' statement to provide any desired value in place of an empty dependent variable. In the following case '-1' is supplied:if([answer1] = "", -1, [answer1])"" refers to any value that is not a number. For calculations, anything that is not a number is replaced with "" before the calculation is interpreted.
--------------------
Q200: Why does my field have a vertical red line at the end of the text or calculated field box?
A200: A vertical red line on the right side of your calculated field, or field using @PREFILL/@SETVALUE, @DEFAULT, or action tag that automatically fills data indicates that the value displaying in the browser does not match what has been saved in the database. If it is your first time opening the form, calculated fields and fields with automatically filled data will display the line until you save them and should disappear if you click "Save and Stay". If you have saved the form previously, it indicates something feeding the value has changed and you will need to resave the form to update the value in the database.
--------------------
Q201: Why does a Calculated Field without numeric validation return a "0" even when the field names used in the equation are blank?
A201: As of version 9.9.2, you can no longer use non-numeric fields in calculations and expect these calculations to work properly.If you use a Text Box in a calculation, you must set validation (i.e., integer or number).You can continue to use Radio Button fields in calculations, as long as you preface choices with numbers.If you wish to use calculation functions that apply to two or more fields – including sum, min, max, mean, median, and stdev–you must separate each field name in your equation by a comma(e.g., sum([field1],[field2],[field3],…)).You cannot use a hyphen between field namesin a Calculated Fieldto create a range of variables (e.g., sum([field1]-[field3]), even though the word “Valid” will appear at the bottom of the Calculation Equation box. Although you will be able to save an equation using a hyphen between field names, the equation will not work properly once you start entering data into records.Furthermore, if you use a hyphen between two or more Text Box fields in a Calculated Field, without setting validation of the fields to an integer or number, the number “0” will appear automatically in a record, before entering any data into the record. This result will be inaccurate and, depending on the use of branching logic involving the Calculated Field, it might also lead to branching logic error, since the Calculated Field will be populated with a “0” before prior fields are completed.
--------------------
Q202: Is there a way to have if/then calculations output a null result instead of a "0"?
A202: The calculation can have the final "else" evaluation be null by using "" or '' to indicate a null value. That would allow the calculated field to be hidden without creating popup warnings about values in hidden fields during data entry.
--------------------
Q203: Can calculations use negative numbers stored in other fields?
A203: Calculated fields and fields using @CALTTEXT can include the value of other fields in their calculation logic (e.g. if([field1] > [field2], [field1], [field2]) ).To be sure, however, that the value of included fields is handled as a number rather than as a string, be sure to set the validation of the other field as numeric. Otherwise, REDCap may treat a comparison involving a negative number as a string comparison rather than a numeric comparison.
--------------------
Q204: Can fields from different FORMS be used in calculated fields?
A204: Yes, a calculated field's equation may utilize fields either on the current data entry form OR on other forms. The equation format is the same, so no special formatting is required.
--------------------
Q205: Can fields from different EVENTS be used in calculated fields (longitudinal only)?
A205: Yes, for longitudinal projects (i.e. with multiple events defined), a calculated field's equation may utilize fields from other events (i.e. visits, time-points). The equation format is somewhat different from the normal format because the unique event name must be specified in the equation for the target event. The unique event name must be prepended (in square brackets) to the beginning of the variable name (in square brackets), i.e. [unique_event_name][variable_name]. Unique event names can be found listed on the project's Define My Event's page on the right-hand side of the events table, in which the unique name is automatically generated from the event name that you have defined.For example, if the first event in the project is named "Enrollment", in which the unique event name for it is "enrollment_arm_1", then we can set up the equation as follows to perform a calculation utilizing the "weight" field from the Enrollment event: [enrollment_arm_1][weight]/[visit_weight]. Thus, presuming that this calculated field exists on a form that is utilized on multiple events, it will always perform the calculation using the value of weight from the Enrollment event while using the value of visit_weight for the current event the user is on.
--------------------
Q206: Can I use conditional logic in a calculated field?
A206: Yes. You may use conditional logic (i.e. an IF/THEN/ELSE statement) by using the function:if (CONDITION, value if condition is TRUE, value if condition is FALSE)This construction is similar to IF statements in Microsoft Excel. Provide the condition first (e.g. [weight]=4), then give the resulting value if it is true, and lastly give the resulting value if the condition is false. For example:if([weight] > 100, 44, 11)In this example, if the value of the field 'weight' is greater than 100, then it will give a value of 44, but if 'weight' is less than or equal to 100, it will give 11 as the result.IF statements may be used inside other IF statements (“nested”). For example, if you wanted to look for values above ten if the chosen category was 4, but look for values below 20 if any other category was chosen, you could use:if([chosen_category] = "4", if([given_value] > 10, 1, 0), if([given_value] < 20, 1, 0))Other advanced functions (described above) may also be used inside IF statements.
--------------------
Q207: Can I create calculations and hide the values to the data entry personnel and/or the survey participants?
A207: If the calculations result in a value (including "0"), the field will display regardless of branching logic.You can hide calc fields with branching logic if you include conditional logic and enter the "false" statement to result in null: " " or "". For example: if([weight] > 100, 44, "") Then the field will remain hidden (depending on branching logic) unless the calculation results in a value.Another relatively new option is to use an Action Tag:@HIDDENHides the field on the survey page, the data entry form, and in the REDCap mobile app. Field will stay hidden even if branching logic attempts to make it visible.@HIDDEN-FORMHides the field only on the data entry form (i.e., not on the survey page). Field will stay hidden even if branching logic attempts to make it visible.@HIDDEN-SURVEYHides the field only on the survey page (i.e., not on the data entry form). Field will stay hidden even if branching logic attempts to make it visible.@HIDDEN-APPHides the field only on the form ONLY on the REDCap Mobile App. Field will stay hidden even if branching logic attempts to make it visible.
--------------------
Q208: Can calculated fields be referenced or nested in other calculated fields?
A208: Yes. Calculations can reference other calculations. Be sure to thoroughly test to ensure correct expected values. In particular, beware of creating infinite loops, in which a calculated field depends on other calculated fields that ultimately depend on itself.
--------------------
Q209: How do I calculate log(x) / ln(x)?
A209: To calculate a logarithm, you use the following formula:log([number], base). The field [number] refers to a field you create in one of your instruments, and it can have any variable name and field label. To ensure the calculation works correctly, you should validate the field as an integer or number.To calculate acommon logarithm(i.e., with base 10), you use the following:log([number], 10). To calculate anatural logarithm(i.e., with base e), you use the following:log([number], "e"). If the base is not provided or is not numeric, the equation defaults to base "e".
--------------------
Q210: How can I calculate the difference between two date or time fields (this includes datetime, datetime_seconds, and time HH:MM fields, but not time MM:SS fields)?
A210: You can calculate the difference between two dates or times by using the function:datediff([date1], [date2], "units", returnSignedValue)date1 and date2 are variables in your projectunits"y"years1 year = 365.2425 days"M"months1 month = 30.44 days"d"days"h"hours"m"minutes"s"secondsBoth dates MUST be in the format specified in order to work.For comparing two Time HH:MM fields, the date format is irrelevant.returnSignedValuefalse(default)trueThe parameter returnSignedValue denotes the result to be signed or unsigned (absolute value), in which the default value is "false", which returns the absolute value of the difference. For example, if [date1] is larger than [date2], then the result will be negative if returnSignedValue is set to true. If returnSignedValue is not set or is set to false, then the result will ALWAYS be a positive number. If returnSignedValue is set to false or not set, then the order of the dates in the equation does not matter because the resulting value will always be positive (although the + sign is not displayed but implied).Examples:datediff([dob],[date_enrolled],"d")Yields the number of days between the dates for the date_enrolled and dob fields, which must both be in Y-M-D formatdatediff([dob],"05-31-2007","h",true)Yields the number of hours between May 31, 2007, and the date for the dob field, which must be in M-D-Y format. Because returnSignedValue is set to true, the value will be negative if the dob field value is more recent than May 31, 2007.datediff([time_start],[time_end],"m")Yields the number of minutes between the start and end times.
--------------------
Q211: Can I base my datediff function off of today's date?
A211: Can I base my datediff calculation on today or now?Yes. You may substitute a date or datetime field in your datediff expression with "today" or "now".For example, you can calculate elapsed months since screening date using:datediff([screen_date],"today","M")or the elapsed time since the start of a test in minutes using:datediff([start_time],"now","m")Note1: If using a date field along with "now", REDCap will assume midnight (00:00) for the time component for the date field.Note2: It isstrongly recommended that you do not use "today" or "now" in calc fields. This is because every time you access and save the form, the calculation will run and update the field value. So if you calculate the age as of today, then a year later you access the form to review or make updates, the elapsed time as of "today" will also be updated (+1 yr). Most users calculate time from another field (e.g. screening date, enrollment date).
--------------------
Q212: Can Daylight Saving Time transitions affect date calculations?
A212: Daylight Saving Time transition will not affect your calculations involving dates.
--------------------
Q213: Can I calculate a new date by adding days / months / years to a date entered (Example: [visit1_dt] + 30days)?
A213: No. Calculations can only display numbers.
--------------------
Q214: Can I create a calculation that returns text as a result (Ex: "True" or "False")?
A214: No. Calculations can only result in numbers. You could indicate "1" = True and "0" = False.
--------------------
Q215: Can I create a calculation that uses a variable that is not a number, such as: if([field_name] = 'x', 1, 0)?
A215: Yes, this is allowable in newer versions of REDCap. Fields that are either numeric (e.g. integer, slider) or non-numeric (e.g., drop-down, free-form text) will work successfully inside an IF statement for calculated fields.
--------------------
Q216: If I need to modify a calculated field, how can I update all the records previously entered?
A216: Data Quality rule (rule H) will find and fix all incorrect values for calculated fields in a project. If any calc fields have ended up with incorrect values (whether due to field changes in the project or due to previous data imports), users can now run rule H not only to find any incorrect calculated values, but it will additionally display a button that, when clicked, will auto-fix ALL of them for the project admin.
--------------------
Q217: I created a calculated field after I entered data on a form, and it doesn't look like it's working. Why not?
A217: If you add a calculated field where data already exist in a form, data must be re-saved for the calculation to be performed.Use the Data Quality rule H to find and fix all incorrect values for calculated fields in a project.
--------------------
Q218: If I import data will new and modified data re-run and update the calculate fields?
A218: Yes. When performing a data import (via Data Import Tool or API), REDCap will perform the calculations for any calculated fields that are triggered by the values being imported. For example, if you have a BMI field whose calculation is based off of a height field and a weight field, then if you perform a data import of height and weight values, it will automatically calculate the BMI for each record that is imported and also save those calculations and log them on the Logging page.
--------------------
Q219: How can I concatenate multiple text fields into a single field?
A219: If the result of concatenating multiple text fields SHOULD NOT be editable, use the @CALCTEXT Action Tag with the concat special function. For example, to concatenate first and last name, with a space between them:@CALCTEXT(concat([first_name], ' ', [last_name]))If you are concatenating multiple text fields using the same separator between them, you can use the concat_ws() special function inside the @CALCTEXT instead:@CALCTEXT(concat_ws(" and ", [dessert1], [dessert2], [dessert3])If the result of concatenating multiple text fields SHOULD be editable, then use the @DEFAULT Action Tag. For example, to concatenate first and last name, with a space between them, but allow the result to be edited:@DEFAULT="[first_name] [last_name]"
--------------------
Q220: Are status icons for an instrument affected by calculated fields?
A220: The status icon for an instrument is there to provide a visual cue of whether data points have been manually entered on that page or imported for that instrument's fields. Calcs/calctexts having a value does not imply that data was entered/imported there because the calc can be triggered from data entry anywhere. Thus calcs/calctexts are ignored when determining if the status icon should be red vs gray.
--------------------
Q221: When are calculations for calculated fields and @CALCTEXT fields performed and saved?
A221: Data entry via forms or surveys will cause calculations to be performed in the same form or survey during data entry. The results of these calculations will only be saved to REDCap if the form is saved or if a survey is continued/submitted.Data entry via forms or surveys can cause cross-form and cross-event calculations, in which calculated fields and @CALCTEXT fields in other forms and in other events are potentially updated. The cross-form and cross-event calculations will be performed and saved when the original form or survey is saved/continued/submitted.Similarly, data imports via the Data Import Tool or the API can cause auto-calculations, in which calculated fields and @CALCTEXT fields in the same form, in other forms, and in other events are potentially updated. Auto-calculations will be performed and saved when the data being imported are saved.Cross-form calculations, cross-event calculations, and auto-calculations are performed for calculated or @CALCTEXT fields in which:the calculation logic refers to another field that has changed, ORthe calculation logic uses the 'if()' statement and both output options in the 'if()' statement are non-blank, implying that the field should always have a value.Cross-event calculations and auto-calculations are only performed in events which have any fields that already contain data. This is true of cross-form calculations as well, but by definition cross-form calculations only occur when an event has data.
--------------------
Q222: When viewing a scatter plot that has been created via REDCap Reports, what do the X and Y axis represent?
A222: The X axis represents the numerical value that is collected in the text field and displayed on the report. The Y axis functions as a place holder to provide spaces that separate the values for better viewing.
--------------------
Q223: What is branching logic?
A223: Branching Logic may be employed when fields in the database need to be hidden during certain circumstances. For instance, it may be best to hide fields related to pregnancy if the subject in the database is male. If you wish to make a field visible ONLY when the values of other fields meet certain conditions (and keep it invisible otherwise), you may provide these conditions in the Branching Logic section in the Online Designer (shown by the double green arrow icon), or the Branching Logic column in the Data Dictionary.For basic branching, you can simply drag and drop field names as needed in the Branching Logic dialog box in the Online Designer. If your branching logic is more complex, or if you are working in the Data Dictionary, you will create equations using the syntax described below.In the equation you must use the project variable names surrounded by[ ]brackets. You may use mathematical operators (=,< ,>,<=,>=,<>), Boolean logic (and/or), and unary Boolean not (!). You may nest within many parenthetical levels for more complex logic. If the project is longitudinal, in certain contexts you may need to additionally provide the unique event name, which must also be in brackets and prepended to the variable name, in order to target that field on a particular event - e.g., [event_2_arm_1][variable_name].You mustALWAYSput single or double quotes around the values in the equation UNLESS you are using > or < with numerical values.The field for which you are constructing the Branching Logic will ONLY be displayed when its equation has been evaluated as TRUE. Please note that for items that are coded numerically, such as dropdowns and radio buttons, you will need to provide the coded numerical value in the equation (rather than the displayed text label). See the examples below.[sex] = "0"display question if sex = female; Female is coded as 0, Female[sex] = "0" and [given_birth] = "1"display question if sex = female and given birth = yes; Yes is coded as 1, Yes([height] >= 170 or [weight] < 65) and [sex] = "1"display question if (height is greater than or equal to 170 OR weight is less than 65) AND sex = male; Male is coded as 1, Male[last_name] <> ""display question if last name is not null (aka if last name field has data)
--------------------
Q224: Can fields from different FORMS be used in branching logic?
A224: Yes, branching logic may utilize fields either on the current data entry form OR on other forms. The equation format is the same, so no special formatting is required.
--------------------
Q225: Can fields from different EVENTS be used in branching logic (longitudinal only)?
A225: Yes, for longitudinal projects (i.e. with multiple events defined), branching logic may utilize fields from other events (i.e. visits, time-points). The branching logic format is somewhat different from the normal format because the unique event name must be specified in the logic for the target event. The unique event name must be prepended (in square brackets) to the beginning of the variable name (in square brackets), i.e. [unique_event_name][variable_name]. Unique event names can be found listed on the project's Define My Event's page on the right-hand side of the events table, in which the unique name is automatically generated from the event name that you have defined.For example, if the first event in the project is named "Enrollment", in which the unique event name for it is "enrollment_arm_1", then we can set up the branching logic utilizing the "weight" field from the Enrollment event: [enrollment_arm_1][weight]/[visit_weight] > 1. Thus, presuming that this field exists on a form that is utilized on multiple events, it will always perform the branching logic using the value of weight from the Enrollment event while using the value of visit_weight for the current event the user is on.
--------------------
Q226: Is branching logic for checkboxes different?
A226: Yes, special formatting is needed for the branching logic syntax in 'checkbox' field types. For checkboxes, simply add the coded numerical value inside () parentheses after the variable name:[variablename(code)]To check the value of the checkboxes:'1' = checked'0' = uncheckedSee the examples below, in which the 'race' field has two options coded as '2' (Asian) and '4' (Caucasian):[race(2)] = "1"display question if Asian is checked[race(4)] = "0"display question if Caucasian is unchecked[height] >= 170 and ([race(2)] = "1" or [race(4)] = "1")display question if height is greater than or equal to 170cm and Asian or Caucasian is checked
--------------------
Q227: Can you utilize calculated field functions in branching logic?
A227: Yes, see the list of functions that can be used in logic for Report filtering, Survey Queue, Data Quality Module, and Automated Survey Invitations.
--------------------
Q228: How do I hide a calculation with branching logic without causing a notification from the web form?
A228: If a calculated field is hidden by branching logic but will evaluate to a number, it causes the web form to notify the data enterer about a hidden field with data in it. To avoid receiving the notification, use an "if...else" statement--if(X, ValueIfTrue, ValueIfFalse)-where the value if false is "".The statement should be written so if the calculated field is hidden, it will evaluate to false and provide the empty response, meaning there will be no data in the field. This will prevent the notification.
--------------------
Q229: Can you program branching logic using dates?
A229: Yes, see the list of functions that can be used in logic for Report filtering, Survey Queue, Data Quality Module, and Automated Survey Invitations.
--------------------
Q230: My branching logic is not working when I preview my form. Why not?
A230: Simply previewing a form within the Online Designer will display all questions. In order to test the functionality of your branching logic (and calculated fields), you must enter new records and enter test data directly into your forms.
--------------------
Q231: Why does REDCap slow down or freeze and display a message about a javascript problem when I try to use branching logic syntax or Drag-N-Drop Logic builder in a longitudinal project with over 1000 fields?
A231: You are encountering a limitation that stems from having a lot of fields especially multiple choice fields in your project. If a good number of your fields involve multiple choices then the number of choices that the Drag-N-Drop Logic Builder has to load into the pop-up is large. So having a lot of fields with several choices each can slow down the system. The performance is further affected because REDCap uses javascript (powered by the user's browser) to do the drag-n-drop and also to process the conversion of the advanced syntax to the drag-n-drop method (if you decide to switch methods within the pop-up).The slower your computer and the slower your browser (Internet Explorer is the worst, especially versions 6 and 7), than the slower the drag-n-drop method will be. Chrome is much faster at handling Javascript than other browsers and is recommended. The only other option is to use the data dictionary for building your branching logic.
--------------------
Q232: What are Action Tags?
A232: Action Tags are special terms that begin with the '@' sign that can be placed inside a field's Field Annotation. Each action tag has a corresponding action that is performed for the field when displayed on data entry forms and survey pages. Such actions may include hiding or disabling a given field (either on a survey, data entry form, or both).There is a comprehensive list of all available action tags that you may use within the Online Designer "Edit Field" pop up box. You can use as many as you want for a single field, but if you do use more than one tag for a field, make sure to put a space or line break between them. Because the action tags are used as part of the Field Annotation, they are not displayed anywhere on the page. For example, if you put @HIDDEN-SURVEY in a field's Field Annotation text box, then the field will always stay hidden when viewed on a survey page, but the field will be visible when viewing the same instrument as a data entry form, which might be helpful if you want to hide specific fields from your survey participants so that they do not see them. There are many different use cases for each action tag.
--------------------
Q233: What types of action tags are available in REDCap?
A233: Auto-fill Action Tags: Pre-fill a variable with a value@DEFAULT@LATITUDE@LONGITUDE@NOW@NOW-SERVER@NOW-UTC@SETVALUE@TODAY@TODAY-UTC@TODAY-UTC@USERNAMECalculation Tags: Calculate the value for a field@CALCDATE@CALCTEXT@DOWNLOAD-COUNT@IFCosmetic Tags: Change the look and feel of a variable without impacting the data@INLINE@INLINE-PREVIEW@PASSWORDMASK@PLACEHOLDER@RANDOMORDER@RICHTEXTEntry Limits Tags: Limit what can be entered in a variable@CHARLIMIT@FORCE-MINMAX@MAXCHECKED@MAXCHOICE@MAXCHOICE-SURVEY-COMPLETE@NOMISSING@NONEOFTHEABOVE@READONLY@READONLY-FORM@READONLY-SURVEY@WORDLIMITObscuring Tags: Action tags that hide a variable or make it uneditable@HIDDEN@HIDDEN-FORM@HIDDEN-PDF@HIDDEN-SURVEY@HIDECHOICE@HIDEBUTTON@SHOWCHOICEMobile App Tags: Action tags that are only useful when using the mobile app@APPUSERNAME-APP@BARCODE-APP@HIDDEN-APP@READONLY-APP@SYNC-APPMulti-Language Management: Action tags that are used with the MLM tool@LANGUAGE-CURRENT-FORM@LANGUAGE-CURRENT-SURVEY@LANGUAGE-FORCE@LANGUAGE-FORCE-FORM@LANGUAGE-FORCE-SURVEY@LANGUAGE-SET@LANGUAGE-SET-FORM@LANGUAGE-SET-SURVEY
--------------------
Q234: Does the @DEFAULT action tag work with fields hidden by branching logic?
A234: No, the @DEFAULT tag will not populate if the field is hidden when the form loads.Please note: If the action tag '@DEFAULT= ' is used on a branching logic hidden field, the action tag does fire on page load but it throws anerror message
--------------------
Q235: Will the @DEFAULT action tag work on fields hidden by branching logic?
A235: No, the @DEFAULT action tag is incompatible with branching logic. REDCap will by populate any default value to @DEFAULT'ed fields at the point of render. If that field with that value should not appear due to upstream branching you will receive an error message.
--------------------
Q236: Can I use action tags that automatically collect data (such as @NOW or @TODAY) when importing data using the file import tool to capture that information?
A236: No, you can't. You can manually enter data to import into those fields and import that data into them, but the file import process will not trigger the action tags to populate those fields with data.
--------------------
Q237: Where can I find more information about Action Tags?
A237: Navigate to Project Setup > Online Designer > Click on a data collection instrument > Click Add or Edit a field. Within the pop-up box, there is theAction Tags / Field Annotationoption and a link to learn more about Action Tags.
--------------------
Q238: What are repeating forms and events?
A238: Repeating forms is the ability to use the same form multiple times in a project or an event, without having to define how many times you want to use it. You can use it a different number of times for each record in the project and add new instances of the form as you need them for each record.For example, if you are collecting a list of medications, you could create a form that asks for one of the medications, and then add a new instance for each additional medication:In longitudinal projects, you have the option of repeating individual forms inside an event or repeating the event as a whole. If you choose to repeat just a form in an event, you will have multiple instances of just the form(s) you want to repeat. If you choose to repeat the entire event, all the forms in the event will be offered again, and you will have the same number of instances of each of the forms in the event, in that record. You cannot repeat an instrument inside a repeated event.
--------------------
Q239: How do I enable repeating forms and events?
A239: To enable repeating forms in a non-longitudinal project, navigate to the Project Setup page and go down to the "Enable optional modules and customizations" box. Click "Enable" next to "Repeatable instruments." Inside the popup box, select which instruments in the project you want to repeat.In a longitudinal project that has multiple events defined, you will still select "Enable" next to "Repeatable instruments and events." For each event, you will need to choose if you want the entire event to repeat, if you just want specific forms in the event to repeat, or if you don't want anything to repeat. If you select "Repeat entire event (repeat all instruments together)" all the instruments in that event will be checked. If you select "Repeat instruments (repeat independently of each other)," then you'll need to select which instruments you want to repeat in that event.
--------------------
Q240: Are repeating forms compatible with double data entry?
A240: No. You can only compare the first instance of repeating forms with double data entry. From the Data Comparison Tool:The Data Comparison Tool does not *fully* support the Repeating Instruments and Events feature, which appears to be enabled in this project. Data can be compared (and even merged if using Double Data Entry), but it will only allow comparison and merging of Instance #1 of a repeating instrument or repeating event. Thus all other repeating data will be ignored on this page. Also, all non-repeating data can still be compared and merged.
--------------------
Q241: Are repeating forms compatible with the scheduling module?
A241: Repeating forms are not compatible with the scheduling module.
--------------------
Q242: Are repeating forms compatible with the REDCap Mobile App?
A242: Repeating forms are not compatible with the REDCap Mobile App.
--------------------
Q243: Can I use repeating instruments in surveys?
A243: Yes, you can. First, you need to enable the form as repeating in the project in general on the Project Setup page. Then make sure the form is enabled as a survey and go into the Survey Settings. Under "Survey Termination Options" select "(Optional) Allow respondents to repeat the survey:Ask them to take the survey again upon completion, if they wish."This will allow your participants to repeat the survey. You will be able to choose if you want them to see the option to repeat the survey before or after they click submit, and you will be able to customize what the text on the repeat button says.There are limitations to using repeating forms in surveys. You cannot schedule surveys that are in repeated instruments or repeated events to go out on a regular basis. You need to compose the survey invitation for each instance manually using either the compose invitations in the participant list or the option to send a survey invitation in the survey instance itself. Additional, survey queues in repeating events only work on the first instance of the event.
--------------------
Q244: How can I use the data quality module to check all instances of data repeated instruments?
A244: You can check by looking at the instance number next to the record ID when you click "view" after running the rule. However, you cannot filter by individual instances.
--------------------
Q245: What does the data export look like for records using repeating forms?
A245: When you export data that has repeating instances, there will be two new columns in the export: redcap_repeat_instrument (the instrument's name) and redcap_repeat_instance (the instance number). All data that is not in a repeating form will be on one line, and then each instance of a repeating field will receive its own line, similar to how the data exports in a longitudinal study:The formatting will be the same if the project is longitudinal; it will just include the event information as well.
--------------------
Q246: How can I tell the completion status when an instrument repeats?
A246: The completion status of a repeating instrument will have three small circles instead of just one. If the completion status of all the instruments is the same, the circles will be colored red (incomplete), yellow (unverified), or green (complete), just like with regular forms. If the completion status isn't the same for all instances, then the circles will be blue.On the record homepage, you'll be able to see all the instances of a repeating form listed out with the completion status of each instance:
--------------------
Q247: Can I pull information from repeating forms into reports?
A247: You can add information from repeating forms in reports. You will just add the field(s) you need the same way as you would any field in the project. When you view the report, the information from the instances will be on their own line, similar to how information displays for different events in a longitudinal project:
--------------------
Q248: Can I use piping, branching logic, or calculations with repeating forms?
A248: Yes, piping, branching logic, and calculations can be used with repeating forms.If you only use the variable name, REDCap will assume that you are referring to the variable on your current instance.To refer to the variable on a specific instance, you can append the instance number after the variable name. For example: [variable1][5] will reference the data in variable1 on instance five.To refer to the variable on a relative instance, there are several smart variables. They all append after the variable name.[current-instance] refers to the current instance[previous-instance] refers to the instance immediately previous[next-instance] refers to the instance immediately after[first-instance] refers back to the very first instance[last-instance] refers back to the very last instanceFor example, to reference the data in variable2 on the previous instance, you would use [variable2][previous-instance].You can see more information about these smart variables by clicking on the green "Smart Variables" button on the Project Setup page or when building a data entry form in the Online Designer.
--------------------
Q249: How do Automated Survey Invitations work with repeating instruments?
A249: Version 12.4.5 and lower:the ASI will only fire once conditions are met for the first instance, and reminders will only be sent for that instance. You cannot automatically invite or remind a participant to repeat a survey. If you need to invite them again, you will need to send the repeat instance invitation manually or instruct them to click the “repeat” button at the correct time.Version 12.5.0 and higher:ASI’s for surveys set as repeating forms (or surveys in repeating events) can be optionally set to repeating using the settings in ‘Step 4’ of the ASI set up window. Repeating ASI’s can be set to repeat infinitely or can be limited to a set number of repeats. The duration between each repeat invite can be specified as X minutes, X hours, or X days. Before version 13.0.1 this value was required to be an integer but from 13.0.1 onwards the value can be a decimal.
--------------------
Q250: How do I give my repeating forms custom names?
A250: Click on "Modify" next to "Repeatable instruments" in the "Optional modules and customizations" box on the Project Setup page. There will be a text box next to each instrument's name; you can the custom names there. The most effective way to use this is to pipe in a key piece of information (such as the medication name) here. The custom name will then show up next to the completion status for the individual instances on the record home page.If this is a longitudinal project and you are repeating the entire event, you cannot use custom naming for the repeating event.
--------------------