Solution
From the use cases that listed in this document, we list the summary of the solution below:
- The ACT has a way to manage requests for datasets under ACTAccessRequirement. We need to support the following:
- Ability to view Submitted requests for a particular dataset. Allowing the ACT to see all information and quickly decide if the request contains the required information.
- Ability to approve a request and grant access to all accessors.
- Ability to reject a request, provide the instructions on how to correct/provide the missing information, and send email to requestor.
- The ACT has a way to configure the ACTAccessRequirement to indicate the required information, if the data set requires annual renewal, and if the intended data use statement should be public.
- A requestor has a way to create a request, save it, and submit it to ask for access to a dataset under ACTAccessRequirement.
- A requestor will be able to correct the old request and submit it after the old submission was rejected. They would not need to type/ provide any correct information that they already provided in the old submission.
- A requestor will be able to remove an accessor from his/her approved request. This action takes away the accessor's access to the dataset.
- The system automatically sends annual review reminder emails to accessors.
- An accessor will be able to provide the required information for the annual review process to keep their access to the dataset.
- An accessor will be able to provide the final statement of use when they no longer need to access the controlled data.
We recognize the needs to support #1 - #7 in the first phase. From the ACT, we haven't had users come back to us with a final statement of use, so #8 would have low priority.
Object Models
ACTAccessRequirement |
---|
(original fields) |
String instruction |
Boolean isCertifiedUserRequired |
Boolean isValidatedProfileRequired |
Boolean isDUCRequired |
String ducTemplateFileHandleId |
Boolean isIRBRequired |
Boolean areAttachmentsRequired |
Boolean isAnnualReviewRequired |
Boolean isIDUPublic |
ResearchProject |
---|
String id |
String accessRequirementId |
String institution |
String projectLead |
String intendedDataUseStatement |
String ownerId |
String createdBy |
Long createdOn |
Long modifiedOn |
Any user can create a ResearchProject. To create a ResearchProject, the following information are required: accessRequirementId, institution, projectLead, intendedDataUseStatement, ownerId, and createdBy. The following fields: id, createdOn, and modifiedOn are set by the system. A user will not be able to change these values.
After a ResearchProject is created, only the owner can make changes to a ResearchProject. The owner can also change the ownership of a ResearchProject by changing the ownerId value to another userId that has been granted access to the dataset under the same ResearchProject.
DataAccessRequest implements DataAccessRequestInterface |
---|
String id |
String accessRequirementId |
String createdBy |
Long createdOn |
String researchProjectId |
List<String> accessors |
String ducFileHandleId |
String irbFileHandleId |
List<String> attachments |
Long modifiedOn |
Any user can create a DataAccessRequest to a given AccessRequirement. To create a DataAccessRequest, the following fields are required: accessRequirementId, and createdBy. The following fields: id, createdOn, and modifiedOn are set by the system. A user cannot change these values.
Only creator of DataAccessRequest can update, and submit the request. To submit a request, it has to meet the requirements specified in the associated AccessRequirement.
Once a request is submitted, a DataAccessSubmission object is created. While there is an DataAccessSubmission with status SUBMITTED, it's associated DataAccessRequest no longer available for update & submit.
DataAccessRenewal implements DataAccessRequestInterface extends DataAccessRequest |
---|
String publication |
String summaryOfUse |
Once a DataAccessSubmission is approved and requestor wants to add/ remove accessors, he/she needs to update the request with a DataAccessRenewal, given the publication and summaryOfUse in addition to editing the existing information from the original DataAccessRequest.
Submitting a DataAccessRenewal will also result in a DataAccessSubmission being created with status SUBMITTED.
DataAccessSubmission |
---|
String id |
String dataAccessRequestId |
String requestorId |
Long submittedOn |
ResearchProject researchProjectSnapshot |
List<String> accessors |
Boolean isRenewalSubmission |
String ducFileHandleId |
String irbFileHandleId |
List<String> attachments |
String publication |
String summaryOfUse |
State state (SUBMITTED, APPROVED, REJECTED, CANCELED) |
String reviewerId |
Long reviewedOn |
String rejectedReason |
Once a DataAccessSubmission is created, it will have state SUBMITTED until a reviewer (ACT member) review and update its status.
After a submission is Rejected and a reason is provided, the submission is closed for modification.
When an ACT member approves a submission, multiple AccessApproval are created for each accessor.
When a requestor adds/removes a user, he/she will also need to update the request and create a new submission. An ACT member will review the new submission and make decision to grant/revoke access to the accessor.
Services
Action | Intended User | URI | Method | Request Params | Request Body | Response Body | |
---|---|---|---|---|---|---|---|
1 | create a ResearchProject | SynapseUser | /researchProject | POST | ResearchProject | ResearchProject | |
2 | retrieve a ResearchProject | owner | /accessRequirement/{id}/researchProject | GET | ResearchProject | ||
3 | update a ResearchProject | owner | /researchProject | PUT | ResearchProject | ResearchProject | |
4 | transfer ownership of a ResearchProject | owner, ACT | /researchProject/{id}/updateOwner | PUT | ResearchProject | ResearchProject | |
5 | create a DataAccessRequest | Synapse User | /dataAccessRequest | POST | DataAccessRequest | DataAccessRequest | |
6 | retrieve a DataAccessRequest | creator | /accessRequirement/{id}/dataAccessRequest | GET | DataAccessRequestInterface | ||
7 | update a DataAccessRequest | creator | /dataAccessRequest | PUT | DataAccessRequestInterface | DataAccessRequestInterface | |
8 | submit a DataAccessRequest | creator | /dataAccessSubmission | POST | DataAccessRequestInterface | SubmissionStatus | |
9 | retrieve a list DataAccessSubmission's status | requestor | /accessRequirement/{id}/submissionStatus | GET | SubmissionStatus | ||
10 | cancel a DataAccessSubmission | requestor | /dataAccessSubmission/{id}/cancel | PUT | DataAccessSubmission | ||
11 | update a DataAccessSubmission | ACT | /dataAccessSubmission | PUT | SubmissionStatusChangeRequest | DataAccessSubmission | |
12 | retrieve a list of DataAccessSubmission | ACT | /accessRequirement/{id}/listSubmission | GET | nextPageToken, filter (by status) | DataAccessSubmissionPage |
Notification
Condition | Target User | Notes | |
---|---|---|---|
1 | After a new submission is created | ACT member | Includes link to a page that manages the dataset's access requests |
2 | After a submission is approved | Requestor | Includes link to view request |
3 | After a submission is rejected | Requestor | Includes reason Includes link to create a new request from the rejected one |