Age_Decimal

The age of a patient in years (1 decimal place).

AgeInYears

The age of a patient in years (whole numbers).
constraints: value >= 0

AgeInYears

The age of a patient in years-weeks-days.
A negative value indicates "in utero".

DurationMinutes

The value of a time span in minutes.
constraints: value >= 0

Height

Patient height (cm)
Min value = 0
Max value = 300

NowOrPastDate

The current date/time or a date/time in past.
format: see date-time format
constraints: date/time >= date of birth AND date/time <= current date/time.

NowOrPastDateForOffers

The current date/time or a date/time in past.
format: see date-time format
constraints: date/time <= current date/time.

NowOrInitialInfusionDate

The current date/time or a date/time in past.
format: see date-time format
constraints: date/time >= date of the Initial Infusion date/time AND date/time <= current date/time.

NowOrAllocationDate

The current date/time or a date/time in past.
format: see date-time format
constraints: date/time >= date/time of the IPOS Allocation AND date/time <= current date/time.

NationalId

The CTR2 nationalId is an alphanumeric representation of the patientId:
It consists of a 6 digit leading zeros formatted string of the patientId number, prefixed with "CTR" for recipiens or "CTD" for DWL donors.

For example:
A recipient with patientId = 1; the nationalId string is formatted as: CTR000001
A donor with patientId = 123; the nationalId string is formatted as: CTD000123

Output Data Type

The class/field is used only to output returned values. It is not used as a method input parameter.

Pack Year History Of Smoking

Min value = 1
Max value = 100

SERUM_CREATININE

Recipient serum creatinine post transplant,(mmol/L).
Min value = 1
Max value = 9999

System Calculated Value

The field is set by the system. Any field value input will be silently ignored. Typically these fields represent values such as field updated date-time stamps, calculated values etc..

Weight

Patient weight (kg)
Min value = 0
Max value = 700

WsPatient

patientType> TBD...

Ws_DTO

- rules that apply to all WS DTOs( data transfer object ), unless specifically stated otherwise.

id field

id value:
id == null OR == 0 : indicates a transient object that is not associated with a database record.
id > 0 : indicates the DTO is associated with a database record.
id < 0 : is illegal.

add/update record method behavior:
The input "id" field value affects the behavior of methods that adds or updates DB records:
If ( the value of id == 0 ) : the method will add a new record.
ElseIf ( the value of id > 0 ) : the method will update the existing record.
Else (the value of id < 0 ) : illegal value, the method will throw an error.

id field notNull

id value:
id == 0 : indicates a transient object that is not associated with a database record.
id > 0 : indicates the DTO is associated with a database record.
id < 0 : is illegal.

add/update record method behavior:
The input "id" field value affects the behavior of methods that adds or updates DB records:
If ( the value of id == 0 ) : the method will add a new record.
ElseIf ( the value of id > 0 ) : the method will update the existing record.
Else (the value of id < 0 ) : illegal value, the method will throw an error.

patientId field

The field represents the numeric part of the CTR "NationalId" identifier.
The patientId field is a system returned value field.
On input, if the patientId field is set, the input value will be ignored ( except for XSD data type validation ).

collectionDate field

The sample/result collection date and time.
format: see Xml date/time format.
constraints: the date/time >= the date of birth AND the date/time <= than the current date/time.

dateUniqueInSet constraint

A date/time field of an object, the said object being part of a collection, is constrained to be unique within the collection.

Free format text, max L="Huge"

constraints: The text is saved as a "CLOB" and has a maximum size of (4 GB - 1).

Free format text, max L=25

constraints: The text has a maximum length of 25 characters.

Free format text, max L=50

constraints: The text has a maximum length of 50 characters.

Free format text, max L=70

constraints: The text has a maximum length of 70 characters.

Free format text, max L=100

constraints: The text has a maximum length of 100 characters.

Free format text, max L=200

constraints: The text has a maximum length of 200 characters.

Free format text, max L=500

constraints: The text has a maximum length of 500 characters.

Free format text, max L=1000

constraints: The text has a maximum length of 1000 characters.

Free format text, max L=2000

constraints: The text has a maximum length of 2000 characters.

Free format text, max L=8000

constraints: The text has a maximum length of 8000 characters.

XmlDateTime

format without time zone: "YYYY-MM-DD" where:
YYYY indicates the year
MM indicates the month
DD indicates the day
Note: time zone offset
- can specify an offset from the UTC time by adding a "Z" behind the date: 2002-09-24Z
- or by adding the time zone "+hh:mm" or "-hh:mm" offset behind the date:
2002-09-24-06:00 or 2002-09-24+06:00
see:www.w3schools.com-xsd-schema_dtypes_date, Time Zones.

XmlDateTime

format without time zone: "YYYY-MM-DDThh:mm:ss" where:
YYYY indicates the year
MM indicates the month
DD indicates the day
T indicates the start of the required time section
hh indicates the hour
mm indicates the minute
ss indicates the second
Note: All components are required see:www.w3schools.com-xsd-schema_dtypes_date, DateTime data type.

format with time zone offset specified: "YYYY-MM-DDThh:mm:ss-hh:mm" where:
YYYY indicates the year
MM indicates the month
DD indicates the day
T indicates the start of the required time section
hh indicates the hour
mm indicates the minute
ss indicates the second
time zone offset:
+ or -
hh indicates the hour offset
mm indicates the minute offset
Note: All components are required see:www.w3schools.com-xsd-schema_dtypes_date, Time Zones.