Click or drag to resize
TOPICA Basic Class RecordRelation

[This is preliminary documentation and is subject to change.]

The RecordRelation class models one relation between two records (objects of the Record class).

Caution note Caution

This class only exists in TOPICA relases 4.24 and newer!

Currently (release 4.24), RecordRelation objects are created (by the TOPICA framework) to log "copy" and "move" operations. However, RecordRelation objects may be use for any type of relation between records (implemented in lateer releases of the framwwork and/or for configuration specific purposes).

A RecordRelation is directed, i.e. there is a "from" record and a "to" record.

As each Record object has a relation to a Patient object, there is also the concept of "from" and "to" patient. These may be the same (as the result of a normal "copy" operation), or they may be different (a "merge" operation, merging data from one patient to an other, is implemented as a number of "copy" operations from the source patient to the destination patient).

RecordRelation properties

Property

Type

Description

ToString

String

String representation (or debugging etc.).

CreatedAt

CreatedDateTime

DateTime

Timestamp - the date and time this RecordRelation object was created

EmployeeUser

Employee

The logged in employee user performing the action - null if patient was logged in.

PatientUser

Patient

The logged in patient user performing the action - null if employee was logged in.

RelationType

DateTime

String defining type of relation (e.g. what operation initiated creation of this object). May currently have the values "Copy" or "Move".

FromPatient

Patient

The "from" patient.

FromPatientId

Integer

Id of the "from" patient.

Equivalent to FromPatient.Id.

FromTableName

String

Table name of the "from" record.

FromRecordId

Integer

Record id of the "from" record.

Equivalent to FromRecord.Id.

FromRecord

Record

The "from" record.

ToPatient

Patient

The "to" patient.

ToPatientId

Integer

Id of the "to" patient.

Equivalent to ToPatient.Id.

ToTableName

String

Table name of the "to" record.

ToRecordId

Integer

Record id of the "to" record.

Equivalent to ToRecord.Id.

ToRecord

Record

The "to" record.

See Also