Click or drag to resize

TOPICA Basic Class Patient

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

The Patient class models patients.

Notes that "patient" may be labelled something else in the user interface. That does not have any influence on the Patient class, however.

Patient properties

Property

Type

Version

Description

Id

Integer

Internal ID of patient

NationalIdDisplay

Alias: NationalId

Obsolete aliases: CPR, CPRnr

String

(see note)

NationalId in display format (as displayed in user interface)

National id is labeled differently depending on the country (culture):

Country

Description

Denmark

CPR-nummer

Sweden

Personnummer

UK

NHS id

USA

Social Security Number

NationalIdInternal

Obsolete alias: CPRInternal

String

(see note)

National person identification in INTERNAL format (as stored in database).

FirstName

String

First name

LastName

String

Last name

Name

String

Concatenation of FirstName and LastName. The following expressions are equivalent:

Patient.Name
Patient.FirstName + " " + Patient.LastName

NationalIdName

Obsolete aliases: CPRName

String

(see note)

Concatenation of NationalIdDisplay, FirstName and LastName. The following expressions are equivalent:

Patient.NationalIdName
Patient.NationalIdDisplay + " " + Patient.Name
Patient.NationalIdDisplay + " " + Patient.FirstName + " " + Patient.LastName

Sex

Integer

Values:

Integer value

Constant

Description

0

Sex_Undefined

Not dedetmined

1

Sex_Male

Male (man, boy)

2

Sex_Female

Female (woman, girl)

3

Sex_Undeterminable

Undeterminable

BirthDate

Date

Birthdate

Age

Integer

Age now

DeathDate

Date

Deathdate

IsDead

Boolean

Wheter patient is dead. The following expressions ar equivalent:

Patient.IsDead
IsNotNull(Patient.DeathDate)

AddressIsProtected (alias ProtectedAddress)

Boolean

4.31+

Whether address information is protected

Location

String

4.29+

Unstructured address information

AdditionalLocator

String

4.29+

Unstructured address information

Road

String

Road name

HouseNum

String

HouseNumber

FloorNumber, Floor

String

4.29+

Floor number

SideDoorNumber, SideDoor

String

4.29+

Side/door number

ZipNum

Integer

Zip number / postal code (numeric)

ZipText

String

Text derived from zip number / name of postal area / city

OrgUnit

OrgUnit

Primary national organizational unit for addresses (e.g. municipality).

PhoneJob

String

PhonePrivate

String

MobileJob

String

MobilePrivate

String

FaxJob

String

FaxPrivate

String

EmailJob

String

EmailPrivate

String

RecordRelations

TOPICA Basic Class RecordRelationCollection

4.24+

All record relations related to current patient.

RecordRelationsFrom

TOPICA Basic Class RecordRelationCollection

4.24+

All record relations FROM current patient.

RecordRelationsTo

TOPICA Basic Class RecordRelationCollection

4.24+

All record relations TO current patient.

Note Note

NationalIdDisplay and NationalId exist only in TOPICA version 4.23 and later.

In versions 4.22 and earlier, use one of the (now obsolete) aliases!