bridge-client/org.sagebionetworks.bridge.kmm.shared.models/Study

Study

@Serializable

data class Study(val identifier: String, val name: String, val phase: StudyPhase, val version: Long, val details: String? = null, val clientData: JsonElement? = null, val irbName: String? = null, val irbDecisionOn: String? = null, val irbExpiresOn: String? = null, val irbDecisionType: IrbDecisionType? = null, val irbProtocolName: String? = null, val irbProtocolId: String? = null, val studyLogoUrl: String? = null, val colorScheme: ColorScheme? = null, val institutionId: String? = null, val scheduleGuid: String? = null, val keywords: String? = null, val diseases: List<String>? = null, val studyDesignTypes: List<String>? = null, val signInTypes: List<SignInType>? = null, val contacts: List<Contact>? = null, val deleted: Boolean? = null, val createdOn: String? = null, val modifiedOn: String? = null, val type: String? = null)

A study (an outside organization providing participants for a study).

Parameters

identifier

The identifier for this study.

name

The name of the study.

details

An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).

phase

clientData

Client data for a study should be in a syntactically valid JSON format. It will be returned as is to the client (as JSON). It can contain any information that is useful to study authoring tools or administration tools that is not part of the Bridge data model.

irbName

The name of the IRB that approved the study or decided it was exempt from human subjects research guidelines. Optional, but can be used to identify one of several IRBs if more than one is included in the study’s contact information.

irbDecisionOn

Before the study can launch, it must be reviewed by your IRB and either be approved, or considered exempt from human subjects research guidelines.

irbExpiresOn

The last date that the IRB’s review is considered up-to-date for this study.

irbDecisionType

irbProtocolName

The name of the protocol as it was submitted to the IRB for approval.

irbProtocolId

An identification number for the study that has been assigned by the IRB.

studyLogoUrl

An URL to a logo for the study.

colorScheme

institutionId

An identification number for the study that has been assigned by the sponsor or institution running the study.

scheduleGuid

The GUID of the schedule to use for this study. NOTE: this is temporary, and will be replaced with a model of the study protocol that can include multiple arms in the study.

keywords

Free text that can be used in searches to locate studies.

diseases

A list of the diseases that are the subject of this study.

studyDesignTypes

The type of study (e.g. observational, interventional, etc.).

signInTypes

contacts

deleted

Has this study been logically deleted (an admin can restore it)?

createdOn

The date and time the study was created.

modifiedOn

The date and time the study was last modified.

version

The optimistic locking version of the study. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring. It can also serve as a key to determine if a local cache of this Study revision needs to be updated.

type

Study

Constructors

Study

constructor(identifier: String, name: String, phase: StudyPhase, version: Long, details: String? = null, clientData: JsonElement? = null, irbName: String? = null, irbDecisionOn: String? = null, irbExpiresOn: String? = null, irbDecisionType: IrbDecisionType? = null, irbProtocolName: String? = null, irbProtocolId: String? = null, studyLogoUrl: String? = null, colorScheme: ColorScheme? = null, institutionId: String? = null, scheduleGuid: String? = null, keywords: String? = null, diseases: List<String>? = null, studyDesignTypes: List<String>? = null, signInTypes: List<SignInType>? = null, contacts: List<Contact>? = null, deleted: Boolean? = null, createdOn: String? = null, modifiedOn: String? = null, type: String? = null)