openEHR logo

openEHR Foundation Types specification

Issuer: openEHR Specification Program

Release: latest

Status: STABLE

Revision: [latest_issue]

Date: [latest_issue_date]

Keywords: openehr, identifiers, types

openEHR components
© 2017 - 2017 The openEHR Foundation

The openEHR Foundation is an independent, non-profit community organisation, facilitating the sharing of health records by consumers and clinicians via open-source, standards-based implementations.

Licence

image Creative Commons Attribution-NoDerivs 3.0 Unported. https://creativecommons.org/licenses/by-nd/3.0/

Support

Issues: https://openehr.atlassian.net/browse/SPECPR/
Web: http://www.openehr.org/

Amendment Record

Issue Details Raiser Completed

R E L E A S E     1.1.0

1.0.0

SPECBASE-15: Add foundation types specification to BASE component.

T Beale

08 Sep 2017

0.7.6

Re-organise heading structure. Remove references to ISO 11404. Rename to 'Foundation types';
added type cross-reference table.

T Beale

17 Aug 2017

0.7.5

Rework date/time types; addition of types IDate, IDate_time, ITime, IDuration. Added derived interval types.

T Beale

18 Jan 2017

0.7.0

Initial Writing. Taken from openEHR RM Release 1.0.3 Support Model

T Beale

20 May 2016

The Amendment history relevant to the original content in this specification can be found here (a fully hyper-linked version may be found on the working baseline).

Acknowledgements

Contributors

This specification has benefited from formal and informal input from the openEHR and wider health informatics community.

Trademarks

  • 'openEHR' is a registered trademark of the openEHR Foundation

1. Preface

1.1. Purpose

This document describes the openEHR Foundation Types, a collection of built-in and library types whose semantics are assumed by all other openEHR specifications.

The intended audience includes:

  • Standards bodies producing health informatics standards;

  • Research groups using openEHR, ISO 13606, archetypes and related technologies;

  • The open source healthcare community;

  • Solution vendors.

Prerequisite documents for reading this document include:

1.3. Status

This specification is in the STABLE state. The development version of this document can be found at http://www.openehr.org/releases/BASE/latest/foundation_types.html.

Known omissions or questions are indicated in the text with a 'to be determined' paragraph, as follows:

TBD: (example To Be Determined paragraph)

Users are encouraged to comment on and/or advise on these paragraphs as well as the main content. Feedback should be provided either on the technical mailing list, or on the specifications issue tracker.

1.4. Previous Versions

This specification is based on the types orginally defined in the openEHR Support Information Model from Release 1.0.3 of the Reference Model. Some changes have been made as follows.

1.4.1. Interval types

The additional types Point_interval and Proper_interval have been added, to support the common need for a point value and a proper interval to be specified as substitutable types. The types Multiplicity_interval and Cardinality have been added, from the AOM2 specification.

1.4.2. Date/Time types

The date/time types have been adjusted to provide a fully coherent model that accounts for 'native' types and the ISO 8601-based types, whose representation is a String. This involved the addition of notional types IDate, ITime etc, which define pure interfaces to both native and ISO 8601 date/time types.

In the original Support IM specification, only the ISO 8601 types were defined. The addition of so-called native types Date, Time, Date_time and Duration enables these types to be used in other specifications as standing for the native system types, for example in the AOM2 specification.

1.4.3. Functional meta-types

A collection of meta-types representing routines, procedures and functions has been added, to support specifications that need to use these concepts.

2. Overview

The openEHR Foundation Types (org.openehr.base.foundation_types package) consists of generic foundational types assumed by and used throughout the openEHR components and specifications. The types described here are specified in order to establish the names and minimal semantics of typical standard classes, as used by all other openEHR specifications, and to provide a mapping point into implementation technologies.

The set of types chosen here is based on a common set derived from various published sources, including:

  • ISO 8601 (2004) date/time specification;

  • Major interoperability formalisms, including OMG IDL, W3C XML-schema;

  • Major typed programming languages, including Java, C#, C++, etc.

The package structure is illustrated below.

BASE foundation types packages
Figure 1. org.openehr.base.foundation_types package structure

The primitive_types, structures and time packages describe types assumed by the openEHR specifcations to exist in any implementation technology, such as a programming language, schema language or database environment.

The functional package includes types enabling functional programming primitives to be expressed in the openEHR modelling environment, i.e. functions-as-objects and 'lambda' expressions.

The types are described in this specification are typically of two kinds: built-in types, which are those built in to a type system of the development language, and library types, which are assumed to be available in a (class) library defined in the formalism. Thus, the type Boolean is always assumed to exist in a formalism, while the type Array<T> is assumed to be available in a library. For practical purposes, these two categories do not matter too much - whether String is really a library class (the usual case) or an inbuilt type doesn’t make much difference to the programmer. They are shown separately here mainly as an explanatory convenience.

The assumptions that openEHR makes about existing types are documented below in terms of interface definitions. Each of these definitions contains only the assumptions required for the given type to be used in the openEHR Reference Model - it is not by any means a complete interface definition. The name and semantics of any function used here for an assumed type might not be identical to those found in some implementation technologies. Any mapping required should be stated in the relevant implementation technology specification (ITS). To give a concrete example, where the assumed Set<T> type defined below has an operation has (item: T): Boolean which is used throughout the openEHR specifications, Java has the method contains() on its Set<T> class. In a Java implementation, the contains() method should then be used throughout the openEHR classes as expressed in Java, in place of the has () method.

2.1. The Any Class

Within all object-oriented and most other modern programming and modelling environment exists an ultimate ancestor type to which all others conform. In this specification, we assume the type Any, which defines a bare minimum of operators, and stands for the real Any or Object type found in real technologies.

2.2. openEHR Leaf Types

The sections below provide formal definitions of all the foundation types used in openEHR. A subset of these can be understood as terminal or leaf types, typically used as terminal value types in other information models. The following diagram provides an aide memoire for the leaf types.

BASE foundation types leaf types
Figure 2. Leaf Types

2.3. Class Definitions

2.3.1. Any Class

Class

Any (abstract)

Description

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.

Functions

Signature

Meaning

is_equal (
other: Any[1]
): Boolean

Value equality.

infix = (
other: Any[1]
): Boolean

Reference equality.

other

Reference equality.

instance_of (
a_type: String[1]
): Any

Create new instance of a type.

type_of (
an_object: Any[1]
): String

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

3. Primitive Types

3.1. Overview

This section describes primitive types assumed by all openEHR models. These are types supported directly by most programing languages, and usually visible via either a class interface and/or a built-in raw value type. The following table lists the primitive types assumed by openEHR.

Type name
in openEHR
Description

Octet

a type whose value is an 8-bit value.

Character

a type whose value is a member of an 8-bit character-set (ISO: "repertoire").

Boolean

logical True/False values; usually physically represented as an integer, but need not be.

Integer

32-bit integers.

Integer64

64-bit integers.

Real

32-bit real numbers in any interoperable representation, including single-width IEEE floating point.

Double

64-bit real numbers, in any interoperable representation including double-precision IEEE floating point.

String

represents unicode-enabled strings.

The figure below illustrates these types. Simple inheritance relationships are shown which facilitate the type descriptions below. Actual inheritance from or subsitutability for an Any class is not assumed, and is shown only for convenience (e.g. to indicate that the '=' operator is available on any type). The type Ordered_numeric is on the other hand is used to indicate assumed substitutability of numeric types, and is intended to be mapped to an equivalent type in a real type system (e.g. in Java, java.lang.Number). Data-oriented implementation type systems such as XML-schema do not have such operations.

BASE foundation types.primitive types
Figure 3. foundation_types.primitive_types package

3.2. Unicode

It is assumed in the openEHR specifications that Unicode is supported by the type String. Unicode is needed for all Asian, Arabic and other script languages, for both data values (particularly plain text and coded text) and for many predefined string attributes of the classes in the openEHR Reference Model. It encompasses all existing character sets. In openEHR, UTF-8 encoding is assumed.

3.3. Class Definitions

3.3.1. Boolean Class

Class

Boolean

Description

Class representing minimal interface of standard Boolean type.

Inherit

Any

Functions

Signature

Meaning

infix and (
other: Boolean[1]
): Boolean
Post_de_Morgan: Result = not (not self or not other)
Post_commutative: Result = (other and self)

Logical conjunction

infix and_then (
other: Boolean[1]
): Boolean
Post_de_Morgan: Result = not (not self or else not other)

Boolean semi-strict conjunction with other

infix or (
other: Boolean[1]
): Boolean
Post_de_Morgan: Result = not (not self and not other)
Post_commutative: Result = (other or Current)
Post_consistent_with_semi_strict: Result implies (self or else other)

Boolean disjunction with other.

infix or_else (
other: Boolean[1]
): Boolean
Post_de_Morgan: Result = not (not self and then not other)

Boolean semi-strict disjunction with `other'.

infix xor (
other: Boolean[1]
): Boolean
Post_definition: Result = self or other) and not (self and other

Boolean exclusive or with `other'.

infix implies (
other: Boolean[1]
): Boolean
Post_definition: Result = (not self or else other)

Boolean implication of `other' (semi-strict)

Invariants

Involutive_negation: is_equal (not (not self))

Non_contradiction: not (self and (not self))

Completeness: self or else (not self)

3.3.2. Ordered Class

Class

Ordered (abstract)

Description

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

Inherit

Any

Functions

Signature

Meaning

infix < (
other: Ordered[1]
): Boolean

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.

3.3.3. Character Class

Class

Character

Description

Inherit

Ordered

3.3.4. Octet Class

Class

Octet

Description

Inherit

Ordered

3.3.5. String Class

Class

String

Description

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

Inherit

Ordered

Functions

Signature

Meaning

infix + (
other: String[1]
): String

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

is_empty (): Boolean

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

is_integer (): Boolean

True if string can be parsed as an integer.

as_integer (): Integer

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

3.3.6. Uri Class

Class

Uri

Description

Inherit

Any

3.3.7. Numeric Class

Class

Numeric (abstract)

Description

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

Inherit

Any

Functions

Signature

Meaning

infix * (
other: Numeric[1]
): Numeric

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

infix + (
other: Numeric[1]
): Numeric

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

infix - (
other: Numeric[1]
): Numeric

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

3.3.8. Ordered_Numeric Class

Class

Ordered_Numeric (abstract)

Description

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

Inherit

Ordered, Numeric

3.3.9. Integer Class

Class

Integer

Description

Class representing minimal interface of standard Integer type.

Inherit

Ordered_Numeric

3.3.10. Integer64 Class

Class

Integer64

Description

Class representing minimal interface of standard Integer64 type.

Inherit

Ordered_Numeric

3.3.11. Real Class

Class

Real

Description

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

Inherit

Ordered_Numeric

Functions

Signature

Meaning

floor (): Integer

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

3.3.12. Double Class

Class

Double

Description

Inherit

Ordered_Numeric

4. Structure Types

4.1. Overview

The types described in this section are basic data structures assumed to be standardly available in implementation technologies. The following types consititute the minimum set of structure types assumed by openEHR of an implementation environment.

Type name
in openEHR
Description

Array<T>

physical container of items indexed by number

List<T>

container of items, implied order, non-unique membership

Set<T>

container of items, no order, unique membership

Hash<K:Ordered, V>

a table of values of any type V, keyed by values of any Ordered descendant K, typically String or Integer, but may be more complex types, e.g. a coded term type.

The following UML diagram illustrates the foundation_types.structures package. As with the primitive types, inheritance and abstract classes are used for convenience of the definitions in openEHR models, but are not assumed to exist in exactly the same way within implementation technologies. Hence, in an implementation, various workarounds or equivalences may be needed to obtain the defined semantics.

BASE foundation types.structures
Figure 4. foundation_types.structures package

4.2. Class Definitions

4.2.1. Aggregate Class

Class

Aggregate (abstract)

Description

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

Inherit

Any

Functions

Signature

Meaning

has (
v: T[1]
): Boolean

Test for membership of a value.

count (): Integer

Number of items in container.

is_empty (): boolean

True if container is empty.

4.2.2. List Class

Class

List

Description

Ordered container that may contain duplicates.

Inherit

Aggregate

Functions

Signature

Meaning

first (): T

Return first element.

last (): T

Return last element.

Invariants

First_validity: not is_empty implies first /= Void

Last_validity: not is_empty implies last /= Void

4.2.3. Set Class

Class

Set

Description

Unordered container that may not contain duplicates.

Inherit

Aggregate

4.2.4. Array Class

Class

Array

Description

Container whose storage is assumed to be contiguous.

Inherit

Aggregate

4.2.5. Hash Class

Class

Hash

Description

Type representing a keyed table of values. T is the value type, and U the type of the keys.

Inherit

Aggregate

Functions

Signature

Meaning

has_key (
a_key: K[1]
): Boolean

Test for membership of a key.

item (
a_key: K[1]
): V

Return item for key a_key'.

5. Interval

5.1. Overview

Another kind of structure commonly needed in rich data is the interval. The definition of the Interval<T> class here is an intensional one, i.e. it states its members by implication from its limits, rather than enumerating them. To support the common need for defining times in models that could be either a fixed point in time or a time interval, the classes Point_interval<T> and Proper_interval<T> are provided. If Interval<X> is defined as the type of a feature in a class in an openEHR model, where X is some descendant of Ordered, then at runtime, either a Point_interval or Proper_interval may be attached.

In addition to the generic interval types, the derived types Multiplicity_interval and Cardinality are provided, for use in models to represent multiplicity, optionality, and cardinality.

The following UML diagram illustrates the foundation_types.interval package.

BASE foundation types.interval
Figure 5. foundation_types.interval package

5.2. Class Definitions

5.2.1. Interval Class

Class

Interval (abstract)

Description

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

Inherit

Any

Attributes

Signature

Meaning

0..1

lower: T

lower bound.

1..1

lower_unbounded: boolean

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

1..1

upper_unbounded: boolean

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

1..1

lower_included: boolean

lower boundary value included in range if not lower_unbounded.

1..1

upper_included: boolean

upper boundary value included in range if not upper_unbounded.

Functions

Signature

Meaning

has (
e
): boolean

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)

intersects (
other: Interval[1]
): Boolean

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.

contains (
other: Interval[1]
): Boolean

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

upper (): T

(effected)

is_equal (
other: Any[1]
): Boolean

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

Invariants

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)

5.2.2. Point_interval Class

Class

Point_interval

Description

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

Inherit

Interval

Attributes

Signature

Meaning

1..1
(redefined)

lower_unbounded: boolean

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

1..1
(redefined)

upper_unbounded: boolean

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

1..1
(redefined)

lower_included: boolean

lower boundary value included in range if not lower_unbounded.

1..1
(redefined)

upper_included: boolean

upper boundary value included in range if not upper_unbounded.

Functions

Signature

Meaning

(effected)

upper (): T

5.2.3. Proper_interval Class

Class

Proper_interval

Description

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

Inherit

Interval

Attributes

Signature

Meaning

0..1

upper: T

Upper bound.

5.2.4. Multiplicity_interval Class

Class

Multiplicity_interval

Description

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

Inherit

Proper_interval

Constants

Signature

Meaning

1..1

Multiplicity_range_marker: String = ".."

Marker to use in string form of interval between limits.

1..1

Multiplicity_unbounded_marker: char = '*'

Symbol to use to indicate upper limit unbounded.

Functions

Signature

Meaning

is_open (): Boolean

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

is_optional (): Boolean

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

is_mandatory (): Boolean

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

is_prohibited (): Boolean

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

5.2.5. Cardinality Class

Class

Cardinality

Description

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 cardinality cannot contradict the cardinality of the corresponding attribute within the relevant reference model.

Attributes

Signature

Meaning

1..1

interval: Multiplicity_interval

The interval of this cardinality.

1..1

is_ordered: Boolean

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

1..1

is_unique: Boolean

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

Functions

Signature

Meaning

is_bag (): Boolean

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

is_list (): Boolean

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

is_set (): Boolean

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

6. Time Types

6.1. Overview

Two packages of time types are defined in this specification: the foundation_types.time package and the foundation_types.iso8601_time package. The first group are assumed to be available within the implementation environment, and normally correspond to either built-in types or standard library classes. The second set are conrete types based on the ISO 8601 time standard, which supports partial dates, times, and complex durations, all of which are needed in the biomedical and clinical domains. These classes have a String physical representation, and also inherit from the IDate etc classes.

The two packages are shown below.

BASE foundation types.time
Figure 6. foundation_types.time and iso8601_time packages

6.2. Primitive Time Types

The classes in the foundation_types.time package are divided into interface classes IDate etc, and concrete primitive types Date, Time etc, which are assumed to have some 'native' data representation such as a long integer or similar. The separation is a clarifying device for this specification. It is not assumed that the classes IDate etc literally exist in a given implementation environment.

6.3. ISO 8601 Types

The set of ISO 8601 based types define dates and times with a String representation (as per ISO 8601), and the ISO 8601 'partial' and 'extended' semantics. They are defined as descendents of the native types described above, and add the necessary elements required for ISO 8601.

ISO 8601 semantics not used in these types include:

  • "expanded" dates, which have year numbers of greater than 4 digits, and may be negative; in openEHR, only 4-digit year numbers are assumed;

  • the YYYY-WW-DD method of expressing dates (since this is imprecise and difficult to compute with due to variable week starting dates, and not required in health);

  • partial date/times with fractional minutes or hours, e.g. hh,hhh or mm,mm; in openEHR, only fractional seconds are supported;

  • the interval syntax. Intervals of date/times are supported in openEHR, but their syntax form is defined by ADL, and is standardised across all comparable types, not just dates and times.

Deviations from the published standard include the following:

  • durations are supposed to take the form of PnnW or PnnYnnMnnDTnnHnnMnnS, but in openEHR, the W (week) designator can be used in combination with the other designators, since it is very common to state durations of pregnancy as some combination of weeks and days.

  • partial variants of Iso8601_date_time can include missing hours, days and months, whereas ISO 8601:2004 (section 4.3.3 c) only allows missing seconds and minutes. The reasons for this deviation are:

    • the same deviation is used in HL7v2 and HL7v3 TS (timestamp) type, i.e. there are data in existing clinical systems matching this specification;

    • in a typed object model, this deviation is more sensible anyway; the ISO 8601 rule is most likely a limitation of the purely syntactic means of expression. In real systems where a timestamp/date-time is specified in a screen form, it makes sense to allow it to be as partial as possible, rather than artifically restricted to only missing seconds and minutes.

  • the time 24:00:00 (or 240000) is not allowed anywhere, whereas in ISO 8601:2004 it appears to be legal at least for times. This deviation is also appears to be used in HL7v2 and HL7v3 (where midnight is defined as the time 00:00:00), and is preferable to the documented standard, since a date/time with time of 24:00:00 is really the next day, i.e. the date part is then incorrect.

See [ISO_8601] and the official ISO standard for ISO 8601 details. Note that in the date, time and date_time formats shown below, 'Z' and 'T' are literals. In the duration class shown below, 'P', 'Y', 'M', 'W', 'D', 'H', 'S' and 'T' are literals.

6.4. Derived Interval / Time Types

A number of useful types may be generated from the Date/time classes and the Interval classes. These are shown in blue on the following diagram.

BASE foundation types.time intervals
Figure 7. Useful time interval types

6.5. Class Definitions

6.5.1. Time_Definitions Class

Class

Time_Definitions

Description

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.

Constants

Signature

Meaning

1..1

Seconds_in_minute: Integer

1..1

Minutes_in_hour: Integer

1..1

Hours_in_day: Integer

1..1

Nominal_days_in_month: Real

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

1..1

Max_days_in_month: Integer

1..1

Days_in_year: Integer

1..1

Days_in_leap_year: Integer

1..1

Max_days_in_year: Integer

1..1

Nominal_days_in_year: Real

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

1..1

Days_in_week: Integer

1..1

Months_in_year: Integer

1..1

Min_timezone_hour: Integer

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

1..1

Max_timezone_hour: Integer

Functions

Signature

Meaning

valid_year (
y: Integer[1]
): Boolean
Post: Result = y >= 0

valid_month (
m: Integer[1]
): Boolean
Post: Result = m >= 1 and m <= Months_in_year

valid_day (
y: Integer[1],
m: Integer[1],
d: Integer[1]
): Boolean
Post: Result = d >= 1 and d <= days_in_month (m, y)

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

valid_hour (
h,
m,
s: Integer[1]
): Boolean
Post: Result = (h >= 0 and h < Hours_in_day) or (h = Hours_in_day and m = 0 and s = 0)

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

valid_minute (
m: Integer[1]
): Boolean
Post: Result = m >= 0 and m < Minutes_in_hour

True if m >= 0 and m < Minutes_in_hour.

valid_second (
s: Integer[1]
): Boolean
Post: Result = s >= 0 and s < Seconds_in_minute

True if s >= 0 and s < Seconds_in_minute .

valid_fractional_second (
fs: Double[1]
): Boolean
Post: Result = fs >= 0.0 and fs < 1.0 .

True if fs >= 0.0 and fs < 1.0 .

6.5.2. Temporal Class

Class

Temporal (abstract)

Description

Abstract ancestor type of Date/Time types.

Inherit

Ordered, Time_Definitions

6.5.3. IDate Class

Class

IDate (abstract)

Description

Interface of an absolute point in time, as measured on the Gregorian calendar, and specified only to the day.

Inherit

Temporal

Functions

Signature

Meaning

year (): Integer

Year.

month (): Integer
Pre: not month_unknown

Month in year.

day (): Integer
Pre: not day_unknown

Day in month.

timezone (): ITimezone

Timezone; may be Void.

as_string (): String

ISO8601 string for date/time, in format YYYYMMDDThhmmss[,sss][Z | ±hh[mm]] or in extended format YYYY-MM-DDThh:mm:ss[,sss][Z | ±hh[mm]] or a partial variant; see valid_iso8601_date_time() below.

6.5.4. ITime Class

Class

ITime (abstract)

Description

Defines the interface of an absolute point in time from an origin usually interpreted as meaning the start of the current day, specified to fractional seconds.

Inherit

Temporal

Functions

Signature

Meaning

hour (): Integer

Hour in day, in 24-hour time.

minute (): Integer

Minute in hour.

second (): Integer

Second in minute.

fractional_second (): Real
Pre: not second_unknown

Fractional seconds.

timezone (): ITimezone

Timezone; may be Void.

Invariants

Hour_valid: valid_hour(hour, minute, second)

6.5.5. IDate_time Class

Class

IDate_time (abstract)

Description

Defines the interface of an absolute point in time, specified to fractional seconds.

Inherit

Temporal

Functions

Signature

Meaning

year (): Integer

Year.

month (): Integer
Pre: not month_unknown

Month in year.

day (): Integer
Pre: not day_unknown

Day in month.

hour (): Integer
Pre: not hour_unknown

Hour in day.

minute (): Integer
Pre: not minute_unknown

Minute in hour.

second (): Integer
Pre: not second_unknown

Second in minute.

fractional_second (): Real

Fractional seconds.

timezone (): ITimezone

Timezone; may be Void.

Invariants

Day_valid: valid_day(year, month, day)

Month_valid: valid_month (month)

Year_valid: valid_year (year)

Month_valid: valid_month (month)

Day_valid: valid_day(year, month, day)

Hour_valid: valid_hour (hour, minute, second)

6.5.6. IDuration Class

Class

IDuration (abstract)

Description

Defines the interface of a period of time corresponding to a difference between two timepoints.

Inherit

Temporal

Functions

Signature

Meaning

years (): Integer

Number of years of nominal 365-day length.

months (): Integer

Number of months.

days (): Integer

Number of 24 hour days.

hours (): Integer

Number of 60 minute hours.

minutes (): Integer

Number of 60 second minutes.

seconds (): Integer

Number of seconds.

fractional_seconds (): Real

Fractional seconds.

weeks (): Integer

Number of 7 day weeks.

to_seconds (): Integer

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

Invariants

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

6.5.7. ITimezone Class

Class

ITimezone (abstract)

Description

Interface definition of a timezone.

Inherit

Temporal

Functions

Signature

Meaning

hour (): Integer

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

minute (): Integer

Minute part of timezone. Generally 00 or 30.

sign (): Integer

Direction of timezone expresssed as +1 or -1.

Invariants

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

6.5.8. Date Class

Class

Date

Description

Assumed built-in primitive type representing a date.

Inherit

IDate

Attributes

Signature

Meaning

1..1

value: Integer

Integer value representing date.

6.5.9. Time Class

Class

Time

Description

Integer value representing time.

Inherit

ITime

Attributes

Signature

Meaning

1..1

value: Integer

6.5.10. Date_time Class

Class

Date_time

Description

Assumed built-in primitive type representing a date/time

Inherit

IDate_time

Attributes

Signature

Meaning

1..1

value: Integer

Integer value representing date/time.

6.5.11. Duration Class

Class

Duration

Description

Integer value representing duration.

Inherit

IDuration

Attributes

Signature

Meaning

1..1

value: Integer

6.5.12. Timezone Class

Class

Timezone

Description

Assumed built-in primitive type representing a timezone.

Inherit

ITimezone

6.5.13. Iso8601_type Class

Class

Iso8601_type (abstract)

Description

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

Inherit

Ordered

Attributes

Signature

Meaning

1..1

value: String

Functions

Signature

Meaning

is_partial (): Boolean

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

is_extended (): Boolean

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

6.5.14. Iso8601_date Class

Class

Iso8601_date

Description

Represents an ISO 8601 date, including partial and extended forms.

Inherit

Iso8601_type, IDate

Functions

Signature

Meaning

month_unknown (): Boolean

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

day_unknown (): Boolean

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

valid_iso8601_date (): Boolean

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

  • YYYYMMDD or the extended form:

  • YYYY-MM-DD or one of the partial forms:

  • YYYYMM

  • YYYY

or the equivalent extended form:

  • YYYY-MM

Where:

  • YYYY is the string form of any positive number in the range “0000” - “9999” (zero-filled to four digits)

  • MM is “01” - “12” (zero-filled to two digits)

  • DD is “01” - “31” (zero-filled to two digits)

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

(effected)

is_partial (): Boolean

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

(effected)

is_extended (): Boolean

True if this date uses ‘-’ separators.

(effected)

as_string (): String

ISO8601 string for date, in format YYYYMMDD or YYYY-MM-DD, or a partial invariant. See valid_iso8601_date for validity.

Invariants

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

6.5.15. Iso8601_time Class

Class

Iso8601_time

Description

Represents an ISO 8601 time, including partial and extended forms.

Note
A small deviation to the ISO 8601:2004 standard in this class is that the time 24:00:00 is not allowed, for consistency with ISO8601_DATE_TIME.

Inherit

Iso8601_type, ITime

Functions

Signature

Meaning

minute_unknown (): Boolean

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

second_unknown (): Boolean

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

is_decimal_sign_comma (): Boolean

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

valid_iso8601_time (): Boolean

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

  • hhmmss[(,|.)s+][Z|±hh[mm]]

or the extended form:

  • hh:mm:ss[(,|.)s+][Z|±hh[:mm]]

or one of the partial forms:

  • hhmm or hh

or the extended form:

  • hh:mm

with an additional optional timezone indicator of:

  • Z or ±hh[mm] or ±hh[:mm] (extended form)

Where:

  • hh is “00” - “23” (0-filled to two digits)

  • mm is “00” - “59” (0-filled to two digits)

  • ss is “00” - “60” (0-filled to two digits)

  • [(,|.)s+] is an optional string consisting of a comma or decimal point followed by numeric string of 1 or more digits, representing a fractional second

  • Z is a literal meaning UTC (modern replacement for GMT), i.e. timezone +0000

as_string (): String

ISO8601 string for time, i.e. in form: hhmmss[,sss][Z|±hh[mm]] or the extended form: hh:mm:ss[,sss][Z|±hh[mm]], or a partial invariant. See valid_iso8601_time for validity.

has_fractional_second (): Boolean

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

(effected)

is_partial (): Boolean

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

(effected)

is_extended (): Boolean

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

Invariants

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

6.5.16. Iso8601_date_time Class

Class

Iso8601_date_time

Description

Represents an ISO 8601 date/time, including partial and extended forms.

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

  • for partial date/times, any part of the date/time up to the month may be missing, not just seconds and minutes as in the standard;

  • the time 24:00:00 is not allowed, since it would mean the date was really on the next day.

Inherit

Iso8601_type, IDate_time

Functions

Signature

Meaning

month_unknown (): Boolean

Indicates whether month in year is unknown.

day_unknown (): Boolean

Indicates whether day in month is unknown.

minute_unknown (): Boolean

Indicates whether minute in hour is known.

second_unknown (): Boolean

Indicates whether minute in hour is known.

is_decimal_sign_comma (): Boolean

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

valid_iso8601_date_time (
s: String[1]
): Boolean

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

  • YYYYMMDDThhmmss[(,|.)s+][Z|±hh[mm]]

or the extended form:

  • YYYY-MM-DDThh:mm:ss[(,|.)s+][Z|±hh[:mm]]

or one of the partial forms:

  • YYYYMMDDThhmm

  • YYYYMMDDThh

or the equivalent extended forms:

  • YYYY-MM-DDThh:mm

  • YYYY-MM-DDThh

(meanings as in DV_DATE, DV_TIME) and the values in each field are valid.

as_string (): String

ISO8601 string for date/time, in format YYYYMMDDThhmmss[,sss][Z | ±hh[mm]] or in extended format YYYY-MM-DDThh:mm:ss[,sss][Z | ±hh[mm]] or a partial variant; see valid_iso8601_date_time() below.

has_fractional_second (): Boolean

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

(effected)

is_partial (): Boolean

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

(effected)

is_extended (): Boolean

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

Invariants

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

6.5.17. Iso8601_duration Class

Class

Iso8601_duration

Description

Represents an ISO 8601 duration.

Inherit

Iso8601_type, IDuration

Functions

Signature

Meaning

is_decimal_sign_comma (): Boolean

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

valid_iso8601_duration (
s: String[1]
): Boolean

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

  • P[nnY][nnM][nnW][nnD][T[nnH][nnM][nnS]]

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).

s

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

  • P[nnY][nnM][nnW][nnD][T[nnH][nnM][nnS]]

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).

as_string (): String

ISO8601 string for duration, in format

  • P[nnY][nnM][nnW][nnD][T[nnH][nnM][nnS]]

(effected)

is_partial (): Boolean

Returns False.

(effected)

is_extended (): Boolean

Returns True.

Invariants

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

6.5.18. Iso8601_timezone Class

Class

Iso8601_timezone

Description

Represents a timezone as used in ISO 8601.

Inherit

Iso8601_type, ITimezone

Functions

Signature

Meaning

minute_unknown (): Boolean

Indicates whether minute part known.

as_string (): String

ISO8601 timezone string, in format:

  • Z | ±hh[mm]

where:

  • hh is “00” - “23” (0-filled to two digits)

  • mm is “00” - “59” (0-filled to two digits)

  • Z is a literal meaning UTC (modern replacement for GMT), i.e. timezone +0000

is_gmt (): Boolean

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

(effected)

is_partial (): Boolean

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

(effected)

is_extended (): Boolean

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

Invariants

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

7. Functional Meta-types

7.1. Overview

A small number of meta-types are defined that correspond to functional programming primitives, otherwise known as 'closures', 'lambda expressions' and so on. These concepts are supported in most modern programming languages now, and the types defined here are intended to provide a minimal formal basis to enable other openEHR specification to defined function-related elements. Since UML does not contain native functional elements, the semantics here are approximated using normal class facilities.

The following illustrates the foundation_types.functional package.

BASE foundation types.functional
Figure 8. foundation_types.functional package

Two key abstractions are required, namely 'function as a type', and 'tuple', which enables arguments to be formalised. To provide a 'function' type, a 'routine' type is also required. For completeness, a 'procedure' type is also defined. The 'tuple' type is defined as a generic meta-type whose descendants may additionally define any number of generic parameter types, corresponding to a type list.

7.1.1. Class Definitions

7.1.2. ROUTINE Class

Class

ROUTINE

Description

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

7.1.3. FUNCTION Class

Class

FUNCTION

Description

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

Inherit

ROUTINE

7.1.4. PROCEDURE Class

Class

PROCEDURE

Description

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

Inherit

ROUTINE

7.1.5. TUPLE Class

Class

TUPLE

Description

Parent type of all TUPLE types.

7.1.6. TUPLE1 Class

Class

TUPLE1

Description

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

Inherit

TUPLE

7.1.7. TUPLE2 Class

Class

TUPLE2

Description

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

Inherit

TUPLE

8. Type Cross-Reference

The following table provides a cross-reference from openEHR foundation types to their equivalents in common implementation formalisms. Where there is no equivalent listed, a specific library may still exist, or an implementation may be required of the openEHR specification.

Type name
in openEHR
Description XML Java C#

Octet

8-bit value.

-

Byte

Byte

Character

a member of an 8-bit character-set.

string

Character

Char

Boolean

logical True/False values.

`boolean

Boolean

Boolean

Integer

32-bit integers.

`decimal

Integer

Int32

Integer64

64-bit integers.

`decimal

Long

Int64

Real

32-bit real numbers

float,
decimal

Float

Single

Double

64-bit real numbers

double

Double

Double

String

Unicode-enabled strings.

string

String

String

Array<T>

Contiguous Array.

sequence

Array<T>

Array<T>

List<T>

Ordered List.

sequence

List<T>

List<T>

Set<T>

Unordered, unique membership container.

all

Set<T>

HashSet<T>

Hash<K:Ordered, V>

Unique-keyed map.

(various)

Map<T>

HashTable<T>

Interval<T:Ordered>

Interval of ordered types.

-

-

Date

Native date type.

date

java.util.Date

DateTime

Time

Native time type.

time

java.util.Date

DateTime

Date_time

Native date/time type.

dateTime

java.util.Date

DateTime

Duration

Native duration type.

duration

java.time.Duration

TimeSpan

Iso8601_Date

ISO8601-encoded date type.

date

use java.text.SimpleDateFormat
or org.joda.time.format.ISODateTimeFormat

(use formatted string)

Iso8601_Time

ISO8601-encoded time type.

time

use j`ava.text.SimpleDateFormat`
or org.joda.time.format.ISODateTimeFormat

(use formatted string)

Iso8601_Date_time

ISO8601-encoded date/time type.

dateTime

use java.text.SimpleDateFormat
or org.joda.time.format.ISODateTimeFormat

(use formatted string)

Iso8601_Duration

ISO8601-encoded duration type.

duration

use java.text.SimpleDateFormat
or org.joda.time.format.ISODateTimeFormat

(use formatted string)

Interval<Integer>

Interval of Integer.

-

(various)

-

Interval<Date>

Interval of Date.

-

(various)

-

Interval<Time>

Interval of Time.

-

(various)

-

Interval<DateTime>

Interval of DateTime.

-

(various)

-