Query for anticipated visits/specimens

The anticipated visits/specimens query is designed for planned participant centric studies. This query will not work for any specimen centric protocol since there are no events or specimen requirements configured on the basis of which the query works.

Based on collection protocol time points, it is now possible to query for anticipated visits and specimens for planned collections. For example, query for expected specimens for participants of a protocol in next week. OpenSpecimen ships a default job and query for anticipated visits and specimens which set to run on demand. The job can be run for the desired CPs since all CPs may not be planned.

By default, the job to calculate the anticipated visits is “On Demand”, you can choose to make the job run at frequent intervals.
Users requiring anticipated visit data must request that the System Administrator enable it for their Collection Protocol (CP).
The System Administrator updates the scheduled job "Refresh anticipated specimens" to include the CP ID (comma-separated values).
Anticipated visits data is not available unless the scheduled job runs at least once after the CP is added.

Configuring Job

Log in as a super administrator user and navigate to 'Jobs'.
Click on the edit option of the 'Refresh anticipated specimens' scheduled job.

Include the collection protocol ID for which query on anticipated visits/specimens is to be enabled. The list of CPs is configured by specifying comma-separated CP ID values.

The system administrators can configure the job to run every night or every hour, depending on the needs of their users

Running query

After the CP is configured and the computation is done at least once, the CP users can start querying anticipated visits using the default query 'Anticipated visits in next month'.
In the image below, the user is interested in knowing the list of participants whose visits are due in the next months

Select the required columns under the node Participant -> Anticipated Specimens in the columns view
Query results will then display the list of anticipated visits and pending primary specimens to be collected from patients in the next 3.5 months.

Disable the wide rows option from columns configuration, this will ensure the anticipated visits and specimens are not displayed in one row for each participant on the results view.