Definitions Package

Overview

The base_types.definitions package shown below defines symbolic definitions used by the openEHR models.

BASE base types.definitions
Figure 1. base.base_types.definitions package

Class Definitions

BASIC_DEFINITIONS Class

  • Definition

  • Effective

  • BMM

  • UML

Class

BASIC_DEFINITIONS

Description

Defines globally used constant values.

Constants

Signature

Meaning

1..1

CR: Character = '\015'

Carriage return character.

1..1

LF: Character = '\012'

Line feed character.

1..1

Any_type_name: String = "Any"

1..1

Regex_any_pattern: String = ".*"

1..1

Default_encoding: String = "UTF-8"

1..1

None_type_name: String = "None"
BASIC_DEFINITIONS

Defines globally used constant values.

Constants

CR: Character = '\015' [1..1]

Carriage return character.

LF: Character = '\012' [1..1]

Line feed character.

Any_type_name: String = "Any" [1..1]

Regex_any_pattern: String = ".*" [1..1]

Default_encoding: String = "UTF-8" [1..1]

None_type_name: String = "None" [1..1]

 
{
    "name": "BASIC_DEFINITIONS",
    "documentation": "Defines globally used constant values.",
    "constants": {
        "CR": {
            "name": "CR",
            "documentation": "Carriage return character.",
            "type": "Character",
            "value": "'\\015'"
        },
        "LF": {
            "name": "LF",
            "documentation": "Line feed character.",
            "type": "Character",
            "value": "'\\012'"
        },
        "Any_type_name": {
            "name": "Any_type_name",
            "type": "String",
            "value": "\"Any\""
        },
        "Regex_any_pattern": {
            "name": "Regex_any_pattern",
            "type": "String",
            "value": "\".*\""
        },
        "Default_encoding": {
            "name": "Default_encoding",
            "type": "String",
            "value": "\"UTF-8\""
        },
        "None_type_name": {
            "name": "None_type_name",
            "type": "String",
            "value": "\"None\""
        }
    }
}
basic definitions

OPENEHR_DEFINITIONS Class

  • Definition

  • Effective

  • BMM

  • UML

Class

OPENEHR_DEFINITIONS

Description

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

Inherit

BASIC_DEFINITIONS

Constants

Signature

Meaning

1..1

Local_terminology_id: String = "local"

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

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

Inherits: BASIC_DEFINITIONS

Constants

CR: Character = '\015' [1..1]

Carriage return character.
Inherited from BASIC_DEFINITIONS

LF: Character = '\012' [1..1]

Line feed character.
Inherited from BASIC_DEFINITIONS

Any_type_name: String = "Any" [1..1]

+ Inherited from BASIC_DEFINITIONS

Regex_any_pattern: String = ".*" [1..1]

+ Inherited from BASIC_DEFINITIONS

Default_encoding: String = "UTF-8" [1..1]

+ Inherited from BASIC_DEFINITIONS

None_type_name: String = "None" [1..1]

+ Inherited from BASIC_DEFINITIONS

Local_terminology_id: String = "local" [1..1]

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

 
{
    "name": "OPENEHR_DEFINITIONS",
    "documentation": "Inheritance class to provide access to constants defined in other packages.",
    "ancestors": [
        "BASIC_DEFINITIONS"
    ],
    "constants": {
        "Local_terminology_id": {
            "name": "Local_terminology_id",
            "documentation": "Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype",
            "type": "String",
            "value": "\"local\""
        }
    }
}
openehr definitions

VALIDITY_KIND Enumeration

  • Definition

  • Effective

  • BMM

  • UML

Enumeration

VALIDITY_KIND

Description

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.

Constants

Signature

Meaning

mandatory

Constant to indicate mandatory presence of something.

optional

Constant to indicate optional presence of something.

prohibited

Constant to indicate disallowed presence of something.
VALIDITY_KIND

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.

Inherits: Any, Ordered, String

Constants

mandatory

Constant to indicate mandatory presence of something.

optional

Constant to indicate optional presence of something.

prohibited

Constant to indicate disallowed presence of something.

Functions

is_equal (
other: Any[1]
): Boolean [1..1]

Value equality: return True if this and other are attached to objects considered to be equal in value.
Inherited from Any

equal alias "=", "==" (
other: Any[1]
): Boolean [1..1]

Reference equality for reference types, value equality for value types.
Inherited from Any

instance_of (
a_type: String[1]
): Any [1..1]

Create new instance of a type.
Inherited from Any

type_of (
an_object: Any[1]
): String [1..1]

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

