openEHR Foundation Types specification

Abstract supertype. Usually maps to a type like Any or Object in an object-oriented technology. Defined here to provide value and reference equality semantics.

Value equality.

Reference equality.

Create new instance of a type.

Type name of an object as a string. May include generic parameters, as in "Interval<Time>".

Class representing minimal interface of standard Boolean type.

Logical conjunction

Boolean semi-strict conjunction with other

Boolean disjunction with other.

Boolean semi-strict disjunction with `other'.

Boolean exclusive or with `other'.

Boolean implication of `other' (semi-strict)

Involutive_negation: is_equal (not (not self))

Non_contradiction: not (self and (not self))

Completeness: self or else (not self)

Abstract notional parent class of ordered, types i.e. types on which the ‘<‘ operator is defined.

Arithmetic comparison. In conjunction with ‘=’, enables the definition of the operators ‘>’, ‘>=’, ‘<=’, ‘<>’. In real type systems, this operator might be defined on another class for comparability.

Strings of characters, as used to represent textual data in any natural or formal language.

Concatenation operator - causes ‘other’ to be appended to this string.

True if string is empty, i.e. equal to "".

True if string can be parsed as an integer.

Return the integer corresponding to the integer value represented in this string.

Abstract notional parent class of numeric types, which are types which have various arithmetic and comparison operators defined.

Product by `other'. Actual type of result depends on arithmetic balancing rules.

Sum with `other' (commutative). Actual type of result depends on arithmetic balancing rules.

Result of subtracting `other'. Actual type of result depends on arithmetic balancing rules.

Abstract notional parent class of ordered, numeric types, which are types with ‘<‘ and arithmetic operators defined.

Class representing minimal interface of standard Integer type.

Class representing minimal interface of standard Integer64 type.

Type used to represent decimal numbers. Corresponds to a single-precision floating point value in most languages.

Return the greatest integer no greater than the value of this object.

Abstract ancestor of container types whose items are addressable in some way.

Test for membership of a value.

Number of items in container.

True if container is empty.

Ordered container that may contain duplicates.

Return first element.

Return last element.

First_validity: not is_empty implies first /= Void

Last_validity: not is_empty implies last /= Void

Unordered container that may not contain duplicates.

Container whose storage is assumed to be contiguous.

Type representing a keyed table of values. V is the value type, and K the type of the keys.

Test for membership of a key.

Return item for key a_key'.

Interval abstraction, featuring upper and lower limits that may be open or closed, included or not included. Interval of ordered items.

Lower bound. lower bound.

Upper bound. Upper bound.

lower boundary open (i.e. = -infinity). lower boundary open (i.e. = -infinity)

upper boundary open (i.e. = +infinity). upper boundary open (i.e. = +infinity)

lower boundary value included in range if not lower_unbounded. lower boundary value included in range if not lower_unbounded.

upper boundary value included in range if not upper_unbounded. upper boundary value included in range if not upper_unbounded.

True if (lower_unbounded or lower_included and v >= lower) or v > lower and (upper_unbounded or upper_included and v <= upper or v < upper). True if (lower_unbounded or lower_included and v >= lower) or v > lower and (upper_unbounded or upper_included and v <= upper or v < upper)

