Understanding Schedule and Notification Parameters

This page includes extended descriptions for schedule and notification parameters. To see information about how to configure schedules and notifications, see Configuring Schedules and Notifications.

Configuration Parameters for Schedules

A survey can be made available by one or many schedules. The Schedule Configuration field contains an array of these schedules.

Configuring “For” Schedules

For schedules make surveys available to respondents for a specified duration of time.

A delay can be configured to offset the beginning of the schedule to a specified amount of time before or after the start event.
Recurrence rules can be configured to make the survey available to respondents at a specified frequency.

Parameter	Data Type	Description	JSON Code Example	Requiredness
Name	String	The unique name of the schedule.	`"name": "avail_6_hours"`	Required
Description	String	The description of the schedule, if applicable. The description is only displayed in the schedule’s JSON and is not shown to respondents.	`"description": "Available for 6 hours"`	Optional
Timepoint Label	String	The timepoint label is used to differentiate between survey submissions for surveys that are included in multiple schedules. You can add any string that indicates which timepoint the survey was completed for. If you include this parameter on one schedule, you must include it on all schedules. The string is limited to 50 characters or fewer. Note: When you generate screenshots for a collection, this survey is generated only once with ‘timepoint label’ in the label.	`timepointLabel: "1-hour post-dose"`	Required if `{timepointLabel}` is included in the Display Label or As-Needed Display Label
Location	String, with set options: `clinic` `home`	Location where a participant or caregiver survey should be completed. This value is displayed to site users. Only available when surveyType is ePRO. When the surveyType is eClinRO, the value is defaulted to "clinic" and does not need to be populated.	`"location": "home"`	Optional
Groups	String, with set options based on configured group names.	If the collection has groups, a schedule can be assigned to a subset of groups so that during the study the schedule is only applied to participants in those groups. By default, a schedule applies to participants in all groups. If a schedule is assigned to multiple groups, then a participant must be in all groups to trigger this schedule. For example: An event is related to the "Age Range" group "5 to 10 years of age" and the "Cohort" group "Cohort A". For a participant to receive this schedule, they must be in the "5 to 10 years of age" and "Cohort A" groups. The value entered here is the unique name of the group. View Group Names in the Tools menu to view groups and copy their names. You can position your pointer over the information icon next to the group name to see the group label and verify that you selected the correct group. The system will validate that the groups selected are also available groups on the Events selected as Start Events or End Events. The system will validate that the groups selected are also related groups on the Events selected as Start Events or End Events. If no groups are selected on a schedule and the collection has groups, then the system assigns all groups to the schedule.	`"groups": [` `"youth"` `],`	Optional
In the "start" parameter:
Start Events	String, with set options based on configured event names. If a Start Rule string is added, must use `null.`	One or more events that, when entered by a site user, trigger the start of the schedule. The value entered here is the event name. View Event Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startEvents": ["visit_1"]`	Start Events or Start Rules is required
Start Rules	String, with set options based on configured rule names. If a Start Event string is added, must use `null.`	One or more rules that, when executed, trigger the start of the schedule. These rules can be based on survey data or on the successful completion of a criteria check. View Rule Names in the Tools menu to view rules and copy their names. To view the selected rule label, position your pointer over the information icon next to the row.	`"startRules": ["hdrs_required"]`	Start Events or Start Rules is required
In the "delay" parameter:
Value	Whole number	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. If you do not include a delay, the schedule will start immediately at the date and time of any of its Start Events during the study. Positive and negative numbers are accepted.	`"value": 10,`	Optional
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `years`	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. When calculating a date from a schedule, delays with a unit of days, weeks, months, or years automatically "round down" to the beginning of the calculated day. For example, if a delay of 2 days is added to a start date of January 2 at 2:00pm, the delayed survey will become available on January 4 at 12:00am.	`"unit": "hours"`	Optional
In the "available" parameter:
Type	String, with set option of `for`	The availability type of the schedule.	`"type": "for",`	Required
In the "duration" object:
Value	Positive integer	The value combined with the units indicates how long the schedule will be available for. When calculating a due date from a schedule, durations with a unit of days, weeks, months, or years automatically "round up" to the end of the calculated day. For example, if a duration of 2 days is added to a start event date of January 2 at 2:00pm, the survey will be available from January 2 at 2:00pm until January 4 at 11:59pm. Be careful when combining delays (especially negative delays) and durations in the same FOR schedule, particularly a schedule with units in days. Because delays "round down," and durations "round up," the date calculations may result in an availability window that is longer than you intend. For example, consider a schedule with a negative delay of -3 days and a duration of 7 days. When you enter a start event date of January 10 at 2:00pm, the negative delay counts backward 3 days to January 7, rounding down to 12:00 am. Then the duration counts forward 7 days to January 14 and rounds up to 11:59pm. January 7-14, inclusive, is a total of 8 calendar days, not 7. In this situation, if your intention is for the survey availability to expire at the end of the day on January 13, you should use a duration of 6 days, not 7.	`"value": 6,`	Required
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `Years`	The value combined with the units indicates how long the schedule will be available for.	`"unit": "hours"`	Required
In the "available" parameter:
Recurrence Rule	Semicolon-delimited key-value string with keys for: `FREQ` - Options of: `DAILY` `WEEKLY` `MONTHLY` `INTERVAL` - Positive integer greater than zero `COUNT` - Positive integer greater than zero	The interval and frequency indicate the rate at which the schedule recurs. The count indicates how many times that recurrence rule is repeated. In the example, the survey recurs once a week for 52 weeks.	`"recurrenceRule": "INTERVAL=1;FREQ=WEEKLY;COUNT=52"`	Optional
In the "end" parameter:
End Events	String, with set options based on configured event names.	One or more events that, when entered by a site user, ends the schedule. View Event Names in the Tools menu to view events and copy their names. End Events may not be needed when a survey occurs only a set number of times. To view the selected event label, position your pointer over the information icon next to the row.	`"end": {` `"endEvents": ["study_complete"]` `}`	Optional