not_equal alias "!=", "≠" (
other: Ordered[1]
): Boolean [1..1]

True if current object not equal to other. Returns not equal().
Inherited from Any

less_than alias "<" (
other: String[1]
): Boolean [1..1]

Lexical comparison of string content based on ordering in relevant character set.
Inherited from String

less_than_or_equal alias "⇐", "≤" (
other: Ordered[1]
): Boolean

Post_result: not (other < self) [1..1]

True if current object less than or equal to other.
Inherited from Ordered

greater_than alias ">" (
other: Ordered[1]
): Boolean

Post_result: Result = (other < self) [1..1]

True if current object greater than other.
Inherited from Ordered

greater_than_or_equal alias ">=", "≥" (
other: Ordered[1]
): Boolean

Post_result: Result = (other <= self) [1..1]

True if current object greater than or equal to other.
Inherited from Ordered

is_empty (): Boolean [1..1]

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

is_integer (): Boolean [1..1]

True if string can be parsed as an integer.
Inherited from String

as_integer (): Integer [1..1]

Return the integer corresponding to the integer value represented in this string.
Inherited from String

append alias "+" (
other: String[1]
): String [1..1]

Concatenation operator - causes other to be appended to this string.
Inherited from String

contains (
other: String[1]
): Boolean [1..1]

Return True if this String contains other (case-sensitive).
Inherited from String

 
{
    "_type": "P_BMM_ENUMERATION_STRING",
    "name": "VALIDITY_KIND",
    "documentation": "An enumeration of three values that may commonly occur in constraint models.\n\nUse 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\nof Date/Time fields.",
    "ancestors": [
        "String"
    ],
    "item_names": [
        "mandatory",
        "optional",
        "prohibited"
    ],
    "item_documentations": [
        "Constant to indicate mandatory presence of something.",
        "Constant to indicate optional presence of something.",
        "Constant to indicate disallowed presence of something."
    ]
}
validity kind

VERSION_STATUS Enumeration

  • Definition

  • Effective

  • BMM

  • UML

Enumeration

VERSION_STATUS

Description

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

Constants

Signature

Meaning

alpha

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.

beta

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.

release_candidate

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.

released

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

build

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

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

Inherits: Any, Ordered, String

Constants

alpha

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.

beta

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.

release_candidate

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.

released

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

build

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.

Functions

is_equal (
other: Any[1]
): Boolean [1..1]

Value equality: return True if this and other are attached to objects considered to be equal in value.
Inherited from Any

equal alias "=", "==" (
other: Any[1]
): Boolean [1..1]

Reference equality for reference types, value equality for value types.
Inherited from Any

instance_of (
a_type: String[1]
): Any [1..1]

Create new instance of a type.
Inherited from Any

type_of (
an_object: Any[1]
): String [1..1]

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

not_equal alias "!=", "≠" (
other: Ordered[1]
): Boolean [1..1]

True if current object not equal to other. Returns not equal().
Inherited from Any

less_than alias "<" (
other: String[1]
): Boolean [1..1]

Lexical comparison of string content based on ordering in relevant character set.
Inherited from String

less_than_or_equal alias "⇐", "≤" (
other: Ordered[1]
): Boolean

Post_result: not (other < self) [1..1]

True if current object less than or equal to other.
Inherited from Ordered

greater_than alias ">" (
other: Ordered[1]
): Boolean

Post_result: Result = (other < self) [1..1]

True if current object greater than other.
Inherited from Ordered

greater_than_or_equal alias ">=", "≥" (
other: Ordered[1]
): Boolean

Post_result: Result = (other <= self) [1..1]

True if current object greater than or equal to other.
Inherited from Ordered

is_empty (): Boolean [1..1]

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

is_integer (): Boolean [1..1]

True if string can be parsed as an integer.
Inherited from String

as_integer (): Integer [1..1]

Return the integer corresponding to the integer value represented in this string.
Inherited from String

append alias "+" (
other: String[1]
): String [1..1]

Concatenation operator - causes other to be appended to this string.
Inherited from String

contains (
other: String[1]
): Boolean [1..1]

Return True if this String contains other (case-sensitive).
Inherited from String

 
{
    "_type": "P_BMM_ENUMERATION_STRING",
    "name": "VERSION_STATUS",
    "documentation": "Status of a versioned artefact, as one of a number of possible values: uncontrolled, prerelease, release, build.",
    "ancestors": [
        "String"
    ],
    "item_names": [
        "alpha",
        "beta",
        "release_candidate",
        "released",
        "build"
    ],
    "item_documentations": [
        "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`."
    ]
}
version status