ISContact.Annotation

Description

The encounter contact annotation.

Syntax

object.Annotation( [cRichText = false])

Part Attribute Type Description
object Required
The object always implements the ISContact interface
cRichText In, Optional
Default value is false
bool
The text in the RTF format
Restriction: This property is readonly.

Return Value

string

Example

Display some information about the contacts of patient's encounters, including the annotations.

Dim aPatient        
Dim aFilter              
Dim aEncounters, aEncounter
Dim i, j
Dim aMessage
Dim aContact

Set aPatient = Profile.SelectPatient 
set aFilter = Profile.CreateEncounterFilter
aFilter.PatientId = aPatient.ID                 
set aEncounters = aPatient.LoadEncounters(aFilter)
                                                                 
aMessage = "Encounters Count = " & aEncounters.Count

for i = 0 to aEncounters.Count - 1
  set aEncounter = aEncounters.Item(i)              
  aMessage = aMessage & vbNewLine & (i + 1) & ". " &_
    "Date: " & aEncounter.Date & vbNewLine &_                            
    "Date Created: " & aEncounter.DateCreated & vbNewLine &_
    "Pos Code: " & aEncounter.PosCode & vbNewLine &_
    "Provider Code: " & aEncounter.ProviderCode & vbNewLine &_
    "Service Code: " & aEncounter.ServiceCode & vbNewLine &_
    "Type Description: " & aEncounter.TypeDescription & vbNewLine

  if aEncounter.Contacts.Count <> 0 then
    for j = 0 to aEncounter.Contacts.Count -1
      set aContact = aEncounter.Contacts.Item(j)
      aMessage = aMessage & "      Contact" & vbNewLine &_ 
        "    - Date: " & aContact.Date & vbNewLine &_
        "    - Annotation (Plain): " & aContact.Annotation(False) & vbNewLine &_
        "    - Annotation (RTF): " & aContact.Annotation(True) & vbNewLine        

    next
  end if                 
next 
                                          
Profile.MsgBox(aMessage)  
Note:

In Profile Client v8 on User Interface Annotation can be found in Clinical > Medical Record > Encounters > Open Encounter > Notes.

Version information

Added in v7.8.0