public interface StudyAdherenceApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Message> |
deleteAdherenceRecord(String studyId,
String userId,
String instanceGuid,
DateTime eventTimestamp,
DateTime startedOn)
Delete an adherence record
Delete an existing adherence record
|
retrofit2.Call<AdherenceStatistics> |
getAdherenceStatistics(String studyId,
Integer adherenceThreshold)
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
|
retrofit2.Call<StudyAdherenceReport> |
getStudyParticipantAdherenceReport(String studyId,
String userId)
Get a detailed report on a participant’s full schedule of activities.
|
retrofit2.Call<EventStreamAdherenceReport> |
getStudyParticipantEventStreamAdherenceReport(String studyId,
String userId,
DateTime datetime,
Boolean activeOnly)
Get a detailed report on a participant’s adherence to the entire study protocol’s schedule.
|
retrofit2.Call<EventStreamAdherenceReport> |
getUsersStudyParticipantEventStreamAdherenceReport(String studyId,
DateTime datetime,
Boolean activeOnly)
Get a detailed report on the caller’s adherence to the entire study protocol’s schedule.
|
retrofit2.Call<WeeklyAdherenceReport> |
getWeeklyAdherenceReport(String studyId,
String userId)
Get a detailed report on a participant’s current week of scheduled activities.
|
retrofit2.Call<WeeklyAdherenceReportList> |
getWeeklyAdherenceReports(String studyId,
AdherenceReportSearch adherenceReportSearch)
Get the adherence for all study participants in their current week of the study.
|
retrofit2.Call<AdherenceRecordList> |
searchForAdherenceRecords(String studyId,
AdherenceRecordsSearch adherenceRecordsSearch)
Search for adherence records.
|
retrofit2.Call<AdherenceRecordList> |
searchForAdherenceRecordsForStudy(String studyId,
AdherenceRecordsSearch adherenceRecordsSearch)
Search for adherence records in a study (irrespective of user).
|
retrofit2.Call<AdherenceRecordList> |
searchForStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordsSearch adherenceRecordsSearch)
Search for adherence records.
|
retrofit2.Call<Message> |
updateAdherenceRecords(String studyId,
AdherenceRecordUpdates adherenceRecordUpdates)
Create or update one or more adherence records.
|
retrofit2.Call<Message> |
updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/{userId}/adherence/{instanceGuid}/{eventTimestamp}/{startedOn}")
retrofit2.Call<Message> deleteAdherenceRecord(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="instanceGuid")
String instanceGuid,
@Path(value="eventTimestamp")
DateTime eventTimestamp,
@Path(value="startedOn")
DateTime startedOn)
studyId - Study identifier (required)userId - User ID (required)instanceGuid - Instance GUID of the adherence record (required)eventTimestamp - Event timestamp (ISO 8601) of the adherence record (required)startedOn - Starting timestamp (ISO 8601) of the adherence record (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/adherence/stats")
retrofit2.Call<AdherenceStatistics> getAdherenceStatistics(@Path(value="studyId")
String studyId,
@Query(value="adherenceThreshold")
Integer adherenceThreshold)
studyId - Study identifier (required)adherenceThreshold - The percentage cutoff to use to determine totals of compliant and noncompliant participants. (optional)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/adherence/study")
retrofit2.Call<StudyAdherenceReport> getStudyParticipantAdherenceReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/adherence/eventstream")
retrofit2.Call<EventStreamAdherenceReport> getStudyParticipantEventStreamAdherenceReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Query(value="datetime")
DateTime datetime,
@Query(value="activeOnly")
Boolean activeOnly)
studyId - Study identifier (required)userId - User ID (required)datetime - The timestamp to use as “now” for the calculation of adherence. This timestamp will be adjusted to the participant’s `clientTimeZone` value if this value has been persisted for the participant. (optional, default to The date and time on the server at the time of the request)activeOnly - Only return records that are currently actionable by the participant (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/self/adherence/eventstream")
retrofit2.Call<EventStreamAdherenceReport> getUsersStudyParticipantEventStreamAdherenceReport(@Path(value="studyId")
String studyId,
@Query(value="datetime")
DateTime datetime,
@Query(value="activeOnly")
Boolean activeOnly)
studyId - Study identifier (required)datetime - The timestamp to use as “now” for the calculation of adherence. This timestamp will be adjusted to the caller’s `clientTimeZone` value if this value has been persisted. (optional, default to The date and time on the server at the time of the request)activeOnly - Only return records that are currently active and actionable for the participant. (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReport> getWeeklyAdherenceReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReportList> getWeeklyAdherenceReports(@Path(value="studyId")
String studyId,
@Body
AdherenceReportSearch adherenceReportSearch)
studyId - Study identifier (required)adherenceReportSearch - Search parameters for weekly adherence report (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/self/adherence/search")
retrofit2.Call<AdherenceRecordList> searchForAdherenceRecords(@Path(value="studyId")
String studyId,
@Body
AdherenceRecordsSearch adherenceRecordsSearch)
studyId - Study identifier (required)adherenceRecordsSearch - The search criteria. (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/adherence/search")
retrofit2.Call<AdherenceRecordList> searchForAdherenceRecordsForStudy(@Path(value="studyId")
String studyId,
@Body
AdherenceRecordsSearch adherenceRecordsSearch)
studyId - Study identifier (required)adherenceRecordsSearch - The search criteria. (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/{userId}/adherence/search")
retrofit2.Call<AdherenceRecordList> searchForStudyParticipantAdherenceRecords(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Body
AdherenceRecordsSearch adherenceRecordsSearch)
studyId - Study identifier (required)userId - User ID (required)adherenceRecordsSearch - The search criteria. (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/self/adherence")
retrofit2.Call<Message> updateAdherenceRecords(@Path(value="studyId")
String studyId,
@Body
AdherenceRecordUpdates adherenceRecordUpdates)
studyId - Study identifier (required)adherenceRecordUpdates - One ore more adherence records (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/{userId}/adherence")
retrofit2.Call<Message> updateStudyParticipantAdherenceRecords(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Body
AdherenceRecordUpdates adherenceRecordUpdates)
studyId - Study identifier (required)userId - User ID (required)adherenceRecordUpdates - One ore more adherence records (required)Copyright © 2023 Sage Bionetworks. All rights reserved.