Repository navigation
Expand file tree
/
Copy pathTimezoneSchedulerExample.REDCap.xml
More file actions
298 lines (296 loc) · 44.1 KB
/
Copy pathTimezoneSchedulerExample.REDCap.xml
File metadata and controls
298 lines (296 loc) · 44.1 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
<?xml version="1.0" encoding="UTF-8" ?>
<ODM xmlns="http://www.cdisc.org/ns/odm/v1.3" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:redcap="https://projectredcap.org" xsi:schemaLocation="http://www.cdisc.org/ns/odm/v1.3 schema/odm/ODM1-3-1.xsd" ODMVersion="1.3.1" FileOID="000-00-0000" FileType="Snapshot" Description="Timezone Scheduler EM Example Project" AsOfDateTime="2025-10-23T15:32:49" CreationDateTime="2025-10-23T15:32:49" SourceSystem="REDCap" SourceSystemVersion="15.3.3">
<Study OID="Project.TimezoneSchedulerEMExampleProj">
<GlobalVariables>
<StudyName>Timezone Scheduler EM Example Project</StudyName>
<StudyDescription>This file contains the metadata, events, and data for REDCap project "Timezone Scheduler EM Example Project".</StudyDescription>
<ProtocolName>Timezone Scheduler EM Example Project</ProtocolName>
<redcap:RecordAutonumberingEnabled>1</redcap:RecordAutonumberingEnabled>
<redcap:CustomRecordLabel></redcap:CustomRecordLabel>
<redcap:SecondaryUniqueField></redcap:SecondaryUniqueField>
<redcap:SecondaryUniqueFieldDisplayValue>1</redcap:SecondaryUniqueFieldDisplayValue>
<redcap:SecondaryUniqueFieldDisplayLabel>1</redcap:SecondaryUniqueFieldDisplayLabel>
<redcap:SchedulingEnabled>0</redcap:SchedulingEnabled>
<redcap:SurveysEnabled>1</redcap:SurveysEnabled>
<redcap:SurveyInvitationEmailField></redcap:SurveyInvitationEmailField>
<redcap:RandomizationEnabled>0</redcap:RandomizationEnabled>
<redcap:DisplayTodayNowButton>1</redcap:DisplayTodayNowButton>
<redcap:PreventBranchingEraseValues>0</redcap:PreventBranchingEraseValues>
<redcap:RequireChangeReason>0</redcap:RequireChangeReason>
<redcap:DataHistoryPopup>1</redcap:DataHistoryPopup>
<redcap:OrderRecordsByField></redcap:OrderRecordsByField>
<redcap:taskCompleteStatus>2</redcap:taskCompleteStatus>
<redcap:DataResolutionWorkflowEnabled>1</redcap:DataResolutionWorkflowEnabled>
<redcap:FieldCommentLogOptionEditDelete>1</redcap:FieldCommentLogOptionEditDelete>
<redcap:DataResolutionWorkflowHideClosedQueries>1</redcap:DataResolutionWorkflowHideClosedQueries>
<redcap:MyCapEnabled>0</redcap:MyCapEnabled>
<redcap:Purpose>0</redcap:Purpose>
<redcap:PurposeOther></redcap:PurposeOther>
<redcap:ProjectNotes></redcap:ProjectNotes>
<redcap:SurveyQueueCustomText></redcap:SurveyQueueCustomText>
<redcap:SurveyQueueHide>0</redcap:SurveyQueueHide>
<redcap:SurveyAuthEnabled>0</redcap:SurveyAuthEnabled>
<redcap:SurveyAuthField1></redcap:SurveyAuthField1>
<redcap:SurveyAuthEvent1></redcap:SurveyAuthEvent1>
<redcap:SurveyAuthField2></redcap:SurveyAuthField2>
<redcap:SurveyAuthEvent2></redcap:SurveyAuthEvent2>
<redcap:SurveyAuthField3></redcap:SurveyAuthField3>
<redcap:SurveyAuthEvent3></redcap:SurveyAuthEvent3>
<redcap:SurveyAuthMinFields></redcap:SurveyAuthMinFields>
<redcap:SurveyAuthApplyAllSurveys>1</redcap:SurveyAuthApplyAllSurveys>
<redcap:SurveyAuthCustomMessage></redcap:SurveyAuthCustomMessage>
<redcap:SurveyAuthFailLimit></redcap:SurveyAuthFailLimit>
<redcap:SurveyAuthFailWindow></redcap:SurveyAuthFailWindow>
<redcap:MissingDataCodes></redcap:MissingDataCodes>
<redcap:ProtectedEmailMode>0</redcap:ProtectedEmailMode>
<redcap:ProtectedEmailModeCustomText></redcap:ProtectedEmailModeCustomText>
<redcap:ProtectedEmailModeTrigger>ALL</redcap:ProtectedEmailModeTrigger>
<redcap:ProtectedEmailModeLogo></redcap:ProtectedEmailModeLogo>
<redcap:RepeatingInstrumentsAndEvents>
<redcap:RepeatingInstruments>
<redcap:RepeatingInstrument redcap:UniqueEventName="event_1_arm_1" redcap:RepeatInstrument="example_d_repeating_instances" redcap:CustomLabel=""/>
</redcap:RepeatingInstruments>
</redcap:RepeatingInstrumentsAndEvents>
<redcap:SurveysGroup>
<redcap:Surveys form_name="example_a" title="Example A: Timezone Scheduler Complete" instructions="<p><strong>Please complete the survey below.</strong></p>
<p>Thank you!</p>" offline_instructions="" acknowledgement="<p><strong>Thank you for taking the survey.</strong></p>
<p>Have a nice day!</p>" stop_action_acknowledgement="" stop_action_delete_response="0" question_by_section="1" display_page_number="0" question_auto_numbering="0" survey_enabled="1" save_and_return="0" save_and_return_code_bypass="0" logo="" hide_title="0" view_results="0" min_responses_view_results="10" check_diversity_view_results="0" end_survey_redirect_url="" survey_expiration="" promis_skip_question="0" survey_auth_enabled_single="0" edit_completed_response="0" hide_back_button="0" show_required_field_text="1" confirmation_email_subject="" confirmation_email_content="" confirmation_email_from="" confirmation_email_from_display="" confirmation_email_attach_pdf="0" confirmation_email_attachment="" text_to_speech="0" text_to_speech_language="en" end_survey_redirect_next_survey="0" end_survey_redirect_next_survey_logic="" theme="" text_size="1" font_family="16" theme_text_buttons="" theme_bg_page="" theme_text_title="" theme_bg_title="" theme_text_sectionheader="" theme_bg_sectionheader="" theme_text_question="" theme_bg_question="" enhanced_choices="0" repeat_survey_enabled="0" repeat_survey_btn_text="" repeat_survey_btn_location="BEFORE_SUBMIT" response_limit="" response_limit_include_partials="1" response_limit_custom_text="<p>Thank you for your interest; however, the survey is closed because the maximum number of responses has been reached.</p>" survey_time_limit_days="" survey_time_limit_hours="" survey_time_limit_minutes="" email_participant_field="" end_of_survey_pdf_download="0" pdf_save_to_field="" pdf_save_to_event_id="" pdf_save_translated="0" pdf_auto_archive="0" pdf_econsent_version="" pdf_econsent_type="" pdf_econsent_firstname_field="" pdf_econsent_firstname_event_id="" pdf_econsent_lastname_field="" pdf_econsent_lastname_event_id="" pdf_econsent_dob_field="" pdf_econsent_dob_event_id="" pdf_econsent_allow_edit="0" pdf_econsent_signature_field1="" pdf_econsent_signature_field2="" pdf_econsent_signature_field3="" pdf_econsent_signature_field4="" pdf_econsent_signature_field5="" survey_width_percent="" survey_show_font_resize="1" survey_btn_text_prev_page="" survey_btn_text_next_page="" survey_btn_text_submit="" survey_btn_hide_submit="0" survey_btn_hide_submit_logic=""/>
<redcap:Surveys form_name="example_b_multiple_appts" title="Example B: Multiple Appointments Single Form" instructions="<p><strong>Please complete the survey below.</strong></p>
<p>Thank you!</p>" offline_instructions="" acknowledgement="<p><strong>Thank you for taking the survey.</strong></p>
<p>Have a nice day!</p>" stop_action_acknowledgement="" stop_action_delete_response="0" question_by_section="0" display_page_number="0" question_auto_numbering="0" survey_enabled="1" save_and_return="0" save_and_return_code_bypass="0" logo="" hide_title="0" view_results="0" min_responses_view_results="10" check_diversity_view_results="0" end_survey_redirect_url="" survey_expiration="" promis_skip_question="0" survey_auth_enabled_single="0" edit_completed_response="0" hide_back_button="0" show_required_field_text="1" confirmation_email_subject="" confirmation_email_content="" confirmation_email_from="" confirmation_email_from_display="" confirmation_email_attach_pdf="0" confirmation_email_attachment="" text_to_speech="0" text_to_speech_language="en" end_survey_redirect_next_survey="0" end_survey_redirect_next_survey_logic="" theme="" text_size="1" font_family="16" theme_text_buttons="" theme_bg_page="" theme_text_title="" theme_bg_title="" theme_text_sectionheader="" theme_bg_sectionheader="" theme_text_question="" theme_bg_question="" enhanced_choices="0" repeat_survey_enabled="0" repeat_survey_btn_text="" repeat_survey_btn_location="BEFORE_SUBMIT" response_limit="" response_limit_include_partials="1" response_limit_custom_text="<p>Thank you for your interest; however, the survey is closed because the maximum number of responses has been reached.</p>" survey_time_limit_days="" survey_time_limit_hours="" survey_time_limit_minutes="" email_participant_field="" end_of_survey_pdf_download="0" pdf_save_to_field="" pdf_save_to_event_id="" pdf_save_translated="0" pdf_auto_archive="0" pdf_econsent_version="" pdf_econsent_type="" pdf_econsent_firstname_field="" pdf_econsent_firstname_event_id="" pdf_econsent_lastname_field="" pdf_econsent_lastname_event_id="" pdf_econsent_dob_field="" pdf_econsent_dob_event_id="" pdf_econsent_allow_edit="0" pdf_econsent_signature_field1="" pdf_econsent_signature_field2="" pdf_econsent_signature_field3="" pdf_econsent_signature_field4="" pdf_econsent_signature_field5="" survey_width_percent="" survey_show_font_resize="1" survey_btn_text_prev_page="" survey_btn_text_next_page="" survey_btn_text_submit="" survey_btn_hide_submit="0" survey_btn_hide_submit_logic=""/>
<redcap:Surveys form_name="example_c_multievent_scheduling" title="Example C: Multi-Event Scheduling" instructions="<p><strong>Please complete the survey below.</strong></p>
<p>Thank you!</p>" offline_instructions="" acknowledgement="<p><strong>Thank you for taking the survey.</strong></p>
<p>Have a nice day!</p>" stop_action_acknowledgement="" stop_action_delete_response="0" question_by_section="1" display_page_number="0" question_auto_numbering="0" survey_enabled="1" save_and_return="0" save_and_return_code_bypass="0" logo="" hide_title="0" view_results="0" min_responses_view_results="10" check_diversity_view_results="0" end_survey_redirect_url="" survey_expiration="" promis_skip_question="0" survey_auth_enabled_single="0" edit_completed_response="0" hide_back_button="0" show_required_field_text="1" confirmation_email_subject="" confirmation_email_content="" confirmation_email_from="" confirmation_email_from_display="" confirmation_email_attach_pdf="0" confirmation_email_attachment="" text_to_speech="0" text_to_speech_language="en" end_survey_redirect_next_survey="0" end_survey_redirect_next_survey_logic="" theme="" text_size="1" font_family="16" theme_text_buttons="" theme_bg_page="" theme_text_title="" theme_bg_title="" theme_text_sectionheader="" theme_bg_sectionheader="" theme_text_question="" theme_bg_question="" enhanced_choices="0" repeat_survey_enabled="0" repeat_survey_btn_text="" repeat_survey_btn_location="BEFORE_SUBMIT" response_limit="" response_limit_include_partials="1" response_limit_custom_text="<p>Thank you for your interest; however, the survey is closed because the maximum number of responses has been reached.</p>" survey_time_limit_days="" survey_time_limit_hours="" survey_time_limit_minutes="" email_participant_field="" end_of_survey_pdf_download="0" pdf_save_to_field="" pdf_save_to_event_id="" pdf_save_translated="0" pdf_auto_archive="0" pdf_econsent_version="" pdf_econsent_type="" pdf_econsent_firstname_field="" pdf_econsent_firstname_event_id="" pdf_econsent_lastname_field="" pdf_econsent_lastname_event_id="" pdf_econsent_dob_field="" pdf_econsent_dob_event_id="" pdf_econsent_allow_edit="0" pdf_econsent_signature_field1="" pdf_econsent_signature_field2="" pdf_econsent_signature_field3="" pdf_econsent_signature_field4="" pdf_econsent_signature_field5="" survey_width_percent="" survey_show_font_resize="1" survey_btn_text_prev_page="" survey_btn_text_next_page="" survey_btn_text_submit="" survey_btn_hide_submit="0" survey_btn_hide_submit_logic=""/>
<redcap:Surveys form_name="example_d_repeating_instances" title="Example D: Repeating Instances" instructions="<p><strong>Please complete the survey below.</strong></p>
<p>Thank you!</p>" offline_instructions="" acknowledgement="<p><strong>Thank you for taking the survey.</strong></p>
<p>Have a nice day!</p>" stop_action_acknowledgement="" stop_action_delete_response="0" question_by_section="1" display_page_number="0" question_auto_numbering="0" survey_enabled="1" save_and_return="0" save_and_return_code_bypass="0" logo="" hide_title="0" view_results="0" min_responses_view_results="10" check_diversity_view_results="0" end_survey_redirect_url="" survey_expiration="" promis_skip_question="0" survey_auth_enabled_single="0" edit_completed_response="0" hide_back_button="0" show_required_field_text="1" confirmation_email_subject="" confirmation_email_content="" confirmation_email_from="" confirmation_email_from_display="" confirmation_email_attach_pdf="0" confirmation_email_attachment="" text_to_speech="0" text_to_speech_language="en" end_survey_redirect_next_survey="0" end_survey_redirect_next_survey_logic="" theme="" text_size="1" font_family="16" theme_text_buttons="" theme_bg_page="" theme_text_title="" theme_bg_title="" theme_text_sectionheader="" theme_bg_sectionheader="" theme_text_question="" theme_bg_question="" enhanced_choices="0" repeat_survey_enabled="1" repeat_survey_btn_text="Take this survey again" repeat_survey_btn_location="BEFORE_SUBMIT" response_limit="" response_limit_include_partials="1" response_limit_custom_text="<p>Thank you for your interest; however, the survey is closed because the maximum number of responses has been reached.</p>" survey_time_limit_days="" survey_time_limit_hours="" survey_time_limit_minutes="" email_participant_field="" end_of_survey_pdf_download="0" pdf_save_to_field="" pdf_save_to_event_id="" pdf_save_translated="0" pdf_auto_archive="0" pdf_econsent_version="" pdf_econsent_type="" pdf_econsent_firstname_field="" pdf_econsent_firstname_event_id="" pdf_econsent_lastname_field="" pdf_econsent_lastname_event_id="" pdf_econsent_dob_field="" pdf_econsent_dob_event_id="" pdf_econsent_allow_edit="0" pdf_econsent_signature_field1="" pdf_econsent_signature_field2="" pdf_econsent_signature_field3="" pdf_econsent_signature_field4="" pdf_econsent_signature_field5="" survey_width_percent="" survey_show_font_resize="1" survey_btn_text_prev_page="" survey_btn_text_next_page="" survey_btn_text_submit="" survey_btn_hide_submit="0" survey_btn_hide_submit_logic=""/>
</redcap:SurveysGroup>
<redcap:SurveysQueueGroup>
<redcap:SurveysQueue active="1" auto_start="0" condition_surveycomplete_survey_id="example_a" condition_surveycomplete_event_id="event_1_arm_1" condition_andor="AND" condition_logic="" event_id="event_1_arm_1" survey_id="example_a"/>
<redcap:SurveysQueue active="1" auto_start="0" condition_surveycomplete_survey_id="example_a" condition_surveycomplete_event_id="event_1_arm_1" condition_andor="AND" condition_logic="" event_id="event_1_arm_1" survey_id="example_b_multiple_appts"/>
<redcap:SurveysQueue active="1" auto_start="0" condition_surveycomplete_survey_id="example_a" condition_surveycomplete_event_id="event_1_arm_1" condition_andor="AND" condition_logic="" event_id="event_1_arm_1" survey_id="example_c_multievent_scheduling"/>
<redcap:SurveysQueue active="1" auto_start="0" condition_surveycomplete_survey_id="example_a" condition_surveycomplete_event_id="event_1_arm_1" condition_andor="AND" condition_logic="" event_id="event_2_arm_1" survey_id="example_c_multievent_scheduling"/>
<redcap:SurveysQueue active="1" auto_start="0" condition_surveycomplete_survey_id="example_a" condition_surveycomplete_event_id="event_1_arm_1" condition_andor="AND" condition_logic="" event_id="event_1_arm_1" survey_id="example_d_repeating_instances"/>
</redcap:SurveysQueueGroup>
</GlobalVariables>
<MetaDataVersion OID="Metadata.TimezoneSchedulerEMExampleProj_2025-10-23_1532" Name="Timezone Scheduler EM Example Project" redcap:RecordIdField="record_id">
<Protocol>
<StudyEventRef StudyEventOID="Event.event_1_arm_1" OrderNumber="1" Mandatory="No"/>
<StudyEventRef StudyEventOID="Event.event_2_arm_1" OrderNumber="2" Mandatory="No"/>
</Protocol>
<StudyEventDef OID="Event.event_1_arm_1" Name="Event 1" Type="Common" Repeating="No" redcap:EventName="Event 1" redcap:CustomEventLabel="" redcap:UniqueEventName="event_1_arm_1" redcap:ArmNum="1" redcap:ArmName="Arm 1" redcap:DayOffset="1" redcap:OffsetMin="0" redcap:OffsetMax="0">
<FormRef FormOID="Form.example_a" OrderNumber="1" Mandatory="No" redcap:FormName="example_a"/>
<FormRef FormOID="Form.example_b_multiple_appts" OrderNumber="2" Mandatory="No" redcap:FormName="example_b_multiple_appts"/>
<FormRef FormOID="Form.example_c_multievent_scheduling" OrderNumber="3" Mandatory="No" redcap:FormName="example_c_multievent_scheduling"/>
<FormRef FormOID="Form.example_d_repeating_instances" OrderNumber="4" Mandatory="No" redcap:FormName="example_d_repeating_instances"/>
</StudyEventDef>
<StudyEventDef OID="Event.event_2_arm_1" Name="Event 2" Type="Common" Repeating="No" redcap:EventName="Event 2" redcap:CustomEventLabel="" redcap:UniqueEventName="event_2_arm_1" redcap:ArmNum="1" redcap:ArmName="Arm 1" redcap:DayOffset="2" redcap:OffsetMin="0" redcap:OffsetMax="0">
<FormRef FormOID="Form.example_c_multievent_scheduling" OrderNumber="1" Mandatory="No" redcap:FormName="example_c_multievent_scheduling"/>
</StudyEventDef>
<FormDef OID="Form.example_a" Name="Example A: Timezone Scheduler Complete" Repeating="No" redcap:FormName="example_a">
<ItemGroupRef ItemGroupOID="example_a.record_id" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_a.appt_slot_1" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_a.appt_server_dt_1" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_a.example_a_complete" Mandatory="No"/>
</FormDef>
<FormDef OID="Form.example_b_multiple_appts" Name="Example B: Multiple Appointments Single Form" Repeating="No" redcap:FormName="example_b_multiple_appts">
<ItemGroupRef ItemGroupOID="example_b_multiple_appts.ex_b_appt_1" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_b_multiple_appts.ex_b_appt_dt_1" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_b_multiple_appts.ex_b_appt_2" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_b_multiple_appts.ex_b_appt_dt_2" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_b_multiple_appts.example_b_multiple_appts_complete" Mandatory="No"/>
</FormDef>
<FormDef OID="Form.example_c_multievent_scheduling" Name="Example C: Multi-Event Scheduling" Repeating="No" redcap:FormName="example_c_multievent_scheduling">
<ItemGroupRef ItemGroupOID="example_c_multievent_scheduling.ex_c_appt" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_c_multievent_scheduling.ex_c_appt_dt" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_c_multievent_scheduling.example_c_multievent_scheduling_complete" Mandatory="No"/>
</FormDef>
<FormDef OID="Form.example_d_repeating_instances" Name="Example D: Repeating Instances" Repeating="No" redcap:FormName="example_d_repeating_instances">
<ItemGroupRef ItemGroupOID="example_d_repeating_instances.ex_d_appt" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_d_repeating_instances.ex_d_appt_dt" Mandatory="No"/>
<ItemGroupRef ItemGroupOID="example_d_repeating_instances.example_d_repeating_instances_complete" Mandatory="No"/>
</FormDef>
<ItemGroupDef OID="example_a.record_id" Name="Example A: Timezone Scheduler Complete" Repeating="No">
<ItemRef ItemOID="record_id" Mandatory="No" redcap:Variable="record_id"/>
<ItemRef ItemOID="desc_record_must_exist" Mandatory="No" redcap:Variable="desc_record_must_exist"/>
</ItemGroupDef>
<ItemGroupDef OID="example_a.appt_slot_1" Name="An Example Appointment Showing Most Features
- The first field is the only required field for a configuration." Repeating="No">
<ItemRef ItemOID="appt_slot_1" Mandatory="No" redcap:Variable="appt_slot_1"/>
</ItemGroupDef>
<ItemGroupDef OID="example_a.appt_server_dt_1" Name="Example A: Timezone Scheduler Complete" Repeating="No">
<ItemRef ItemOID="appt_server_dt_1" Mandatory="No" redcap:Variable="appt_server_dt_1"/>
<ItemRef ItemOID="appt_description_1" Mandatory="No" redcap:Variable="appt_description_1"/>
<ItemRef ItemOID="appt_slot_filter_1" Mandatory="No" redcap:Variable="appt_slot_filter_1"/>
<ItemRef ItemOID="appt_part_text_date_1" Mandatory="No" redcap:Variable="appt_part_text_date_1"/>
<ItemRef ItemOID="appt_cancel_url_1" Mandatory="No" redcap:Variable="appt_cancel_url_1"/>
<ItemRef ItemOID="appt_slot_url_1" Mandatory="No" redcap:Variable="appt_slot_url_1"/>
</ItemGroupDef>
<ItemGroupDef OID="example_a.example_a_complete" Name="Form Status" Repeating="No">
<ItemRef ItemOID="example_a_complete" Mandatory="No" redcap:Variable="example_a_complete"/>
</ItemGroupDef>
<ItemGroupDef OID="example_b_multiple_appts.ex_b_appt_1" Name="Example B - Showing you can schedule multiple events on the same form" Repeating="No">
<ItemRef ItemOID="ex_b_appt_1" Mandatory="No" redcap:Variable="ex_b_appt_1"/>
</ItemGroupDef>
<ItemGroupDef OID="example_b_multiple_appts.ex_b_appt_dt_1" Name="Example B: Multiple Appointments Single Form" Repeating="No">
<ItemRef ItemOID="ex_b_appt_dt_1" Mandatory="No" redcap:Variable="ex_b_appt_dt_1"/>
<ItemRef ItemOID="ex_b_appt_description_1" Mandatory="No" redcap:Variable="ex_b_appt_description_1"/>
<ItemRef ItemOID="ex_b_appt_cancel_url_1" Mandatory="No" redcap:Variable="ex_b_appt_cancel_url_1"/>
</ItemGroupDef>
<ItemGroupDef OID="example_b_multiple_appts.ex_b_appt_2" Name="Example B Second Visit on Same Form" Repeating="No">
<ItemRef ItemOID="ex_b_appt_2" Mandatory="No" redcap:Variable="ex_b_appt_2"/>
</ItemGroupDef>
<ItemGroupDef OID="example_b_multiple_appts.ex_b_appt_dt_2" Name="Example B: Multiple Appointments Single Form" Repeating="No">
<ItemRef ItemOID="ex_b_appt_dt_2" Mandatory="No" redcap:Variable="ex_b_appt_dt_2"/>
<ItemRef ItemOID="ex_b_appt_description_2" Mandatory="No" redcap:Variable="ex_b_appt_description_2"/>
<ItemRef ItemOID="ex_b_appt_cancel_url_2" Mandatory="No" redcap:Variable="ex_b_appt_cancel_url_2"/>
</ItemGroupDef>
<ItemGroupDef OID="example_b_multiple_appts.example_b_multiple_appts_complete" Name="Form Status" Repeating="No">
<ItemRef ItemOID="example_b_multiple_appts_complete" Mandatory="No" redcap:Variable="example_b_multiple_appts_complete"/>
</ItemGroupDef>
<ItemGroupDef OID="example_c_multievent_scheduling.ex_c_appt" Name="Example C - You can enable a form with a timezone event in multiple REDCap events, but you must configure the form for each event in the External Module Configuration." Repeating="No">
<ItemRef ItemOID="ex_c_appt" Mandatory="No" redcap:Variable="ex_c_appt"/>
</ItemGroupDef>
<ItemGroupDef OID="example_c_multievent_scheduling.ex_c_appt_dt" Name="Example C: Multi-Event Scheduling" Repeating="No">
<ItemRef ItemOID="ex_c_appt_dt" Mandatory="No" redcap:Variable="ex_c_appt_dt"/>
<ItemRef ItemOID="ex_c_appt_description" Mandatory="No" redcap:Variable="ex_c_appt_description"/>
</ItemGroupDef>
<ItemGroupDef OID="example_c_multievent_scheduling.example_c_multievent_scheduling_complete" Name="Form Status" Repeating="No">
<ItemRef ItemOID="example_c_multievent_scheduling_complete" Mandatory="No" redcap:Variable="example_c_multievent_scheduling_complete"/>
</ItemGroupDef>
<ItemGroupDef OID="example_d_repeating_instances.ex_d_appt" Name="Example D - You can use this module on repeating forms. You only need one configuration for the field. If a new instance hasn't yet been created when the form is rendered, it will create the instance when the appointment is selected." Repeating="No">
<ItemRef ItemOID="ex_d_appt" Mandatory="No" redcap:Variable="ex_d_appt"/>
</ItemGroupDef>
<ItemGroupDef OID="example_d_repeating_instances.ex_d_appt_dt" Name="Example D: Repeating Instances" Repeating="No">
<ItemRef ItemOID="ex_d_appt_dt" Mandatory="No" redcap:Variable="ex_d_appt_dt"/>
<ItemRef ItemOID="ex_d_appt_description" Mandatory="No" redcap:Variable="ex_d_appt_description"/>
</ItemGroupDef>
<ItemGroupDef OID="example_d_repeating_instances.example_d_repeating_instances_complete" Name="Form Status" Repeating="No">
<ItemRef ItemOID="example_d_repeating_instances_complete" Mandatory="No" redcap:Variable="example_d_repeating_instances_complete"/>
</ItemGroupDef>
<ItemDef OID="record_id" Name="record_id" DataType="text" Length="999" redcap:Variable="record_id" redcap:FieldType="text">
<Question><TranslatedText>Record ID</TranslatedText></Question>
</ItemDef>
<ItemDef OID="desc_record_must_exist" Name="desc_record_must_exist" DataType="text" Length="999" redcap:Variable="desc_record_must_exist" redcap:FieldType="descriptive">
<Question><TranslatedText>Record Must Exist
This message is to remind you that when using this module, you must have an existing record before you can select an appointment from the slot database. So, if this form were the first form in a project and exposed via a public survey url, you would need to enable 'one section/page' in survey settings so that a record is created before the appointment selector is rendered.</TranslatedText><redcap:FormattedTranslatedText>Record Must Exist
<div style='font-weight:normal'>This message is to remind you that when using this module, you must have an existing record before you can select an appointment from the slot database. So, if this form were the first form in a project and exposed via a public survey url, you would need to enable 'one section/page' in survey settings so that a record is created before the appointment selector is rendered.</div></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_slot_1" Name="appt_slot_1" DataType="text" Length="999" redcap:Variable="appt_slot_1" redcap:FieldType="text" redcap:SectionHeader="An Example Appointment Showing Most Features
- The first field is the only required field for a configuration.">
<Question><TranslatedText>Appointment Slot Field
REQUIRED This is the field that stores the slot value. This label will be visible to the end-user, so it might say:
Schedule your study onboarding visit!
If you use branching logic to show this field, I recommend you check the Prevent branching logic from hiding fields that have values under additional customizations.This is the only required field for using this module</TranslatedText><redcap:FormattedTranslatedText>Appointment Slot Field
<div style="font-weight:normal;"><b>REQUIRED</b> This is the field that stores the slot value. This label will be visible to the end-user, so it might say:
<b>Schedule your study onboarding visit!</b>
<ul><li>If you use branching logic to show this field, I recommend you check the <i>Prevent branching logic from hiding fields that have values</i> under additional customizations.</li><li>This is the only <u>required</u> field for using this module</li></ul></div></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_server_dt_1" Name="appt_server_dt_1" DataType="partialDatetime" Length="999" redcap:Variable="appt_server_dt_1" redcap:FieldType="text" redcap:TextValidationType="datetime_ymd" redcap:FieldNote="Mapping the slot's datetime to this project allows you to send appointment reminders based on the time of the select appointment." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Appt Server Timestamp(Optional) If specified, the server timestamp for this appointment will be stored. This can be used to automate reminders to the participant using datediff logic and notifications. validate as Y-M-D H:M, any other format may cause errors.field must present in the Appointment Field Eventrecommended to use @HIDDEN-SURVEY or place this field on a different instrument so the participant does not see it in the survey</TranslatedText><redcap:FormattedTranslatedText>Appt Server Timestamp<div style='font-weight:normal;'><i>(Optional)</i> If specified, the <b>server timestamp</b> for this appointment will be stored. This can be used to automate reminders to the participant using datediff logic and notifications. <ul><li>validate as <b>Y-M-D H:M</b>, any other format may cause errors.</li><li>field must present in the Appointment Field Event</li><li>recommended to use <code>@HIDDEN-SURVEY</code> or place this field on a different instrument so the participant does not see it in the survey</li></ul></div></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_description_1" Name="appt_description_1" DataType="text" Length="999" redcap:Variable="appt_description_1" redcap:FieldType="textarea" redcap:FieldNote="(optional) You can store the fancy-formatted appointment description, perhaps to be piped into a reminder email." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Appt Description(Optional) The above appointment description can be saved into a field, useful for piping into reminders with participants timezone.field must be of type noterecommended to use @HIDDEN-SURVEY or place this field on a different instrument so the participant does not see it in the survey</TranslatedText><redcap:FormattedTranslatedText>Appt Description<div style='font-weight:normal;'><i>(Optional)</i> The above appointment description can be saved into a field, useful for piping into reminders with participants timezone.<ul><li>field must be of type <u>note</u></li><li>recommended to use <code>@HIDDEN-SURVEY</code> or place this field on a different instrument so the participant does not see it in the survey</li></ul></div></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_slot_filter_1" Name="appt_slot_filter_1" DataType="text" Length="999" redcap:Variable="appt_slot_filter_1" redcap:FieldType="text" redcap:FieldAnnotation="@_disabled_CALCTEXT(if(mod([record_id]/2,0),"EVEN",""))
@HIDDEN-SURVEY">
<Question><TranslatedText>Appt Slot Filter(Optional) If set, only those slots that have a matching slot filter value will be displayed.You can use a @CALCTEXT field to create complex slot filter values based on other field values, but the values used in the logic must exist before this form is rendered -- for this reason a @CALCTEXT field on the same page as the appointment selector field may not operate as intended, i.e. use the multipages pagination in survey settings to save the value before scheduling the appointmentExample: @CALCTEXT(if(mod([~record_id_field~]/2,0),"EVEN","ODD")) would filter for slot dbs that are 'ODD' or 'EVEN' in their slot_filter valueOr, if you had a random_group field, you could use this for the slot-filter and only those randomized to certain groups would be able to book certain appointment slotsThis can seem complex, so review documentation if you have questions</TranslatedText><redcap:FormattedTranslatedText>Appt Slot Filter<div style='font-weight:normal;'><i>(Optional)</i> If set, only those slots that have a matching <code>slot filter value</code> will be displayed.<ul><li>You can use a <code>@CALCTEXT</code> field to create complex slot filter values based on other field values, but the values used in the logic must exist before this form is rendered -- for this reason a @CALCTEXT field on the same page as the appointment selector field may not operate as intended, <i>i.e.</i> use the multipages pagination in survey settings to save the value before scheduling the appointment</li><li>Example: <code>@CALCTEXT(if(mod([~record_id_field~]/2,0),"EVEN","ODD"))</code> would filter for slot dbs that are 'ODD' or 'EVEN' in their <code>slot_filter</code> value</li><li>Or, if you had a <code>random_group</code> field, you could use this for the slot-filter and only those randomized to certain groups would be able to book certain appointment slots</li><li>This can seem complex, so review documentation if you have questions</li></ul></div></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_part_text_date_1" Name="appt_part_text_date_1" DataType="text" Length="999" redcap:Variable="appt_part_text_date_1" redcap:FieldType="text" redcap:FieldNote="This TEXT field holds the nicely formatted client date/time and can be used to pipe into a reminder body." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Appt Participant Text Date Field(Optional) If specified, a simplified version of the selected date will be stored, e.g. Wed, Nov 5th, 2025 at 9:00 AM CST.Must be a text field (do not validate it as a date/time as this will fail)recommended to use @HIDDEN-SURVEY or place this field on a different instrument so the participant does not see it in the survey
</TranslatedText><redcap:FormattedTranslatedText>Appt Participant Text Date Field<div style='font-weight:normal;'><i>(Optional)</i> If specified, a simplified version of the selected date will be stored, <i>e.g. Wed, Nov 5th, 2025 at 9:00 AM CST</i>.<ul><li>Must be a <u>text field</u> (do not validate it as a date/time as this will fail)</li><li>recommended to use <code>@HIDDEN-SURVEY</code> or place this field on a different instrument so the participant does not see it in the survey</li></ul></div>
</redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_cancel_url_1" Name="appt_cancel_url_1" DataType="text" Length="999" redcap:Variable="appt_cancel_url_1" redcap:FieldType="text" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Appointment Cancel Url(Optional) This field holds a url that will allow the user to cancel this appointment. Useful for putting into an email confirmation about the appointmentThis should be a text fieldrecommended to use @HIDDEN-SURVEY or place this field on a different instrument so the participant does not see it in the survey
Cancel Appt</TranslatedText><redcap:FormattedTranslatedText>Appointment Cancel Url<div style="font-weight:normal;"><i>(Optional)</i> This field holds a url that will allow the user to cancel this appointment. Useful for putting into an email confirmation about the appointment<ul><li>This should be a text field</li><li>recommended to use <code>@HIDDEN-SURVEY</code> or place this field on a different instrument so the participant does not see it in the survey</li></ul></div>
<a href="[appt_cancel_url_1]" target="_blank">Cancel Appt</a></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="appt_slot_url_1" Name="appt_slot_url_1" DataType="text" Length="999" redcap:Variable="appt_slot_url_1" redcap:FieldType="text" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Appointment Slot Record URL
(Optional) If set, the url for the selected slot database entry will be stored. You can then pipe this into a button so, as an admin, you can jump from the current appointment record to the corresponding slot database record.This field should be @HIDDEN-SURVEY as it is really only used for piping purposes.
GOTO Slot [appt_slot_1]</TranslatedText><redcap:FormattedTranslatedText>Appointment Slot Record URL
<div style='font-weight:normal;'><i>(Optional)</i> If set, the url for the selected slot database entry will be stored. You can then pipe this into a button so, as an admin, you can jump from the current appointment record to the corresponding slot database record.<ul><li>This field should be <code>@HIDDEN-SURVEY</code> as it is really only used for piping purposes.</div>
<a href='[appt_slot_url_1]' target='_BLANK'>GOTO Slot [appt_slot_1]</a></redcap:FormattedTranslatedText></Question>
</ItemDef>
<ItemDef OID="example_a_complete" Name="example_a_complete" DataType="text" Length="1" redcap:Variable="example_a_complete" redcap:FieldType="select" redcap:SectionHeader="Form Status">
<Question><TranslatedText>Complete?</TranslatedText></Question>
<CodeListRef CodeListOID="example_a_complete.choices"/>
</ItemDef>
<ItemDef OID="ex_b_appt_1" Name="ex_b_appt_1" DataType="text" Length="999" redcap:Variable="ex_b_appt_1" redcap:FieldType="text" redcap:SectionHeader="Example B - Showing you can schedule multiple events on the same form">
<Question><TranslatedText>Schedule your First Visit:</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_dt_1" Name="ex_b_appt_dt_1" DataType="partialDatetime" Length="999" redcap:Variable="ex_b_appt_dt_1" redcap:FieldType="text" redcap:TextValidationType="datetime_ymd" redcap:FieldNote="Mapping the slot's datetime to this project allows you to send appointment reminders based on the time of the select appointment." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 1 Timestamp (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_description_1" Name="ex_b_appt_description_1" DataType="text" Length="999" redcap:Variable="ex_b_appt_description_1" redcap:FieldType="textarea" redcap:FieldNote="(optional) You can store the fancy-formatted appointment description, perhaps to be piped into a reminder email." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 1 Appt Description (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_cancel_url_1" Name="ex_b_appt_cancel_url_1" DataType="text" Length="999" redcap:Variable="ex_b_appt_cancel_url_1" redcap:FieldType="text" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 1 Appointment Cancel Url (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_2" Name="ex_b_appt_2" DataType="text" Length="999" redcap:Variable="ex_b_appt_2" redcap:FieldType="text" redcap:SectionHeader="Example B Second Visit on Same Form" redcap:BranchingLogic="[ex_b_appt_1] <> ''">
<Question><TranslatedText>Schedule your Second Visit:</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_dt_2" Name="ex_b_appt_dt_2" DataType="partialDatetime" Length="999" redcap:Variable="ex_b_appt_dt_2" redcap:FieldType="text" redcap:TextValidationType="datetime_ymd" redcap:FieldNote="Mapping the slot's datetime to this project allows you to send appointment reminders based on the time of the select appointment." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 2 Timestamp (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_description_2" Name="ex_b_appt_description_2" DataType="text" Length="999" redcap:Variable="ex_b_appt_description_2" redcap:FieldType="textarea" redcap:FieldNote="(optional) You can store the fancy-formatted appointment description, perhaps to be piped into a reminder email." redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 2 Appt Description (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_b_appt_cancel_url_2" Name="ex_b_appt_cancel_url_2" DataType="text" Length="999" redcap:Variable="ex_b_appt_cancel_url_2" redcap:FieldType="text" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Visit 2 Appointment Cancel Url (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="example_b_multiple_appts_complete" Name="example_b_multiple_appts_complete" DataType="text" Length="1" redcap:Variable="example_b_multiple_appts_complete" redcap:FieldType="select" redcap:SectionHeader="Form Status">
<Question><TranslatedText>Complete?</TranslatedText></Question>
<CodeListRef CodeListOID="example_b_multiple_appts_complete.choices"/>
</ItemDef>
<ItemDef OID="ex_c_appt" Name="ex_c_appt" DataType="text" Length="999" redcap:Variable="ex_c_appt" redcap:FieldType="text" redcap:SectionHeader="Example C - You can enable a form with a timezone event in multiple REDCap events, but you must configure the form for each event in the External Module Configuration.">
<Question><TranslatedText>Schedule For Your Event [event-name] Visit:</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_c_appt_dt" Name="ex_c_appt_dt" DataType="partialDatetime" Length="999" redcap:Variable="ex_c_appt_dt" redcap:FieldType="text" redcap:TextValidationType="datetime_ymd" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Event Timestamp (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_c_appt_description" Name="ex_c_appt_description" DataType="text" Length="999" redcap:Variable="ex_c_appt_description" redcap:FieldType="textarea" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Event Appt Description (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="example_c_multievent_scheduling_complete" Name="example_c_multievent_scheduling_complete" DataType="text" Length="1" redcap:Variable="example_c_multievent_scheduling_complete" redcap:FieldType="select" redcap:SectionHeader="Form Status">
<Question><TranslatedText>Complete?</TranslatedText></Question>
<CodeListRef CodeListOID="example_c_multievent_scheduling_complete.choices"/>
</ItemDef>
<ItemDef OID="ex_d_appt" Name="ex_d_appt" DataType="text" Length="999" redcap:Variable="ex_d_appt" redcap:FieldType="text" redcap:SectionHeader="Example D - You can use this module on repeating forms. You only need one configuration for the field. If a new instance hasn't yet been created when the form is rendered, it will create the instance when the appointment is selected.">
<Question><TranslatedText>Schedule For Instance [current-instance]:</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_d_appt_dt" Name="ex_d_appt_dt" DataType="partialDatetime" Length="999" redcap:Variable="ex_d_appt_dt" redcap:FieldType="text" redcap:TextValidationType="datetime_ymd" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Event Timestamp (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="ex_d_appt_description" Name="ex_d_appt_description" DataType="text" Length="999" redcap:Variable="ex_d_appt_description" redcap:FieldType="textarea" redcap:FieldAnnotation="@HIDDEN-SURVEY">
<Question><TranslatedText>Event Appt Description (hidden)</TranslatedText></Question>
</ItemDef>
<ItemDef OID="example_d_repeating_instances_complete" Name="example_d_repeating_instances_complete" DataType="text" Length="1" redcap:Variable="example_d_repeating_instances_complete" redcap:FieldType="select" redcap:SectionHeader="Form Status">
<Question><TranslatedText>Complete?</TranslatedText></Question>
<CodeListRef CodeListOID="example_d_repeating_instances_complete.choices"/>
</ItemDef>
<CodeList OID="example_a_complete.choices" Name="example_a_complete" DataType="text" redcap:Variable="example_a_complete">
<CodeListItem CodedValue="0"><Decode><TranslatedText>Incomplete</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="1"><Decode><TranslatedText>Unverified</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="2"><Decode><TranslatedText>Complete</TranslatedText></Decode></CodeListItem>
</CodeList>
<CodeList OID="example_b_multiple_appts_complete.choices" Name="example_b_multiple_appts_complete" DataType="text" redcap:Variable="example_b_multiple_appts_complete">
<CodeListItem CodedValue="0"><Decode><TranslatedText>Incomplete</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="1"><Decode><TranslatedText>Unverified</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="2"><Decode><TranslatedText>Complete</TranslatedText></Decode></CodeListItem>
</CodeList>
<CodeList OID="example_c_multievent_scheduling_complete.choices" Name="example_c_multievent_scheduling_complete" DataType="text" redcap:Variable="example_c_multievent_scheduling_complete">
<CodeListItem CodedValue="0"><Decode><TranslatedText>Incomplete</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="1"><Decode><TranslatedText>Unverified</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="2"><Decode><TranslatedText>Complete</TranslatedText></Decode></CodeListItem>
</CodeList>
<CodeList OID="example_d_repeating_instances_complete.choices" Name="example_d_repeating_instances_complete" DataType="text" redcap:Variable="example_d_repeating_instances_complete">
<CodeListItem CodedValue="0"><Decode><TranslatedText>Incomplete</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="1"><Decode><TranslatedText>Unverified</TranslatedText></Decode></CodeListItem>
<CodeListItem CodedValue="2"><Decode><TranslatedText>Complete</TranslatedText></Decode></CodeListItem>
</CodeList>
</MetaDataVersion>
</Study>
</ODM>