TOPICA Basic Class Record

Table

DataDictionaryTable

The table the record belongs to.

Type

String

The StructureType defined in The Structure File

The TOPICA framework does not use this value for anything when generating Data Dictionary, i.e. the value does not have any influence on the dynamically generated database tables.

The value is used in the "Search Patient" dialog to group tables in logical groups. The user may optionaly display records belonging to tables having specified structure types. For example: the Data Dictionary may contain several tables, that all describe "encounters".

Equivalent to Table.Type

TableName

String

The table name specified in DataName in The Structure File - this is also the name of the dynamically generated database table.

Equivalent to Table.TableName

Caption

String

The caption specified in property Caption in The Structure File and hence saved in the Data Dictionary.

Equivalent to Table.Caption

Id

Integer

Internal ID of the record. Guaranteed to be unique in each table. Autogenerated (incremented) upon insertion in database table.

The key of a record is (TableName, Id).

DateCreate

DateTime

The system date/time when the record was created.

DateUpdate

DateTime

The system date/time when the record was LAST updated.

DateDelete

DateTime

4.31+

Date/time for logical deletion - null if NOT logically deleted.

Deleted

Boolean

4.31+

Whether the record is logically deleted.

DeletedByEmployee (alias DeletedBy)

Employee

4.31+

The employee user that logically deleted this record.

DateStart

DateTime

The value of the DATE_START column in the database table.

The value of this field is set whenever a record (form instance) is created or updated according to this algorithm:

• If a DateStart computation is defined (in The Structure File), this computation is evaluated, and if the result has type DateTime, this value is used - else:

• If one (and only one) DateTime field in the form has been marked as "DateStart", the value of this field is used - else:

• The minimum value (i.e. earliest date/time value) of all DateTime fields in the form is used.

DateStop

DateTime

The value of the DATE_STOP column in the database table.

This value is automatically set to the current system date/time when a record is closed.

Closed

Boolean

The value of the STATUS_CLOSED column in the database table.

Closed status.

Completed

Boolean

The value of the STATUS_COMPLETE column in the database table.

Completed status.

Value true means, that all fields with FillInStatus not equal to "Optional" have been filled in (i.e. no fields are empty), AND that no errors or warnings were generated by any validation rule.

CreatedByEmployee

Obsolete alias: CreatedBy

Employee

The employee user that created this record - will be null if it was a logged in patient, that created the record.

UpdatedByEmployee

Obsolete alias: UpdatedBy

Employee

The employee user that last updated this record - will be null if the record has not been updated since it was created, or it was a logged in patient, that last updated the record.

EmployeeUser

Obsolete alias: User

Employee

If the record was last touched by a logged in employee, this property contains the employee user that last touched this record - i.e. equal to UpdatedByEmployee if the record has been updated, otherwise equal to CreatedByEmployee

record.EmployeeUser = if(IsNotNull(record.UpdatedByEmployee), record.UpdatedByEmployee, record.CreatedByEmployee)

CreatedByPatient

Patient

4.24+

The patient user that created this record will be null if it was a logged in patient, that created the record.

UpdatedByPatient

Patient

4.24+

The patient user that last updated this record - will be null if the record has not been updated since it was created, or it was a logged in employee, that last updated the record.

PatientUser

Patient

4.24+

If the record was last touched by a logged in patient, this property contains the patient user that last touched this record - i.e. equal to UpdatedByPatient if the record has been updated, otherwise equal to CreatedByPatient

record.PatientUser = If(IsNotNull(record.UpdatedByPatient), record.UpdatedByPatient, record.CreatedByPatient)

Patient

Patient

4.30+

The patient to which the record belongs.

There is a global variable Patient (holding the patient in context), and a record is nomally only handled when the patient that "owns" the record is in context. In most cases Record.Patient = Patient. So why is Record.Patient needed?

Because it is possible to "customize" values of fields when records are "merged" from one patient to another (by using the SetValueOnCopy property, that may be specified on all form elements generating fields in the database). Merging two patients involves copying records from one patient to another. Field values in records are per default copied unchanged. But in some situations field values should NOT be just copied (they should be set to a new fixed or computed value). The SetValueOnCopy property may hold a TOPICA Basic expression - whn this is presnet, it is valuated, and the result will be the field value in the copied record.

During the "merge" operation there are 2 patients involved:

• Record refers to the "source" record (where data is copied FROM).

• It follows that Record.Patient refers to the "source" patient (the patient data is copied FROM).

• Patient refers to the "destination" patient (the patient data is copied TO).

For an example - see demo application DemoPatientMerge.

OrgUnit

OrgUnit

NOTE:

ParentRecord

Record

The "parent" record in the Patient Record Tree

Will be null if the record is directly below the root (= Patient).

SubRecords

RecordCollection

All subrecords (= "child" records) below this record.

RelationsFrom

RecordRelationCollection

4.24+

All relations from this record to any other records.

RelationsTo

RecordRelationCollection

4.24+

All relations to this record from any other records.

XXX (whatever)

Any

If the record contains a field with field name XXX (specified by DataName in the form) the value of this field is returned.

Type of the result obviously depends on the type of field.

Caution

Note that since a configured field with DataName="XXX" is accessed with the syntax Record.XXX, you should not use any of the "fixed" property names for your configured fields. If, for example, you configured a field with DataName = "OrgUnit", you would not be able to get the value of that field in TOPICA Basic, as Record.OrgUnit would return the data owner of the record, not the value of your field "OrgUnit".