ISRecallObjective.GetHelpInfo

Description

This function returns information about the selected care plan objective intended for the patient's use.

Syntax

object.GetHelpInfo()

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

Return Value

ISHelpInfo

Returns the information about the selected care plan objective intended for the patient's use.

Example

Display the information about the selected care plan objective intended for the patient's use.

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

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 Name: '" &_
      aObjective.DisplayName & "'" 
    set aHelpInfo = aObjective.GetHelpInfo
    if aHelpInfo is nothing then
      aMessage = aMessage & vbNewLine & "    No patient info!" & vbNewLine
    else
      aMessage = aMessage & vbNewLine & "    Patient Info: " &_
        Profile.Rtf2Plain(aHelpInfo.GetBody)
    end if    
  next  
next

Profile.MsgBox(aMessage)  
Note: The information is presented in read-only form. The source of this information is the Patient Info tab of the service (if any) upon which this objective is based.

In Profile Client v8 on User Interface Help Info can be found in Clinical > Care Plans > Open active objective > Patient Info.

Version information

Added in v7.8.0