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

ConsentStatus

@Serializable

data class ConsentStatus(val name: String? = null, val subpopulationGuid: String? = null, val required: Boolean? = null, val signedOn: String? = null, val consented: Boolean? = null, val signedMostRecentConsent: Boolean? = null, val type: String? = null)

A description of the participant's consent status in a particular subpopulation (consent group). This object is never used to update state on the server (all fields are read only).

Parameters

name

The name of the subpopulation.

subpopulationGuid

The GUID for the subpopulation of this consent.

required

Is this consent required? If required, the user must consent to it before being given access to the server (until signed, a 412 response is returned for most participant endpoints).

signedOn

The date and time the referenced consent was signed and agreed to by the participant. If there is a signedOn value, consented will be equal to true.

consented

Has the participant consented to this consent agreement? If the user has signed this consent, there should be a signedOn timestamp value.

signedMostRecentConsent

Was the consent to participate made against the most recently published version of this consent? If there's no signature this will be false (not null).

type

ConsentStatus

Constructors

ConsentStatus

constructor(name: String? = null, subpopulationGuid: String? = null, required: Boolean? = null, signedOn: String? = null, consented: Boolean? = null, signedMostRecentConsent: Boolean? = null, type: String? = null)