Base Types

Defines globally used constant values.

Carriage return character.

Line feed character.

Inheritance class to provide access to constants defined in other packages.

Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype

An enumeration of three values that may commonly occur in constraint models.

Use as the type of any attribute within this model, which expresses constraint on some attribute in a class in a reference model. For example to indicate validity of Date/Time fields.

Constant to indicate mandatory presence of something.

Constant to indicate optional presence of something.

Constant to indicate disallowed presence of something.

Status of a versioned artefact, as one of a number of possible values: uncontrolled, prerelease, release, build.

Value representing a version which is 'unstable', i.e. contains an unknown size of change with respect to its base version. Rendered with the build number as a string in the form N.M.P-alpha.B e.g. 2.0.1-alpha.154.

Value representing a version which is 'beta', i.e. contains an unknown but reducing size of change with respect to its base version. Rendered with the build number as a string in the form N.M.P-beta.B e.g. 2.0.1-beta.154.

Value representing a version which is 'release candidate', i.e. contains only patch-level changes on the base version. Rendered as a string as N.M.P-rc.B e.g. 2.0.1-rc.27.

Value representing a version which is 'released', i.e. is the definitive base version. N.M.P e.g. 2.0.1.

Value representing a version which is a build of the current base release. Rendered with the build number as a string in the form N.M.P+B e.g. 2.0.1+33.

Class representing the real-world environment, providing basic information like current time, date, etc.

Return today’s date in the current locale.

Return current time in the current locale.

Return current date/time in the current locale.

Return the timezone of the current locale.

Class representing current Locale.

Primary language of the current locale.

A basic statistical evaluator class providing common functions on collections of numbers.

Sum of a container of values.

Synonym for mean().

Mean (arithmetic average) of a container of values.

Return numerically centre value in ordered form of container contents.

Mode (most frequent) of a container of values.

Maximum of a container of values.

Minimum of a container of values.

Return the number of items in vals, i.e. vals.count.

Compute standard deviation of a container of values.

Mathematical computation.

Compute natural log of v.

Compute base 10 log of v.

Compute sin(v).

Quantity conversion.

Convert value of physical property type (e.g. 'pressure' etc) from one units to another.

Abstract parent of classes representing unique identifiers which identify information entities in a durable way. UIDs only ever identify one IE in time or space and are never re-used.

The value of the id.

Value_valid: not value.empty

Model of ISO’s Object Identifier (oid) as defined by the standard ISO/IEC 8824. Oids are formed from integers separated by dots. Each non-leaf node in an Oid starting from the left corresponds to an assigning authority, and identifies that authority’s namespace, inside which the remaining part of the identifier is locally unique.

Model of the DCE Universal Unique Identifier or UUID which takes the form of hexadecimal integers separated by hyphens, following the pattern 8-4-4-4-12 as defined by the Open Group, CDE 1.1 Remote Procedure Call specification, Appendix A. Also known as a GUID.

Model of a reverse internet domain, as used to uniquely identify an internet domain. In the form of a dot-separated string in the reverse order of a domain name, specified by IETF RFC 1034.

Ancestor class of identifiers of informational objects. Ids may be completely meaningless, in which case their only job is to refer to something, or may carry some information to do with the identified object.

Object ids are used inside an object to identify that object. To identify another object in another service, use an OBJECT_REF, or else use a UID for local objects identified by UID. If none of the subtypes is suitable, direct instances of this class may be used.

The value of the id in the form defined below.

Abstract model of UID-based identifiers consisting of a root part and an optional extension; lexical form: root '::' extension.

The identifier of the conceptual namespace in which the object exists, within the identification scheme. Returns the part to the left of the first '::' separator, if any, or else the whole string.

Optional local identifier of the object within the context of the root identifier. Returns the part to the right of the first '::' separator if any, or else any empty String.

True if not extension.is_empty().

Has_extension_valid: extension.is_empty xor has_extension

Concrete type corresponding to hierarchical identifiers of the form defined by UID_BASED_ID.

Globally unique identifier for one version of a versioned object; lexical form: object_id '::' creating_system_id '::' version_tree_id.

Unique identifier for logical object of which this identifier identifies one version; normally the object_id will be the unique identifier of the version container containing the version referred to by this OBJECT_VERSION_ID instance.

Identifier of the system that created the Version corresponding to this Object version id.