True if there is any overlap between intervals represented by Current and `other'. True if at least one limit of other is strictly inside the limits of this interval.

True if current interval properly contains other? True if all points of other are inside the current interval.

True if current object’s interval is semantically same as other.

Lower_included_valid: lower_unbounded implies not lower_included

Upper_included_valid: upper_unbounded implies not upper_included

Limits_consistent: (not upper_unbounded and not lower_unbounded) implies lower <= upper

Limits_comparable: (not upper_unbounded and not lower_unbounded) implies lower.strictly_comparable_to (upper)

Type representing an Interval that happens to be a point value. Provides an efficient representation that is substitutable for Interval<T> where needed.

lower boundary open (i.e. = -infinity)

upper boundary open (i.e. = +infinity)

lower boundary value included in range if not lower_unbounded.

upper boundary value included in range if not upper_unbounded.

Inv_point: lower = upper

Type representing a 'proper' Interval, i.e. any two-sided or one-sided interval.

Inv_not_point: lower /= upper

An Interval of Integer, used to represent multiplicity, cardinality and optionality in models.

Marker to use in string form of interval between limits.

Symbol to use to indicate upper limit unbounded.

True if this interval imposes no constraints, i.e. is set to 0..*.

True if this interval expresses optionality, i.e. 0..1.

True if this interval expresses mandation, i.e. 1..1.

True if this interval is set to 0..0.

Express constraints on the cardinality of container objects which are the values of multiply-valued attributes, including uniqueness and ordering, providing the means to state that a container acts like a logical list, set or bag.

The interval of this cardinality.

True if the members of the container attribute to which this cardinality refers are ordered.

True if the members of the container attribute to which this cardinality refers are unique.

True if the semantics of this cardinality represent a bag, i.e. unordered, non-unique membership.

True if the semantics of this cardinality represent a list, i.e. ordered, non-unique membership.

True if the semantics of this cardinality represent a set, i.e. unordered, unique membership.

Definitions for date/time classes. Note that the timezone limits are set by where the international dateline is. Thus, time in New Zealand is quoted using +12:00, not -12:00.

Used for conversions of durations containing months to days and / or seconds.

Used for conversions of durations containing years to days and / or seconds.

Minimum hour value of a timezone (note that the -ve sign is supplied in the ISO8601_TIMEZONE class).

True if d >= 1 and d <= days_in_month (m, y)

True if (h >= 0 and h < Hours_in_day) or (h = Hours_in_day and m = 0 and s = 0)

True if m >= 0 and m < Minutes_in_hour.

True if s >= 0 and s < Seconds_in_minute .

True if fs >= 0.0 and fs < 1.0 .

String is a valid ISO 8601 date, i.e. takes the complete form:

Where:

The combinations of YYYY, MM, DD numbers must be correct with respect to the Gregorian calendar.

String is a valid ISO 8601 date, i.e. takes the form:

with an additional optional timezone indicator of:

Where:

String is a valid ISO 8601 date-time, i.e. takes the form:

String is a valid ISO 8601 duration, i.e. takes the form:

Where each nn represents a number of years, months, etc. nnW represents a number of 7-day weeks.

Note: allowing the W designator in the same expression as other designators is an exception to the published standard, but necessary in clinical information (typically for representing pregnancy duration).

Where each nn represents a number of years, months, etc. nnW represents a number of 7- day weeks.

Abstract ancestor of time-related classes.

Abstract ancestor type of ISO 8601 types, defining interface for 'extended' and 'partial' concepts from ISO 8601.

Representation of all descendants is a single String.

True if this date time is partial, i.e. if trailing end (right hand) value(s) is/are missing.

True if this ISO8601 string is in the 'extended' form, i.e. uses ‘-’ and / or ‘:’ separators. This is the preferred format.

Represents an ISO 8601 date, including partial and extended forms. Value may be:

See Time_definitions.valid_iso8601_date() for validity.

Year.

Month in year.

Day in month.

Timezone; may be Void.

Indicates whether month in year is unknown. If so, the date is of the form "YYYY".

Indicates whether day in month is unknown. If so, and month is known, the date is of the form "YYYY-MM" or "YYYYMM".

True if this date is partial, i.e. if days or more is missing.

True if this date uses '-' separators.

Return string value in extended format.

Year_valid: valid_year (year)

Month_valid: not month_unknown implies valid_month (month)

Day_valid: not day_unknown implies valid_day (year, month, day)

Partial_validity: month_unknown implies day_unknown

Represents an ISO 8601 time, including partial and extended forms. Value may be:

See valid_iso8601_time() for validity.

Hour in day, in 24-hour time.

Minute in hour.

Second in minute.

Fractional seconds.

Timezone; may be Void.

Indicates whether minute is unknown. If so, the time is of the form “hh”.

Indicates whether second is unknown. If so and month is known, the time is of the form "hh:mm" or "hhmm".

True if this time has a decimal part indicated by ‘,’ (comma) rather than ‘.’ (period).

True if this time is partial, i.e. if seconds or more is missing.

True if this time uses ‘-’, ‘:’ separators.

True if the fractional_second part is signficant (i.e. even if = 0.0).

Return string value in extended format.

Hour_valid: valid_hour(hour, minute, second)

Minute_valid: not minute_unknown implies valid_minute (minute)

Second_valid: not second_unknown implies valid_second (second)

Fractional_second_valid: has_fractional_second implies (not second_unknown and valid_fractional_second (fractional_second))

Partial_validity: minute_unknown implies second_unknown

Represents an ISO 8601 date/time, including partial and extended forms. Value may be:

See valid_iso8601_date_time() for validity.

Note that this class includes 2 deviations from ISO 8601:2004:

Year.

Month in year.

Day in month.

Hour in day.

Minute in hour.

Second in minute.

Fractional seconds.

Timezone; may be Void.

Indicates whether month in year is unknown.

Indicates whether day in month is unknown.

Indicates whether minute in hour is known.

Indicates whether minute in hour is known.

True if this time has a decimal part indicated by ‘,’ (comma) rather than ‘.’ (period).

True if this date time is partial, i.e. if seconds or more is missing.

True if this date/time uses ‘-’, ‘:’ separators.

True if the fractional_second part is signficant (i.e. even if = 0.0).

Return the string value in extended format.

Year_valid: valid_year (year)

Month_valid: valid_month (month)

Day_valid: valid_day(year, month, day)

Hour_valid: valid_hour (hour, minute, second)

Minute_valid: not minute_unknown implies valid_minute(minute)

Second_valid: not second_unknown implies valid_second (second)

Fractional_second_valid: has_fractional_second implies (not second_unknown and valid_fractional_second (fractional_second))

Partial_validity_year: not month_unknown

Partial_validity_month: not month_unknown

Partial_validity_day: not day_unknown

Partial_validity_hour: not hour_unknown

Partial_validity_minute: minute_unknown implies second_unknown

Represents an ISO 8601 duration, which may have multiple parts from years down to seconds. Value is in format:

Number of seconds.

Fractional seconds.

True if this time has a decimal part indicated by ',' (comma) rather than '.' (period).

Returns False.

Returns True.

Number of months.

Number of years of nominal 365-day length.

Number of 7 day weeks.

Total number of seconds equivalent (including fractional) of entire duration.

Number of 60 second minutes.

Number of 60 minute hours.

Number of 24 hour days.

Return the duration string value.

Years_valid: years >= 0

Months_valid: months >= 0

Weeks_valid: weeks >= 0

Days_valid: days >= 0

Hours_valid: hours >= 0

Minutes_valid: minutes >= 0

Seconds_valid: seconds >= 0

Fractional_second_valid: fractional_second >= 0.0 and fractional_second < 1.0

ISO8601 timezone string, in format:

where:

Hour part of timezone - in the range 00 - 13.

Minute part of timezone. Generally 00 or 30.

Direction of timezone expresssed as +1 or -1.

Indicates whether minute part known.

True if this time zone is partial, i.e. if minutes is missing.

True if this time-zone uses ‘:’ separators.

True if timezone is UTC, i.e. +0000.

Return timezone string.

Min_hour_valid: sign = -1 implies hour > 0 and hour <= Min_timezone_hour

Max_hour_valid: sign = 1 implies hour > 0 and hour <= Max_timezone_hour

Minute_valid: not minute_unknown implies valid_minute (minute)

Sign_valid: sign = 1 or sign = -1

Leaf type representing a term from a terminology, which consists of the term text and the code, i.e. a concept reference.

Refrence to the terminology concept formally representing this term.

Text of term.

Logically primitive type representing a reference to a terminology concept, in the form of a terminology identifier, optional version, and a code or code string from the terminology.

The archetype environment namespace identifier used to identify a terminology. Typically a value like "snomed_ct" that is mapped elsewhere to the full URI identifying the terminology.

Optional string value representing terminology version, typically a date or dotted numeric.

A terminology code or post-coordinated code expression, if supported by the terminology. The code may refer to a single term, a value set consisting of multiple terms, or some other entity representable within the terminology.

The URI reference that may be used as a concrete key into a notional terminology service for queries that can obtain the term text, definition, and other associated elements.

Type representing a function with a return type and 0 or more arguments represented as a TUPLE.

Type representing a function with a return type and 0 or more arguments represented as a TUPLE.

Type representing a procedure with 0 or more arguments represented as a TUPLE.

Parent type of all TUPLE types.

A Tuple type used, among other things, for representing a single typed argument within a Routine signature.

A Tuple type used, among other things, for representing two typed arguments within a Routine signature.