ISRecallObjective.IsHold

Description

This property is True if the care plan objective is on hold.

Syntax

object.IsHold

Part Attribute Type Description
object Required
The object always implements the ISRecallObjective interface

Return Value

bool

Example

Display IsHold for the care plan objective.

Dim aPatient
Dim aRecallPlans
Dim aMessage
Dim aPlan
Dim i
Dim aObjectives
Dim aObjective

Set aPatient = Profile.SelectPatient
set aRecallPlans = aPatient.RecallPlans

if aRecallPlans.Count = 0 then
  Profile.MsgBox("The patient has no care plans!")
  exit sub
end if

for each aPlan in aRecallPlans
  set aObjectives = aPlan.RecallObjectives
  aMessage = aMessage & "PLAN: '" & aPlan.Description & "'" & vbNewLine
  
  if aObjectives.Count = 0 then
    aMessage = aMessage & "  NO OBJECTIVES" & vbNewLine
  end if  
         
  for i = 0 to aObjectives.Count - 1
    set aObjective = aObjectives.Item(i)
    aMessage = aMessage & "  OBJECTIVE:" & vbNewLine &_
      "      Name: '" & aObjective.DisplayName & "'" & vbNewLine &_
      "      Objective on hold: " & aObjective.IsHold & vbNewLine  
  next  
next

Profile.MsgBox(aMessage)  
Note:

In Profile Client v8 on User Interface the Objective on hold checkbox can be checked in Clinical > Care Plans > Open active objective > Timing.

Version information

Added in v7.8.0