getCompletedCycle( )

Retrieve the number of cycles that were completed by a subject.

Syntax

getCompletedCycle(visitShortName)

Parameters

visitShortName

The branch short ID for the branch you are querying for.

Return value

Returns the number of cycles where the visit is in the Completed status (number) or -1 if visitShortName is not a cycle visit.

Note:

If the branch name is changed between study versions, use the isStudyVersion( ) function to get the appropriate name.

Example 3-99 If 3 cycle visits for a subject have been completed, set value of a dynamic form launch item to true

if (getCompletedCycle("Vitals") == 3) {
  return setChoiceLabel("TRUE");
} else {
  return setChoiceLabel("FALSE");
}