Example “For” Schedule JSON Configuration

The following JSON snippet shows the For schedule parameters. The schedule behavior for the ePRO in this example is: “The avail_6_hours schedule starts immediately after the Dose 1 participant event datetime and is available for 6 hours every week until ended by either the entry of the Study Withdrawal participant event datetime or the entry of the Study Completion participant event datetime by a site user.”

[
  {
    "name": "avail_6_hours",
    "description": "Available for 6 hours weekly",
    "groups": ["youth"
    ],
    "start": {
      "startEvents": ["dose_1"],
      "startRules": null
    },
    "available": {
      "type": "for",
      "duration":
        {
          "value": 6,
          "unit": "hours"
        },
      "recurrenceRule": "INTERVAL=1;FREQ=WEEKLY"
    },
    "end": {
      "endEvents":["study_withdrawal"]
    }
  }
]

Configuring “Between” Schedules

Between schedules make surveys available to respondents for a specified amount of time during the day.

A delay can be configured to offset the beginning of the schedule to a specified amount of time before or after the start event.
Recurrence rules can be configured to make the survey available to respondents at a specified frequency.

Parameter	Data Types	Description	JSON Code Example	Requiredness
Name	String	The unique name of the schedule within this survey.	`"name": "between_8am_and_noon"`	Required
Description	String	The description of the schedule within this survey, if applicable. The description is only displayed within the schedule’s JSON and isn’t shown to participants, caregivers, or site users.	`"description": "Available between 8AM and noon in the participant's local time"`	Optional
Location	String, with set options: `clinic` `home`	Location where a participant or caregiver survey should be completed. This is displayed to site users. Only available when surveyType is ePRO. When the surveyType is eClinRO, the value is defaulted to “clinic” and does not need to be populated.	`"location": "home"`
Groups	String, with set options based on configured group names.	One or more groups that, when added, limit the number of people who this schedule will apply to. If groups are added across multiple group types, then a group from both group types must be selected to trigger this schedule For example: A schedule has the “Age Range” group “5 to 10 years of age” and the “Cohort” group “Cohort A”. For a participant to receive this schedule, the site must select both “5 to 10 years of age” and “Cohort A” groups when enabling eCOA for the participant. The value entered here is the unique name of the group. View Group Names in the Tools menu to view groups and copy their names. You can position your pointer over the information icon next to the group name to see the group label and verify that you selected the correct group. The system will validate that the groups selected are also available groups on the Events selected as Start Events or End Events. If no groups are selected on a schedule and the collection has groups, then the system assigns all groups to the schedule.	`"groups": [` `"youth"` `],`	Optional
In the "startEvents" parameter:
Start Events	String, with set options based on configured event names. If a Start Rule string is added, must use `null.`	One or more events that, when entered by a site user, trigger the start of the schedule. View Event Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startEvents": ["epro_assigned"]`	Start Events or Start Rules is required
Start Rules	String, with set options based on configured rule names. If a Start Event string is added, must use `null.`	One or more rules that, when executed, trigger the start of the schedule. These rules can be based on survey data or on the successful completion of a criteria check. View Rule Names in the Tools menu to view rules and copy their names. To view the selected rule label, position your pointer over the information icon next to the row.	`"startRules": ["hdrs_required"]`	Start Events or Start Rules is required
In the "delay" parameter:
Value	Positive integer	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. If you do not include a delay, the schedule will start immediately at the date and time of any of its Start Events during the study. Positive and negative numbers are accepted.	`"value": 10,`	Optional
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `years`	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. When calculating a date from a schedule, delays with a unit of days, weeks, months, or years automatically “round down” to the beginning of the calculated day. For example, if a delay of 2 days is added to a start date of January 2 at 2:00pm, the delayed survey will become available on January 4 at 12:00am.	`"unit": "hours"`	Optional
In the “available” parameter:
Type	String, with set option of `between`	The availability type of the schedule.	`"type": "between",`	Required
Partial Window	Boolean, with set options: `true` `false`	The partial window defines how a schedule starts based on the time window: true: The schedule will be started if the start datetime falls within a window. false: The schedule will wait until the next complete window to start. This is the default value if the parameter is omitted.	`"partialWindow": true,`	Optional
Start Time	String, with format of HH:mm	The start of the availability window of the schedule. The start time is the time of day at which the schedule begins, in the respondent’s local time time zone. Enter the time in the 24-hour time format (00:00 to 23:59).	`"startTime": "08:00",`	Required when partialWindow is true.
End Time	String, with format of HH:mm	The end of the availability window of the schedule. The end time is the time of day at which the schedule ends, in the respondent’s local time time zone. Enter the time in the 24-hour time format (00:00 to 23:59).	`"endTime": "12:00"`	Required when partialWindow is true.
Recurrence Rule	Semicolon-delimited key-value string with keys for: FREQ - Options of: DAILY WEEKLY MONTHLY INTERVAL - Positive integer greater than zero COUNT - Positive integer, with a maximum value of 366.	The setting that enables the notification to be sent on a recurring schedule. Frequency defines how often the notification process repeats. Note that weekly is every 7 days, and monthly is every 4 weeks. Interval specifies how often a recurrence should happen within a given frequency. Count is an optional parameter that defines the number of recurrences before the series of notifications ends.	`"recurrenceRule": "INTERVAL=1;FREQ=WEEKLY;COUNT=52"`	Optional
In the “end” parameter:
End Events	String, with set options based on configured event names	One or more events that, when entered by a site user, ends the schedule. View Event Names in the Tools menu to view events and copy their names. End Events may not be needed when a survey occurs only a limited number of times or is ended by the End Time. To view the selected event label, position your pointer over the information icon next to the row.	`"endEvents": ["study_complete"]`	Optional

