ParticipantSchedule

@Serializable
data class ParticipantSchedule(val createdOn: String, val dateRange: DateRange? = null, val schedule: List<ScheduledSession>? = null, val assessments: List<AssessmentInfo>? = null, val sessions: List<SessionInfo>? = null, val studyBursts: List<StudyBurstInfo>? = null, val eventTimestamps: Map<String, Instant>? = null, val type: String? = null)

A detailed description of when a participant should perform specific sessions as part of a study. The ParticipantSchedule is similar to the Timeline in structure, but includes the specific dates when this participant should perform each session, as well as state information about the participant’s completion of the schedule. Entries in the schedule collection should be ordered by startDate and startTime, and entries that are not available to the participant are not included in the collection (ie. entries that have the state not_applicable). However, definitions for those sessions are still included in the sessions, assessments, and studyBursts collections for future reference. Persistent time windows do not have state (they should always be available to the participant so they are never shown as finished, even if one or more adherence records have been filed for that session).

Parameters

createdOn

The date and time this schedule was calculated.

dateRange
schedule
assessments
sessions
studyBursts
type

ParticipantSchedule

Constructors

Link copied to clipboard
constructor(createdOn: String, dateRange: DateRange? = null, schedule: List<ScheduledSession>? = null, assessments: List<AssessmentInfo>? = null, sessions: List<SessionInfo>? = null, studyBursts: List<StudyBurstInfo>? = null, eventTimestamps: Map<String, Instant>? = null, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "assessments")
val assessments: List<AssessmentInfo>? = null
Link copied to clipboard
@SerialName(value = "createdOn")
val createdOn: String
Link copied to clipboard
@SerialName(value = "dateRange")
val dateRange: DateRange? = null
Link copied to clipboard
@SerialName(value = "eventTimestamps")
val eventTimestamps: Map<String, Instant>? = null
Link copied to clipboard
@SerialName(value = "schedule")
val schedule: List<ScheduledSession>? = null
Link copied to clipboard
@SerialName(value = "sessions")
val sessions: List<SessionInfo>? = null
Link copied to clipboard
@SerialName(value = "studyBursts")
val studyBursts: List<StudyBurstInfo>? = null
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null