Table of Contents

Info
Info: Attribute names, functions, and operators are auto-completed once you start to type in the temporal expression window.

Demonstration of a Temporal Query:

...

Temporal functions

Expand

title	Click here to view functions...

Function

Description

months_between

To find the number of months between two dates. Example: month between registration date and visit date

minutes_between

To find the number of minutes between two timestamp fields. Example: time difference between frozen and received time

years_between

To find the number of years between two dates. Example: age at collectionThese functions can be used as below as wella) Days = minutes_between(d1, d2) / (24 * 60)
b) Hours = minutes_between(d1, d2) / 60
c) Weeks = minutes_between(d1, d2) / (7 * 24 * 60)

current_date()

To get current date. Example: age as of today

round()

To round up calculations. In cases where integer values are expected, for example, temporal expressions related to dates, round() function ensures that stable integer results are obtained.
Usage: round(expression, x)
Here, the expression is the integer value result that is to be rounded. 'x' is the number of decimal places to be rounded up to or the number of digits after the decimal point that the expression should be rounded to.Example: round( years_between( current_date(), Participant.dateOfBirth), 0) any will keep 0 digits after decimal.

date_range(date, range_type, [interval])

Allows to check for data that falls in the particular date range.

date: can be any form field or arithmetic expression whose result is of date type
range_type: possible values are
- last_cal_qtr: last calendar quarter
- next_cal_qtr: next calendar quarter (new in v6.1)
- last_qtr: last quarter
- next_qtr: next quarter (new in v6.1)
- last_cal_month: last calendar month
- next_cal_month: next calendar month (new in v6.1)
- last_month: last month
- next_month: next month (new in v6.1)
- last_week: last calendar week (new in v4.0)
- next_week: next calendar week (new in v6.1)
- current_week: this week (new in v4.0)
- last_days: last N calendar days (new in v4.0)
- next_days: next N calendar days (new in v6.1)
- yesterday: yesterday's calendar date. Special form of last_days where N = 1
- tomorrow: tomorrow's calendar date. Special form of next_days where N = 1 (new in v6.1)
- today: today's calendar date (new in v4.0)
interval: a positive integer. Optional. When not specified, its value is assumed as 1

date_format(date_expr, format)

Outputs date/time field/expression value in desired format.

date_expr: Any valid AQL expression that yields date/time type result
format: Format of the output string and can be made up of following format specifier tokens.

Values in examples of below table are given w.r.t date/time 18th January 2017 16:45:33

date_format(Participant.regDate, "%month_day% %month3% %year4%") > "18 Jan 2017"

Only those participants registered after 18 JAN 2017 will be displayed in the desired format. Similarly, you can use the other operators like < , = etc

Specifier	Description	Example
%year4%	Four digit year	2017
%year2%	Two digit year	17
%month2%	Two digit month	01
%month3%	Three character abbreviation of month name	Jan
%month%	Month name string	January
%month_day%	Two digit day of month	18
%hour%	Hour of the day in 24 hour format 00-23	16
%hour12%	Hour of the day in 12 hour format 01-12	04
%minute%	Minute of the hour	45
%second%	Seconds of the minute	33
%meridian%	AM or PM	PM

...

Expand

title	Click here to view examples...

Example 1: Age as of today

Note
Note: If the "date of birth" value is blank for the participant, the query results would be blank.

Example 2: Age at collection

Note

Note:

This expression only works for "parent (New)" specimens.
If the "date of birth" value is blank for the participant, the query results would be blank.

Temporal Expression: "years_between( Specimen.extensions.SpecimenCollectionEvent.time, Participant.dateOfBirth) any"

Example 3: Age at collection

Note

Note:

This expression works for specimens at any level (New, Derived, and Aliquot).
If the "date of birth" value is blank for the participant, the query results would be blank.

Temporal Expression: "years_between( Specimen.spmnCollRecvDetails.collTime, Participant.dateOfBirth) any"

Example 4: Time difference between frozen and received time

Example 5: Tissue specimens collected in the last 2 months

Example 6: Calculating the sample amount

Example 7: Count of specimens collected per month

Example 8: Count of specimens collected after a particular date

Example 9: Age in years (rounded off)

Example 10: Number of participants enrolled and parent samples entered per week.

Result view:

Note
Note: Select the count of participant and primary specimen in 'Aggregates' column to view the count in the result view.

Example 11: Finding percent from 2 numbers in custom form

In the above example, number1 and number2 are two numeric fields defined in a form attached at 'Registration Forms' level. There is no % function in temporal queries, but the formula to find percent can directly used to calculate the same.

Example 12: Calculating the initial cell value from the volume processed and initial concentration, where the volume processed and initial concentration are specimen custom fields.

In the above expression,

aj_specimen_form is the variable name of the custom form.
initial_processing_volume and initial_cell_volume are the variable names of the volume processed and initial concentration custom fields.

Example 13: Average of 2 custom fields.

In the above expression,

'skin_cancer_registration_custom_field_form' is the variable name of the form name.
‘number_field_1' and 'number_field_2’ are variable names of the custom fields.
The CP (e.g. 'Skin Cancer Study') must be selected, for custom forms and fields.

...

Versions Compared

Old Version 47

New Version 48

Key

Temporal functions

Page Comparison

Versions Compared

Old Version 47

New Version 48

Key

Temporal functions