Example “Between” Schedule JSON Configuration

The following JSON snippet shows the Between schedule parameters. The schedule behavior for an ePRO in the example below is: “The between_8_and_noon schedule starts 1 hour after the Visit 1 (visit_1) participant event datetime is entered by a site user and is available between 08:00am and 12:00pm every day for 7 days. The schedule will start even if the first instance occurs between 08:00am and 12:00pm in a partial window. No participant event ends this schedule.”

[
  {
    "name": "between_8_and_noon",
    "description": "Available between 8am and noon in the participant's local time",
    "location": "home",
    "groups": ["youth"
    ],
    "start": {
      "delay": {
        "value": 1,
        "unit": "hours"
      },
      "startEvents": ["visit_1"],
      "startRules": null
    },
    "available": {
      "type": "between",
      "partialWindow": true,
      "startTime": "08:00",
      "endTime": "12:00",
      "recurrenceRule": "INTERVAL=1;FREQ=DAILY;COUNT=7"
    },
    "end": {
        "endEvents": []
    }
  }
]

Configuring “As Needed” Diary Schedules

As Needed schedules make diary surveys available for respondents to complete as many times as they need. After a respondent submits the diary survey, it’s immediately available again.

Delays can be configured to offset the beginning of the schedule to a specified amount of time before or after the start event.
Because As Needed surveys can be completed multiple times by respondents, recurrence rules aren’t supported.
You must use As Needed schedules for diary surveys.

