The custom forms can be attached at different levels for data entry. Forms attached at the custom form level, such as participant, visit, or specimen level, will appear in the ‘forms’ tab. Meanwhile, forms attached at the custom field level, for example, specimen custom fields or container custom fields, will appear on the overview pages.
Users can attach forms at three different levels:
System level
Individual level
Collection Protocol Group level
You will only be able to see those custom form levels for which you can create associations.
Forms attached at the system level apply to every collection protocol, container, and user across all institutes within the system.
Only the Super Admin can attach forms at this level.
There are two type of associations where the form can be attached at system level
Direct Attachment at the System Level:
Certain associations allow forms to be attached directly at the system level, such as collection protocol custom fields. This approach ensures that the form is accessible across all collection protocols within the system.
Click here to view the steps with example
Select 'Forms' from the navigation menu or the home screen.
Navigate to the form overview page and click on 'Associations'
![Attach1.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach1.png?version=6&modificationDate=1723859458362&cacheVersion=1&api=v2&width=1276&height=461)
Click on 'Add'
![Attach2.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach2.png?version=6&modificationDate=1723859477363&cacheVersion=1&api=v2&width=1276&height=390)
Select the ‘Collection protocol Custom Field’ level from the dropdown and click on 'Add'
![Attach3.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach3.png?version=3&modificationDate=1723858839732&cacheVersion=1&api=v2&width=1276&height=302)
At All Present and Future Collection Protocols:
There is other type of association where users can choose the option ‘All Present and Future Collection Protocols’ when linking the form. This setting ensures the form is automatically applied to both existing and future collection protocols in the system.
Click here to see the steps
Navigate to the form overview page and click on 'Associations'
![Attach1.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach1.png?version=6&modificationDate=1723859458362&cacheVersion=1&api=v2&width=1276&height=461)
Click on 'Add'
![Attach2.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach2.png?version=6&modificationDate=1723859477363&cacheVersion=1&api=v2&width=1276&height=390)
Select the ‘Registration Form’ level from the dropdown, select 'All Present and Future Collection Protocols' and click on 'Add'
![Attach second after 4.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach%20second%20after%204.png?version=2&modificationDate=1723632057354&cacheVersion=1&api=v2&width=1276&height=355)
Forms can be attached to individual collection protocols and to the users.
These attachments override any system-level or Collection Protocol Group (CPG) level associations.
Users with form access can attach forms at this level.
Click hee to see the steps
Navigate to the form overview page and click on 'Associations'
![Attach1.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach1.png?version=6&modificationDate=1723859458362&cacheVersion=1&api=v2&width=1276&height=461)
Click on 'Add'
![Attach2.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach2.png?version=6&modificationDate=1723859477363&cacheVersion=1&api=v2&width=1276&height=390)
Select the ‘Registration Form' and select the name of the 'Collection Protocol’ from the dropdown.
![attach first after4.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/attach%20first%20after4.png?version=2&modificationDate=1723632913116&cacheVersion=1&api=v2&width=953&height=331)
Users can create a CPG and attach a common form that will be used for data entry across all collection protocols within that group.
Form attached at a collection protocol group overrides system level association
Click to view the steps
Navigate to the CPG and click on the 'Forms' tab
![Attach17.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach17.png?version=3&modificationDate=1723867558896&cacheVersion=1&api=v2&width=1276&height=484)
Select participant/visit/specimen where you want to attach the form.
If you wish to attach the form at the ‘Custom Field' level, click on the 'Add’ button beside it.
![Attach18.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach18.png?version=3&modificationDate=1723867595519&cacheVersion=1&api=v2&width=1276&height=557)
![Attach19.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach19.png?version=3&modificationDate=1723867608138&cacheVersion=1&api=v2&width=1276&height=562)
If you wish to attach the form at the ‘CustomForm' level, click on the ‘Add’ button present beside 'Forms’ title.
![Attach20.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach20.png?version=3&modificationDate=1723633866110&cacheVersion=1&api=v2&width=1276&height=309)
![Attach21.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach21.png?version=3&modificationDate=1723633952760&cacheVersion=1&api=v2&width=1276&height=320)
The customs forms can be attached at different levels according to the type of data entry.
Click to view the levels and description
Level | Description |
---|
Participant Forms | Forms linked at the participant level will be available under all the CPs. Data entered at the 'Participant' level will be available under all CPs the participant is registered to. E.g., If P1 is registered under CP1 and CP2, 'Participant Contact Details' entered for P1 under CP1 will also be available under CP2. Forms added at this level will be available under the forms tab for that participant.
|
Registration Forms | For CP-specific participant forms. E.g., 'Smoking history', which might only be required under Lung Cancer Protocol. Forms added at this level will be available under the forms tab on the participant form page. |
Specimen Array Event | To add custom fields to the 'add event page' of the array. Multiple forms can be attached at this level. While adding an event, click the dropdown button in the event field to select the form. |
Specimen Event | Add ‘custom events’ to describe different stages of a specimen life cycle, e.g., Nano-drop event. Refer to the wiki page for more details. |
Specimen Forms | Forms linked to this level will be available under the forms tab of any collected specimens of the attached CP. |
Specimen Slide Event | To add custom fields on the add event page for the slide. Multiple forms can be attached at this level. While adding an event, click the dropdown button in the event field to select the form. |
User Forms (New in v8.0) | To add forms at the ‘User’ level. The forms can be added to capture training records, and so on. Refer to the wiki page for more details. |
Visit Forms | Forms linked to this level will be available under the forms tab of any occurred visit of the attached CP. |
Collection Protocol Custom fields | To add custom fields on the ‘create collection protocol"’page. E.g., 'IRB document', 'CTRI number.' |
Container Custom Fields | To add custom fields on the ‘create container page’. E.g., 'Vendor name.' |
DP Requirements Custom Fields | To add custom fields on the ‘create DP requirements page’. E.g., 'Specimen quality.' |
Distribution Protocol Custom Fields | To add custom fields on the create distribution protocol page. E.g. 'Grant Number' |
Order Custom Fields | The forms can not be attached using 'Association' option from the form page. It can be attached either at the system level or the Distribution Protocol level. Refer to Adding custom fields to Order level for more details. |
Project Custom Fields | To add custom fields on the ‘create new project page’. E.g., Instructions |
Registration Custom Fields | To add custom fields on the ‘participant registration page’. E.g.'Marital Status', 'Age' etc. |
Service Request Custom Fields | To add custom fields to the ‘create request page’ of a project. E.g., Requestor Notes |
Site Custom Fields | To add custom fields to ‘create site page’. E.g., 'Site phone number'. |
Specimen Array Event | To add custom fields to the ‘add event page’ of the array. Multiple forms can be attached at this level. While adding an event, click the dropdown button in the event field to select the form. |
Specimen Custom Fields | To add custom fields to the ‘main collect specimen page’. E.g., 'Processing Site', 'Tube Type' etc. |
Visit Custom Fields | To add custom fields to the main visit page, e.g.,' Primary Diagnosis.' |
For forms attached at Participant Forms, Visit Forms, Specimen Forms, Registration Forms levels, you can edit the form. For example, the form can have a single record or multiple records.
You can directly delete the attachment from different levels when there is no data present related to that form
Click to view the steps
Follow these steps ONLY when there is no data present in the forms or in a case where the data need not be preserved. Otherwise, deleting the attachment level leads to the deletion of related data.
Deleting an attachment level leads to the deletion of the data related to those forms. In this case, the data needs to be preserved, and then the form can be reattached to another level. You can follow the below steps:
Case 1: Changing the attachment level from ALL to single/multiple CP
Click to view the steps
Go to the Collection Protocol list page → More → Export.
![Attach9.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach9.png?version=2&modificationDate=1723866060897&cacheVersion=1&api=v2&width=1171&height=324)
2. Select the name of the form in 'Record Type' and click on 'Export'. A CSV file containing the form records will be exported.
![Attach10.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach10.png?version=2&modificationDate=1723866075333&cacheVersion=1&api=v2&width=1195&height=344)
3. Navigate to the 'Associations' from the form overview page
![Attach11.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach11.png?version=2&modificationDate=1723866085413&cacheVersion=1&api=v2&width=1195&height=339)
![Attach12.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach12.png?version=2&modificationDate=1723866095564&cacheVersion=1&api=v2&width=1195&height=349)
4. Add the new attachment level and click on 'Done.'
5. Go to the exported form records CSV (exported in step 2) in any text editor.
6. Remove the first column (Identifier) and save the file.
If the new attachment level added was CP specific,
Navigate to that CP’s patient list view page
Click ‘More’
Select ‘Biospecimen Data’.
If the new attachment level added was not CP specific
Nanigate to the Collection Protocols list page
Click ‘More’
Select 'Biospecimen Data'.
![Attach13.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach13.png?version=2&modificationDate=1723866500910&cacheVersion=1&api=v2&width=1171&height=299)
7. Select the form name from the 'Record Type' dropdown and click on 'Validate and Import.'
![Attach14.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach14.png?version=2&modificationDate=1723866513106&cacheVersion=1&api=v2&width=1195&height=395)
Case 2: Changing the attachment level from single/multiple CP to ALL
Click to view the steps
Navigate to CP's participant list page, to which the form is attached, click on 'Export.'
![Attach15.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach15.png?version=2&modificationDate=1723866671384&cacheVersion=1&api=v2&width=1171&height=289)
2. Select the form name from the 'Record Type' dropdown and click on 'Export.'
![Attach16.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/Attach16.png?version=2&modificationDate=1723866683592&cacheVersion=1&api=v2&width=1195&height=281)
3. Repeat steps 3 to 6 from Case 1.
.
Some data for the forms like test results, surveys, etc., might have to be collected multiple times. To do this, check the ‘Multiple records allowed’ checkbox while attaching a form at a particular level.
Click to view the screenshot
The notifications can be sent to the users regarding adding/editing form records. You can also add form data in the notification.
Click to view the steps
While adding association, select ‘Send Notification’
![form notification 1.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/form%20notification%201.png?version=3&modificationDate=1722941513149&cacheVersion=1&api=v2&width=1171&height=492)
Select the user group from the ‘Notification Recipient' dropdown and click on 'Add’
![form notification 2.png](https://openspecimen.atlassian.net/wiki/download/thumbnails/1767473311/form%20notification%202.png?version=2&modificationDate=1722941532121&cacheVersion=1&api=v2&width=1171&height=496)
Note: The notifications are only sent to the User Groups and not to the individual users.