Summary

This article defines the instruction observationRelativeToReferencePeriod.

Table of Contents

• Instruction observationRelativeToReferencePeriod
  • Overview
    • Unknown Output
  • Question Id
  • Value
  • Input value
  • Variables
  • Examples

Instruction observationRelativeToReferencePeriod

Overview

This instruction can make an observation determination regarding the reference period. This requires that the reference period is configured correctly. Property or parameter “referencePeriodStart” needs to specify the question, where the start of the reference period is recorded. Property or parameter “referencePeriodEnd” needs to specify the question, where the end of the reference period is recorded. This method returns the following possible values:

• AFTER, when the date of the question is after the reference period.
• BEFORE, when the date of the question is before the reference period.
• DURING, when the date of the question is between the start and the end of the reference period.
• DURING/AFTER, when the date of the question is known to be after the beginning of the reference period.
• U, when the relationship between the date of the question and the reference period is unknown.
• ONGOING, when (1) there is no date specified for the observation date question and (2) an ongoing question is set in a variable and (3) a “yes value” for the ongoing question is set in a variable and (4) the “yes value” is selected for the ongoing question.

Unknown Output

A return value of “U” can result from this instruction under any of the following conditions:

• If the observation date cannot be successfully parsed to a partial date and the ongoingQst does not have a value equal to the ongoingYes value.
• If both the referencePeriodStart and referencePeriodEnd cannot be retrieved or parsed to a partial date.
• If the referencePeriodStart cannot be retrieved or parsed to a partial date but the referencePeriodEnd can and the referencePeriodEnd is logically the same or after the observation date.

Question Id

Required. Question path to a date question where an observation should be determined relative to the reference period.

Value

Input value

Variables

This instruction can be customized with the help of (cell) variables.

• ongoingQst – Store a question here. This question might be used, when there is an ongoing question that can be used to specify that a date point has not been reached yet, but is ongoing. Example: AE has not ended, but is still ongoing. This can only be used with the “ongoingYes” variable.
• ongoingYes – required, if ongoingQst is filled. The value of this variable is the choice for ongoingQst that specifies the ongoing state.

Examples

With this instruction observation determination for question “mheddtc” is made and as additional information, the ongoing question “mhcontin” is set, which would be set to “1″, if it is still ongoing.

Need more help?

Please visit the Fountayn Contact Information page.