Parameter	Data Types	Description	JSON Code Example	Requiredness
Name	String	The unique name of the schedule.	`"name": "as_needed"`	Required
Description	String	The description of the schedule, if applicable. The description is only displayed in the schedule’s JSON and is not shown to respondents.	`"description": "Available for the participant to take as many times as they want"`	Optional
Location	String, with set options: `clinic` `home`	Location where a participant or caregiver survey should be completed. This is displayed to site users. Only available when surveyType is ePRO. When the surveyType is eClinRO, the value is defaulted to “clinic” and does not need to be populated.	`"location": "home"`	Optional
Groups	String, with set options based on configured group names.	If the collection has groups, a schedule can be assigned to a subset of groups so that during the study the schedule is only applied to participants in those groups. By default, a schedule applies to participants in all groups. If a schedule is assigned to multiple groups, then a participant must be in all groups to trigger this schedule. For example: An event is related to the “Age Range” group “5 to 10 years of age” and the “Cohort” group “Cohort A”. For a participant to receive this schedule, they must be in the “5 to 10 years of age” and “Cohort A” groups. The value entered here is the unique name of the group. View Group Names in the Tools menu to view groups and copy their names. You can position your pointer over the information icon next to the group name to see the group label and verify that you selected the correct group. The system will validate that the groups selected are also available groups on the Events selected as Start Events or End Events. If no groups are selected on a schedule and the collection has groups, then the system assigns all groups to the schedule.	`"groups": [` `"youth"` `],`	Optional
In the “start” parameter
Start Events	String, with set options based on configured event names. If a Start Rule string is added, must use `null.`	One or more events that, when entered by a site user, trigger the start of the schedule. The value entered here is the event name. View Event Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startEvents": ["epro_assigned"]`	Start Events or Start Rules is required
Start Rules	String, with set options based on configured rule names. If a Start Event string is added, must use `null.`	One or more rules that, when executed, trigger the start of the schedule. These rules can be based on survey data or on the successful completion of a criteria check. View Rule Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startRules": ["hdrs_required"]`	Start Events or Start Rules is required
In the "delay" parameter:
Value	Positive integer	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. If you do not include a delay, the schedule will start immediately at the date and time of any of its Start Events during the study. Positive and negative numbers are accepted.	`"value": 10,`	Optional
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `years`	The unit of the amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated using that unit to get the starting time for the schedule. When calculating a date from a schedule, delays with a unit of days, weeks, months, or years automatically “round down” to the beginning of the calculated day. For example, if a delay of 2 days is added to a start date of January 2 at 2:00pm, the delayed survey will become available on January 4 at 12:00am.	`"delay": {` `"value": 10,` `"unit": "hours"` `}`	Optional
In the "available" parameter:
Type	String, with set option of `asNeeded`	The availability type of the schedule.	`"type": "asNeeded"`	Required
Partial Window	Boolean, with set options: `true` `false`	The partial window defines how a schedule starts based on the time window: true: The schedule will be started if the start datetime falls within a window. false: The schedule will wait until the next complete window to start. This is the default value if the parameter is omitted.	`"partialWindow": true,`	Optional
Start Time	String, with format of HH:mm	Note: If a survey should be available as needed at all times, do not add Start/End Times. The start of the availability window of the schedule. The start time is the time of day at which the schedule begins, in the respondent’s local time time zone. Availability windows can be scheduled for As Needed schedules to make a survey available as needed at certain times of day. In the example, the As Needed schedule makes the survey available as needed to a respondent beginning at 08:00. Enter the time in the 24-hour time format (00:00 to 23:59).	`"startTime": "08:00",`	Required when partialWindow is true.
End Time	String, with format of HH:mm	Note: If a survey should be available as needed at all times, do not add Start/End Times. The end of the availability window of the schedule. The end time is the time of day at which the schedule ends, in the respondent’s local time time zone. Availability windows can be scheduled for As Needed schedules to make a survey available as needed at certain times of day. In the example, the As Needed schedule makes the survey availability end for the participant at 12:00. Enter the time in the 24-hour time format (00:00 to 23:59).	`"endTime": "12:00"`	Required when partialWindow is true.
Start Multiple	Boolean, with set options: `true` `false`	This value can only be used for surveys that use a `diary` subtype. If not included, `false` is selected by default.	`"startMultiple": true`	Optional
In the “end” parameter
End Events	String, with set options based on configured event names	One or more events that, when entered by a site user, ends the schedule. View Event Names in the Tools menu to view events and copy their names. End Events may not be needed when a survey occurs only a limited number of times or is ended by the End Time. To view the selected event label, position your pointer over the information icon next to the row.	`"endEvents": ["study_complete"]`	Optional

Example “As Needed” Schedule JSON Configuration

The following JSON snippet shows the As Needed schedule parameters described above. The schedule behavior of the ePRO diary in the example below is: “The as_needed schedule starts 1 week after the eCOA Activated event, and it’s available as needed until the Study Complete participant event datetime is entered by a site user. The participant can start multiple in-progress surveys as needed.”

[
  {
    "name": "as_needed",
    "description": "Available for the participant to take as many times as they want",
    "groups": ["youth"
    ],
    "start": {
      "delay": {
        "value": 1,
        "unit": "weeks"
      },
      "startEvents": ["ecoa_activated"],
      "startRules": null
    },
    "available": {
      "type": "asNeeded",
      "startMultiple": true
    },
    "end": {
        "endEvents": ["study_complete"]
    }
  }
]

Configuring “Open-Ended” Schedules

Use Open-Ended schedules in the following instances:

The start parameter contains only unscheduled events
The survey type is eClinRO and you do not want the survey to have an associated end date
The survey type is ePRO and the survey subtype is training.

These parameters are not supported:

Recurrence Rules: Because Open-Ended surveys can be added to unscheduled events, recurrence rules are not supported.
Availability Windows: Because surveys are assigned based on an unscheduled event or events with no discernable end date, availability windows, including start times, end times, and durations are not supported.

Parameter	Data Type	Description	JSON Code Example	Requiredness
Name	String	The unique name of the schedule.	`"name": "open_ended"`	Required
Description	String	The description of the schedule, if applicable. The description is only displayed in the schedule’s JSON and is not shown to respondents.	`"description": "Available for the site when included in an Unscheduled Event."`	Optional
Location	String, with set options: `clinic` `home`	Location where a participant or caregiver survey should be completed. This value is displayed to site users. Only available when surveyType is ePRO. When the surveyType is eClinRO, the value is defaulted to “clinic” and does not need to be populated.	`"location": "home"`	Optional
Groups	String, with set options based on configured group names.	If the collection has groups, a schedule can be assigned to a subset of groups so that during the study the schedule is only applied to participants in those groups. By default, a schedule applies to participants in all groups. If a schedule is assigned to multiple groups, then a participant must be in all groups to trigger this schedule. For example: An event is related to the “Age Range” group “5 to 10 years of age” and the “Cohort” group “Cohort A”. For a participant to receive this schedule, they must be in the “5 to 10 years of age” and “Cohort A” groups. The value entered here is the unique name of the group. View Group Names in the Tools menu to view groups and copy their names. You can position your pointer over the information icon next to the group name to see the group label and verify that you selected the correct group. The system will validate that the groups selected are also available groups on the Events selected as Start Events or End Events. If no groups are selected on a schedule and the collection has groups, then the system assigns all groups to the schedule.	`"groups": [` `"youth"` `],`	Optional
In the "start" parameter:
Start Events	String, with set options based on configured event names. If a Start Rule string is added, must use `null.`	One or more events that, when entered by a site user, trigger the start of the schedule. The value entered here is the event name. View Event Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startEvents": ["ecoa_assigned"]`	Start Events or Start Rules is required
Start Rules	String, with set options based on configured rule names. If a Start Event string is added, must use `null.`	One or more rules that, when executed, trigger the start of the schedule. These rules can be based on survey data or on the successful completion of a criteria check. View Rule Names in the Tools menu to view events and copy their names. To view the selected event label, position your pointer over the information icon next to the row.	`"startRules": ["hdrs_required"]`	Start Events or Start Rules is required
In the "delay" parameter:
Value	Whole number	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. If you do not include a delay, the schedule will start immediately at the date and time of any of its Start Events during the study. Positive and negative numbers are accepted.	`"value": 10`	Optional
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `years`	The amount of time that the schedule is offset from the Start Event by. When the Start Event has a datetime, the offset is calculated from that datetime to get the starting time for the schedule. When calculating a date from a schedule, delays with a unit of days, weeks, months, or years automatically “round down” to the beginning of the calculated day. For example, if a delay of 2 days is added to a start date of January 2 at 2:00pm, the delayed survey will become available on January 4 at 12:00am.	`"unit": "hours"`	Optional
In the "available" parameter:
Type	String, with set option of `openEnded`	The availability type of the schedule.	`"type": "openEnded"`	Required
In the "end" parameter:
End Events	String, with set options based on configured event names	One or more events that, when entered by a site user, ends the schedule. View Event Names in the Tools menu to view events and copy their names. End Events may not be needed when a survey occurs only a set number of times is ended by the End Time. To view the selected event label, position your pointer over the information icon next to the row.	`"endEvents": ["study_complete"]`	Optional