Tree identifier of this version with respect to other versions in the same version tree, as either 1 or 3 part dot-separated numbers, e.g. 1 , 2.1.4 .

True if this version identifier represents a branch.

Version tree identifier for one version. Lexical form:

trunk_version [ '.' branch_number '.' branch_version ]

String form of this identifier.

Trunk version number; numbering starts at 1.

True if this version identifier represents a branch, i.e. has branch_number and branch_version parts.

Number of branch from the trunk point; numbering starts at 1.

Version of the branch; numbering starts at 1.

Value_valid: not value.is_empty

Trunk_version_valid: trunk_version /= Void and then trunk_version.is_integer and then trunk_version.as_integer >= 1

Branch_number_valid: branch_number /= Void implies branch_number.is_integer and then branch_number.as_integer >= 1

Branch_version_valid: branch_version /= Void implies branch_version.is_integer and then branch_version.as_integer >= 1

Branch_validity: (branch_number = Void and branch_version = Void ) xor (branch_number /= Void and branch_version /= Void )

Is_branch_validity: is_branch xor branch_number = Void

Is_first_validity: not is_first xor trunk_version.is_equal(“1”)

Identifier for archetypes. Ideally these would identify globally unique archetypes.

Lexical form: rm_originator '-' rm_name '-' rm_entity '.' concept_name { '-' specialisation }* '.v' number.

Globally qualified reference model entity, e.g. openehr-EHR-OBSERVATION.

Name of the concept represented by this archetype, including specialisation, e.g. Biochemistry_result-cholesterol.

Organisation originating the reference model on which this archetype is based, e.g. openehr, cen, hl7 .

Name of the reference model, e.g. rim, ehr_rm, en13606 .

Name of the ontological level within the reference model to which this archetype is targeted, e.g. for openEHR, folder , composition , section , entry .

Name of specialisation of concept, if this archetype is a specialisation of another archetype, e.g. cholesterol .

Version of this archetype.

Identifier for templates. Lexical form to be determined.

Identifier for terminologies such as accessed via a terminology query service. In this class, the value attribute identifies the Terminology in the terminology service, e.g. SNOMED-CT . A terminology is assumed to be in a particular language, which must be explicitly specified.

The value if the id attribute is the precise terminology id identifier, including actual release (i.e. actual version), local modifications etc; e.g. ICPC2.

Lexical form: name [ '(' version ')' ].

Return the terminology id (which includes the version in some cases). Distinct names correspond to distinct (i.e. non-compatible) terminologies. Thus the names ICD10AM and ICD10 refer to distinct terminologies.

Version of this terminology, if versioning supported, else the empty string.

Generic identifier type for identifiers whose format is otherwise unknown to openEHR. Includes an attribute for naming the identification scheme (which may well be local).

Name of the scheme to which this identifier conforms. Ideally this name will be recognisable globally but realistically it may be a local ad hoc scheme whose name is not controlled or standardised in any way.

Class describing a reference to another object, which may exist locally or be maintained outside the current namespace, e.g. in another service. Services are usually external, e.g. available in a LAN (including on the same host) or the internet via Corba, SOAP, or some other distributed protocol. However, in small systems they may be part of the same executable as the data containing the Id.

Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are:

Note that the first two are just special values of the regex, and will be matched by it.

Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).

Globally unique id of an object, regardless of where it is stored.

Identifier for parties in a demographic or identity service. There are typically a number of subtypes of the PARTY class, including PERSON, ORGANISATION, etc. Abstract supertypes are allowed if the referenced object is of a type not known by the current implementation of this class (in other words, if the demographic model is changed by the addition of a new PARTY or ACTOR subtypes, valid PARTY_REFs can still be constructed to them).

Type_validity: type.is_equal(“PERSON”) or type.is_equal(“ORGANISATION”) or type.is_equal(“GROUP”) or type.is_equal(“AGENT”)or type.is_equal(“ROLE”) or type.is_equal(“PARTY”) or type.is_equal(“ACTOR”)

Purpose Reference to a LOCATABLE instance inside the top-level content structure inside a VERSION<T>; the path attribute is applied to the object that VERSION.data points to.

The path to an instance in question, as an absolute path with respect to the object found at VERSION.data. An empty path means that the object referred to by id being specified.

Globally unique id of an object, regardless of where it is stored.

A URI form of the reference, created by concatenating the following: