Posted on April 7, 2021
This RAMS Gif Guide is intended for researchers and research teams using the RAMS-IRB system to manage IRB submissions. This guide will walk users through the steps in RAMS-IRB necessary to manage documents, including adding, removing, and updating documents. At the end of this post are general document management tips.
You can access more RAMS Gif Guides by using the RAMS Gif Guides tag on our blog.
To add new documents to an IRB submission, navigate to any page within the Smartform that contains a document upload section, such as the Documents page, the Background, Rationale and Goals page, or the Study Procedures page.
Then, click the “Add” button in the document upload section. In the pop-up window that appears, enter a name for the document in question #1, click the drop-down menu in question #2 and select the type of document, and then click the “Choose File” button in question #3. This will open a dialogue on your computer where you can navigate to the document you wish to upload, click the document, and then click “open” within the dialogue window. Finally, in the pop-up window, click “OK” to upload the document to the submission. [View Image]
Alternatively, you can drag and drop a file from your computer into the text entry field in question #3 of the pop-out window, instead of clicking the “Choose File” button and navigating to the document that way.
Either way, once “OK” is selected in the pop-up window, you will see the new document entry appear in the documents list on the Smartform page.
Often during IRB review, documents are edited by IRB reviewers, or changes to documents are requested. When this happens, you will need to update the currently-uploaded document to add the new version. This is accomplished by updating a currently-uploaded document entry, rather than creating an entirely new document entry.
When a document is updated, the old version is retained, but is hidden “underneath” the most recent version of the document. Because all versions of a document live in a single place, this process is sometimes called “stacking,” because the new version of the document is placed “on top” of older versions. This allows the IRB to retain a record of past versions of documents, while avoiding having too many individual documents uploaded to a submission.
To update a document, first navigate to a Smartform page that contains a document upload section. Locate the document you wish to update, and click the “Update” button. [View Image]
In the pop-up window that appears, in question #3, you will see the current version’s file name. Underneath that file name is the space to upload a new version. Either click “Choose File” and navigate to the new version of the document within the file finder, or drag and drop the file from your computer to the text field in question #3. Once you’ve selected the new version of the document, click the “OK” button in the pop-up window. You will see that under the “Version” column of the document upload section, the number has changed from 0.01 to 0.02, to indicate that multiple versions of that document exist within that document entry. [View Image]
To view a document’s history to see all versions of an uploaded document, navigate to any page in the Smartform that contains a document upload section. First, click “Update” next to the document whose history you wish to view. Then, in the pop-up window, click the small clock icon next to the file’s name in question #3. This will open another pop-up window where you can view all versions of that document that have been uploaded. [View Image]
Often during IRB review, a reviewer may upload a revised version of a document during their review, and may instruct you to download that revised version to make further edits. This is common with consent forms in particular.
To download the most recent version of a document, navigate to any Smartform page with a document upload section, locate the document you wish to download, and click “Update.” In the pop-up window, click the hyperlinked file name under question #3. This will open a dialogue on your computer prompting you to open or save the document. [View Image]
To download previous versions of a document, navigate to any Smartform page with a document upload section, locate the document you wish to download, and click “Update.” In the pop-up window, click the small clock icon next to the file’s name in question #3 to open the history of the document. In the new pop-up window, click on the hyperlinked file name of the previous version you wish to download. This will open a dialogue on your computer prompting you to open or save the document. [View Image]
All of the previous examples of document management are done within the Smartform. You can also access your submission’s documents from the study’s workspace using the “Documents” tab. Click the “Documents” tab in the study’s workspace, and scroll down to view all of the documents uploaded to your study. [View Image]
You can also view the history of documents and download documents from this tab. To do so, click the “View” link next to the document you wish to view or download. [View Image]
From there, you can click the hyperlinked document name to download the most recent version of that document, or click the small clock icon next to the document’s name to access the document’s history, where you can download a previous version the same way as demonstrated above.
You cannot add documents from the Documents tab, but you may view and download them from that tab.
It is important to understand that you should never delete a document from your study unless the study is in development, or — if the study is under review — the reviewer explicitly instructs you to delete a document.
When documents are retired or revised, we do not want to lose the history of that document, so deletion should only be used when you are explicitly instructed to do so by IRB staff or reviewers.
To delete a document, navigate to any page in the Smartform that contains a document upload section. Locate the small button with an X on it on the far right side of the document upload entry. Click that button, and then confirm the deletion by clicking “OK” in the dialogue that appears asking if you’re sure you wish to delete the document. [View Image]
Deleting a document entry line will delete ALL versions of the uploaded document. There is no way to delete individual versions of documents. This is why it is critical to only delete documents when explicitly instructed to do so.
Here are some general tips for managing your documents both within RAMS-IRB and within your own study files.