Example “Open-Ended” Schedule JSON Configuration

The following JSON snippet shows the Open-Ended schedule parameters described above. The schedule behavior of the ePRO in the example below is: “The open_ended schedule starts when the Ad Hoc Visit unscheduled event is assigned to the participant by a site user. The schedule ends if the Study Complete event datetime is entered by the site user.”

[
  {
    "name": "open_ended",
    "description": "Available for the participant to complete their training.",
    "groups": ["youth"
    ],
    "start": {
      "startEvents": ["ad_hoc_visit"],
      "startRules": null
    },
    "available": {
      "type": "openEnded",
    },
    "end": {
        "endEvents": ["study_complete"]
    }
  }
]

Configuration Parameters for Notifications

Notifications are configured within the schedule where you want the notification to be sent.

Notifications are included as an additional parameter in the schedule JSON, which is an array that contains one or multiple notifications.
Notifications are available for ePRO surveys. Notifications configured in ePRO survey schedules are expected to include the following information:
- Participant or caregiver notifications regarding their ePRO activity
- Site notifications regarding participant or caregiver ePRO activity
Participant and caregiver notifications are not available for eClinRO surveys.
If you configure any notifications for surveys in your collection, the notification text in each language is included in your study’s collection document. This can aid your study’s IRB/EC approvals, if applicable.
The Veeva notification templates are not pre-approved by IRBs/ECs for use in studies.

The following JSON snippet shows how notifications can be configured in the schedule JSON. The notification behavior of the ePRO in the example below is: “The participant or caregiver receives notification1 immediately when the survey becomes available, and they also receive notification2 one hour before the survey is due.”

[
  {
    "name": "as_needed",
    "start": {
      "startEvents": ["epro_assigned"]
    },
    "available": {
      "type": "asNeeded",
    },
    "end": {
        "endEvents": ["study_complete"]
    }
    "notifications": [
      {
        "name": "notification1",
        "template": "veeva_epro_participant_reminder_survey_available",
        "type": "available",
      },
      {
        "name": "notification2",
        "template": "veeva_epro_participant_reminder_survey_due",
        "type": "due",
        "offset": {
          "value": -1,
          "unit": "hours"
        }
      }
    ]
  }
]

Configuring New Survey Available Notifications

New Survey Available notifications alert a respondent when a new survey is available to them as configured by the survey’s schedule. The notification includes the display name of the survey. The content of the notification isn’t otherwise configurable.

Parameter	Data Type	Description	JSON Code Example	Requiredness
Name	String	The unique name of the notification schedule.	`"name": "on_avail"`	Required
Template	String, with set option: `veeva_epro_participant_new_survey`	The notification template that the participant or caregiver receives Only Veeva’s standard notification templates are currently supported.	`"template": "veeva_epro_participant_new_survey"`	Required
Type	String, with set option: `available`	The type of notification.	`"type": "available"`	Required
Recurrence Rule	Semicolon-delimited key-value string with keys for: `FREQ` - Options of: `DAILY` `WEEKLY` `MONTHLY` `INTERVAL` - Positive integer greater than zero `COUNT` - Positive integer, with a maximum value of 366.	The setting that enables the notification to be sent on a recurring schedule. The `FREQ` and `INTERVAL` keys are required if you include this parameter. Frequency defines how often the notification process repeats. Note that weekly is every 7 days, and monthly is every 4 weeks. Interval specifies how often a recurrence should happen within a given frequency. Count is an optional parameter that defines the number of recurrences before the series of notifications ends.	`"FREQ=WEEKLY;INTERVAL=1;COUNT=52",`	Optional
Default Delivery Time	String, in HH:mm format	The time of day for the participant when the recurring notification should be delivered. Enter the time in the 24-hour time format (00:00 to 23:59).	`"defaultDeliveryTime" : "09:00"`	Required when recurrentRule is set.

Example New Survey Available Notification JSON Configuration

The following JSON snippet shows the New Survey Available notification parameters. The notification behavior of the ePRO in the example below is: “The user receives notification1 immediately when the survey becomes available.”

"notifications": [
  {
    "name": "notification1",
    "template": "veeva_epro_participant_reminder_survey_available",
    "type": "available",
    "recurrenceRule": "FREQ=WEEKLY;INTERVAL=1;COUNT=52",
    "defaultDeliveryTime" : "09:00"
  }
]

Configuring Survey Due Notifications

Survey Due notifications alert a participant, caregiver, or site user when a survey is approaching its due date as determined by the survey’s schedule. The notification includes the display name of the survey and the amount of time before it’s due. The content of the notification is not otherwise configurable. If the site survey due notification is configured, the site user will receive a compliance warning for the participant.

