...
Given the designs I have seen so far, I would suggest a set of records that show the sessions to be performed N days after each event, available as a single report that’ll be similar in size to the Timeline. In the array, each record shows one event time stream, and the sessions that should be performed under the “days since event N” key of the entries map. Right now, that day has an array with each session holding its own set of windows, since they are graphed together in designs I have seen (and the completion state is recorded for each window—that’s really the session).
All sessions in the timeline are grouped in this view by the event that triggers them, and then the number of days since that event. All potential events in the schedule are included in this report whether they exist for the user or not. Then the actual “days since each event” are calculated to determine what the state of each time window is (states are described below the JSON sample):
| Code Block | ||
|---|---|---|
| ||
[
{
"startEventId":"study_burst:ClinicVisit:01",
"eventTimestamp":"2021-10-27T19:00:00.000Z",
"entries":{
"1":[
{
"sessionGuid":"vZBHBVv_H2_1TBbELF48czjS",
"label": "Session #1",
"symbol": "circle",
"timeWindows":[
{
"sessionInstanceGuid":"ePcCf6VmfIiVuU0ckdBeRw",
"timeWindowGuid":"sUaNAasy_LiT3_IYa1Fx_dSv",
"state":"not_yet_available",
"type":"SessionStreamWindow"
},
{
"sessionInstanceGuid":"DB13D4mO72j6S-g7PIkI2Q",
"timeWindowGuid":"Bw6rAAeG6zotqes4cLSgKjh5",
"state":"not_yet_available",
"type":"SessionStreamWindow"
}
],
"type":"SessionStream"
}
],
"2":[
{
"sessionGuid":"vZBHBVv_H2_1TBbELF48czjS",
"label": "Session #1",
"symbol": "circle",
"timeWindows":[
{
"sessionInstanceGuid":"wvEV4fJZQ0nfgY-TN2LekA",
"timeWindowGuid":"sUaNAasy_LiT3_IYa1Fx_dSv",
"state":"not_yet_available",
"type":"SessionStreamWindow"
},
{
"sessionInstanceGuid":"IHDTSoj552vGDv1Qt7nXkg",
"timeWindowGuid":"Bw6rAAeG6zotqes4cLSgKjh5",
"state":"not_yet_available",
"type":"SessionStreamWindow"
}
],
"type":"SessionStream"
}
]
},
"type":"SessionStreamReport"
},
{
"startEventId":"study_burst:ClinicVisit:02",
"eventTimestamp":"2021-11-16T19:00:00.000Z",
"entries":{
"1":[
{
"sessionGuid":"vZBHBVv_H2_1TBbELF48czjS",
"label": "Session #1",
"symbol": "circle",
"timeWindows":[
{
"sessionInstanceGuid":"zk7X4dQCy7Nvnuo2PcnSCA",
"timeWindowGuid":"sUaNAasy_LiT3_IYa1Fx_dSv",
"state":"not_yet_available",
"type":"SessionStreamWindow"
},
{
"sessionInstanceGuid":"rMRne-cbwIN5mkGZLymxzg",
"timeWindowGuid":"Bw6rAAeG6zotqes4cLSgKjh5",
"state":"not_yet_available",
"type":"SessionStreamWindow"
}
],
"type":"SessionStream"
}
],
"2":[
{
"sessionGuid":"vZBHBVv_H2_1TBbELF48czjS",
"label": "Session #1",
"symbol": "circle",
"timeWindows":[
{
"sessionInstanceGuid":"QXM1cO6yb0gSPWzRwRD8eA",
"timeWindowGuid":"sUaNAasy_LiT3_IYa1Fx_dSv",
"state":"not_yet_available",
"type":"SessionStreamWindow"
},
{
"sessionInstanceGuid":"hCXFevxbBnpaUYjH212dsQ",
"timeWindowGuid":"Bw6rAAeG6zotqes4cLSgKjh5",
"state":"not_yet_available",
"type":"SessionStreamWindow"
}
],
"type":"SessionStream"
}
]
},
"type":"SessionStreamReport"
}
] |
All sessions in the timeline are grouped in this view by the event that triggers them, and then the number of days since that event. All potential events in the schedule are included in this report whether they exist for the user or not (we don’t currently have a way to say “count this part of the schedule if the event exists for the user, but don’t count it if the event doesn’t exist for the user). Then the actual “days since each event” are calculated to determine what the state of each time window is (the window state is a session-level measure of the state, derived from the adherence records of the assessments in that session).
...
,
"type":"SessionStreamReport"
}
] |
The states are:
State | Description | Adherence |
|---|---|---|
not_applicable | Participant does not have this event in their events, so these sessions will not currently ever be shown to the participant. | N/A |
not_yet_available | Participant should not have seen or started this session. It’s in the future. | N/A |
unstarted | Participant should see the session (they are being asked to do it now), but they have not started it. | unknown |
started | Participant has started the session. | unknown |
completed | Participant completed the session before it expired. | compliant |
abandoned | Participant started or finished at least one assessment in the session, but there was more work to do and it expired before they finished it. | noncompliant |
expired | Participant did not start the session and it is now expired. | noncompliant |
...