protocol

Study protocols: the definition of how a study is run.

A StudyProtocol describes why, when and what data should be collected, without depending on any sensor technology or app. It combines devices, tasks, triggers and measures from the common subsystem. Protocols are managed through a ProtocolService and deployed with a DeploymentService.

Main types: StudyProtocol, ProtocolVersion, ProtocolService and ProtocolFactoryService.

See the carp.protocols definition in Kotlin.

Classes

• Add — An RPC request for ProtocolService.add.
• AddVersion — An RPC request for ProtocolService.addVersion.
• CreateCustomProtocol — An RPC request for ProtocolFactoryService.createCustomProtocol.
• DeviceConnection — A connection from a connected device to a primary device in a StudyProtocol.
• GetAllForOwner — An RPC request for ProtocolService.getAllForOwner.
• GetBy — An RPC request for ProtocolService.getBy.
• GetVersionHistoryFor — An RPC request for ProtocolService.getVersionHistoryFor.
• ProtocolFactoryService — Factory methods to create a StudyProtocol according to predefined templates.
• ProtocolService — Application service which allows managing (multiple versions of) StudyProtocols.
• ProtocolServiceRequest — An abstract RPC request to a ProtocolService.
• ProtocolVersion — Specifies a specific version for a StudyProtocol, identified by a tag.
• StudyProtocol — A description of how a study is to be executed.
• UpdateParticipantDataConfiguration — An RPC request for ProtocolService.updateParticipantDataConfiguration.