Scenario

Bridge exports participant health data to Synapse. In order to understand the data, we need to associate documentation with Synapse studies data types.

Milestone 1: Model Health Data Documentation, stored in S3, indexed in DynamoDB. Create APIs for create, read, update, and delete functionalities. Links to Jira issues: model, APIs.

Milestone 2: Automatically write documentation to the appropriate Synapse wiki(s)

Milestone 3: Study Manager: Health Data Documentation Page

Design

DynamoDB

We want to create a new class called DynamoHealthDataDocumentation with the following attributes:

• title (String)

• parentId (hash key, String)

  • Initially, this will be the same as appId. In the future, for study-scoped documentation, it would be “{appId}:study:{studyId}” and for Assessments it would be “{appId}:assessment:{assessmentId}”.

• identifier (range key, String)

• version (Long)

• s3Key documentation (String)

  • this will be capped at 100 KB of data, as the maximum data size in DynamoDB is 400 KB.

• createdBy (String)

• createdOn (DateTime)

• modifiedOn (DateTime)

• modifiedBy (String)

API