Parameter	Data Type	Description	JSON Code Example	Requiredness
Name	String	The unique name of the notification.	`"name": "30_mins_before_due"`	Required
Template	String, with set options: Participant and caregiver: `veeva_epro_participant_reminder_survey_due` Site user: `veeva_epro_site_not_completed_survey`	The notification template that the participant, caregiver, or site user receives. Only Veeva’s standard notification templates are currently supported.	`"template": "veeva_epro_participant_new_survey"` `"template": "veeva_epro_site_not_completed_survey"`	Required
Type	String, with set option: `due`	The type of notification.	`"type": "due"`	Required
In the “offset” parameter:
Value	Negative integer	The value of the amount of time before the due date and time when the notification should be sent.	`"value": -30,`	Optional
Unit	String, with set options: `minutes` `hours` `days` `weeks` `months` `years`	The unit of the amount of time before the due date and time when the notification should be sent.	`"unit": "minutes"`	Optional
Top-level parameters:
Recurrence Rule	Semicolon-delimited key-value string with keys for: `FREQ` - Options of: `DAILY` `WEEKLY` `MONTHLY` `INTERVAL` - Positive integer greater than zero `COUNT` - Positive integer, with a maximum value of 366.	The setting that enables the notification to be sent on a recurring schedule Frequency defines how often the notification process repeats. Note that weekly is every 7 days, and monthly is every 4 weeks. Interval specifies how often a recurrence should happen within a given frequency. Count is an optional parameter that defines the number of recurrences before the series of notifications ends.	`"FREQ=WEEKLY;INTERVAL=1;COUNT=52",`	Optional
Default Delivery Time	String, in HH:mm format	The time of day for the participant when the recurring notification should be delivered. Enter the time in the 24-hour time format (00:00 to 23:59).	`"defaultDeliveryTime" : "09:00"`	Required when recurrentRule is set.

Example Survey Due Notification JSON Configuration

The following JSON snippet shows the Survey Due notification parameters. The notification behavior of the ePRO in the example below is: “The participant or caregiver receives notification1 1 hour before the survey is due, and the site user receives notification2 30 minutes before the survey is due.”

"notifications": [
  {
    "name": "notification1",
    "template": "veeva_epro_participant_reminder_survey_due",
    "type": "due",
    "offset": {
      "value": -1,
      "unit": "hours"
    },
    "recurrenceRule": "INTERVAL=1;FREQ=DAILY;COUNT=7",
    "defaultDeliveryTime" : "09:00"
  },
  {
    "name": "notification2",
    "template": "veeva_epro_site_not_completed_survey",
    "type": "due",
    "offset": {
      "value": -30,
      "unit": "minutes"
    },
    "recurrenceRule": "INTERVAL=1;FREQ=DAILY;COUNT=7",
    "defaultDeliveryTime" : "09:00"
  }
]

Configuring Survey Complete Notifications

Survey Complete notifications alert a site user when a respondent completes a survey. The notification includes the display name of the survey. The content of the notification is not otherwise configurable. Delays are not supported for Survey Complete notifications.

Parameter	JSON Code Example	Description	Requiredness
Name	`"name": "notification1"`	The unique name of the notification schedule. Must be unique within the schedule.	Required
Template	`"template": "veeva_epro_site_completed_survey"`	The notification template the site user receives. Only Veeva's standard notification templates are currently supported.	Required
Type	`"type": "complete"`	The type of notification. Survey Complete notifications must use a type of `complete`.	Required

Example Survey Complete Notification JSON Configuration

The following JSON snippet shows the Survey Complete notification parameters described above. The notification behavior of the ePRO in the example below is: “The site user receives notification1 when this survey is completed by a participant or caregiver.

"notifications": [
            {
                "name": "notification1",
                "type": "complete",
                "template": "veeva_epro_site_completed_survey"
            }
        ]

Configuring Missed Notifications

Missed notifications alert a participant, caregiver, or site user when a participant or caregiver misses one or more surveys that are assigned to them. Missed notifications are not sent for surveys that are created in a Missed state. The notification includes the display name of the survey and how many surveys of that type the participant or caregiver missed. The content of the notification is not otherwise configurable. Delays are not supported for Missed notifications.

