Generally, users want to know the data collected for different/ particular collection protocols based on different criterias. E.g., Saliva Samples from Male participants, Participants that are turning 18, Samples from the participants that have consented, etc.
OpenSpecimen reporting modules help the users to search within or across collection protocols and various criteria to get the required results.
Training Video
Who can access the Query?
- By default Super and Institute Admins have access to query
- Users with the role of Create, Update, Delete, Import, Export Query privileges can access the Query.
Features
| Features | Description |
|---|---|
| Create new queries | Create queries based on fields across standard, custom forms, and fields with complex expressions (AND, OR, NOT, intersection, hierarchical, and parenthesis). See: Sample queries |
| Get counts (pivot tables) | Run the queries to get the count of participants and specimens that match the filters. |
| Get raw data | Run queries to get raw data from the system. See: Query Results view |
Save query | Save query so that it can be reused for later use. |
| Folders and sharing | Saved queries can be organized in folders and shared with other users. E.g., 2-3 users are working on shortlisting specimens for a project can share the same set of queries. See: Share queries |
| Privileges | Data is filtered as per the user's privileges. E.g., if the user does not have PHI access, the patient identifier fields will be hidden. Access to the Query module can be controlled using the Query privilege. |
| Data export (CSV) | Data from the query results view can be exported as a CSV file. |
| Custom fields and forms | The custom forms and field added via form builder is available for querying the reports. |
| Calculated fields | Difference between two dates (e.g., age at the collection, warm ischemia time, etc.) |
| Hierarchical queries | To support queries like, show any DNA aliquot whose parent specimen's "warm ischemia time" is less than x minutes. |
| Import and Export queries | One can import and export queries from one instance to another—E.g., test server to production server. |
| Aggregate functions | Supports functions like sum, max, min, etc. |
| Dashboards | Create visually appealing dashboards with graphs and numeric counters based on query results. |
Default Queries
| Query | Description |
|---|---|
| Cart specimens report query | Saved query to use for generating cart specimens report |
| Container specimens report query | Saved query to use for generating container specimens report |
| Distribution order data query | Saved query to use for creating distribution report when DP specific report is not configured |
| Shipment report query | Saved query to use for exporting shipment details |
| Specimen kit report query | Saved query to use for exporting specimen kit details |