Parameter	JSON Code Example	Description	Requiredness
Name	`"name": "survey_missed_mv_notification"`	The unique name of the notification schedule.	Required
Template	`"template": "veeva_epro_participant_missed_survey"` `"template": "veeva_epro_participant_missed_surveys"` `"template": "veeva_epro_site_missed_survey"` `"template": "veeva_epro_site_missed_surveys"`	The notification template that the participant, caregiver, or site user receives. Only Veeva's standard notification templates are currently supported. Participant or caregiver missed notifications should use the `veeva_epro_participant_missed_survey` or `veeva_epro_participant_missed_surveys` templates. Site user missed notifications should use the `veeva_epro_site_missed_survey` or `veeva_epro_site_missed_surveys` templates.	Required
Type	`"type": "missed"`	The type of notification. Missed notifications must use a type of missed.	Required
numMissed	`"numMissed": 1`	The number of surveys that must be missed before the notification is sent. Note: If numMissed is 1, you must use the templates that end with `survey`. If numMissed is greater than 1, you must use the templates that end with `surveys`.	Required

Example Missed Notification JSON Configuration

The following JSON snippet shows the Missed notification parameters. The notification behavior of the ePRO in the example below is: “The participant or caregiver receives notification1 after they miss this survey 3 times, and the site user receives notification2 each time this survey is missed.”

"notifications": [
  {
    "name": "notification1",
    "template": "veeva_epro_participant_missed_surveys",
    "type": "missed",
    "numMissed": 3
  },
  {
    "name": "notification2",
    "template": "veeva_epro_site_missed_survey",
    "type": "missed",
    "numMissed": 1
  }
]

Complete List of Standard Notifications

Below is the complete list of standard notifications that can be included within your eCOA schedule. The table includes the exact template ID that you can copy and paste in your schedule configuration, the recipient of that notification (Participant, Caregiver, or Site), and the Title and Message content of the notification sent to the users. Variables within [brackets] in the Titles and Messages columns are replaced by information related to the study, participant, caregiver, or notification.

Template ID	Recipient	Title	Message	Example Title and Message
veeva_epro_participant_new_survey	Participant or Caregiver	New Survey Available	Your [Display Name] is now available.	New Survey Available Your Wellness Survey is now available.
veeva_epro_participant_reminder_survey_available	Participant or Caregiver	Reminder: Survey Available	Complete your [Display Name] as needed.	Reminder: Survey Available Complete your Wellness Survey as needed.
veeva_epro_participant_reminder_survey_due	Participant or Caregiver	Reminder: Survey Due	Your [Display Name] is due in [Notification Value] [Notification Unit].	Reminder: Survey Due Your Wellness Survey is due in 5 days.
veeva_epro_participant_missed_survey	Participant or Caregiver	Missed Survey	You missed your [Display Name]. Contact your study team if you're having trouble completing surveys.	Missed Survey You missed your Wellness Survey. Contact your study team if you're having trouble completing surveys.
veeva_epro_participant_missed_surveys	Participant or Caregiver	Missed Surveys	You missed your [Display Name] [Number Missed] times. Contact your study team if you're having trouble completing surveys.	Missed Surveys You missed your Wellness Survey 3 times. Contact your study team if you're having trouble completing surveys.
veeva_epro_site_completed_survey	Site	[Study Name] Participant Completed a Survey	[Study Name] participant [Participant ID] has completed [Display Name]. Note: This notification does not support caregiver surveys.	FEZZIK-07 Participant Completed Survey FEZZIK-07 participant 5551212 has completed Wellness Survey.
veeva_epro_site_not_completed_survey	Site	[Study Name] [User Role] Has Not Completed a Survey	[Study Name] [User Role] [Respondent ID] has not yet completed their [Display Name], which is due in [Notification Value] [Notification Unit].	FEZZIK-07 Caregiver for Participant 008 Has Not Completed a Survey FEZZIK-07 caregiver for participant 008 has not yet completed their Daily Morning Diary, which is due in 24 hours.
veeva_epro_site_missed_survey	Site	[Study Name] [User Role] Missed a Survey	[Study Name] [User Role] [Respondent ID] missed their [Display Name] today.	FEZZIK-07 Caregiver for Participant 008 Missed a Survey FEZZIK-07 caregiver for participant 008 missed their Daily Morning Diary today.
veeva_epro_site_missed_surveys	Site	[Study Name] [User Role] Missed Multiple Surveys	[Study Name] [User Role] [Respondent ID] missed their last [Number Missed] [Display Name] surveys.	FEZZIK-07 Caregiver for Participant 008 Missed Multiple Surveys FEZZIK-07 caregiver for participant 008 missed their last 7 Daily Morning Diary surveys.