Representation Package

Overview

This package contains classes for a simple hierarchical representation of any data structure, as shown on the lower right side of [data_structures_package]. These classes are compatible with the ISO 13606-1 classes of the same names, and instances can be losslessly generated to and from EN13606 instances structures.

Class Descriptions

ITEM Class

  • Definition

  • Effective

  • BMM

  • UML

Class

ITEM (abstract)

Description

The abstract parent of CLUSTER and ELEMENT representation classes.

Inherit

LOCATABLE
ITEM (abstract)

The abstract parent of CLUSTER and ELEMENT representation classes.

Inherits: Any, PATHABLE, LOCATABLE

Attributes

name: DV_TEXT [1..1]

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.
Inherited from LOCATABLE

archetype_node_id: String [1..1]

Design-time archetype id of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at code, e.g. at0005 . This value enables a "standardised" name for this node to be generated, by referring to the generating archetype local ontology.

At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object.
Inherited from LOCATABLE

uid: UID_BASED_ID [0..1]

Optional globally unique object identifier for root points of archetyped structures.
Inherited from LOCATABLE

links: List<LINK> [0..1]

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.
Inherited from LOCATABLE

archetype_details: ARCHETYPED [0..1]

Details of archetyping used on this node.
Inherited from LOCATABLE

feeder_audit: FEEDER_AUDIT [0..1]

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
Inherited from LOCATABLE

Functions

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

Value equality.
Inherited from Any

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

Reference equality.
Inherited from Any

Parameters
other

Reference equality.

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

parent (): PATHABLE [1..1]

Parent of this node in a compositional hierarchy.
Inherited from PATHABLE

item_at_path (
a_path: String[1]
): Any

Pre: path_unique (a_path) [1..1]

The item at a path (relative to this item); only valid for unique paths, i.e. paths that resolve to a single item.
Inherited from PATHABLE

items_at_path (
a_path: String[1]
): List<Any> [0..1]

List of items corresponding to a non-unique path.
Inherited from PATHABLE

path_exists (
a_path: String[1]
): Boolean

Pre: not a_path.is_empty [1..1]

True if the path exists in the data with respect to the current item.
Inherited from PATHABLE

path_unique (
a_path: String[1]
): Boolean

Pre: path_exists (a_path) [1..1]

True if the path corresponds to a single item in the data.
Inherited from PATHABLE

path_of_item (
a_loc: PATHABLE[1]
): String [1..1]

The path to an item relative to the root of this archetyped structure.
Inherited from PATHABLE

concept (): DV_TEXT [1..1]

Clinical concept of the archetype as a whole (= derived from the archetype_node_id' of the root node)
Inherited from LOCATABLE

is_archetype_root (): Boolean [1..1]

True if this node is the root of an archetyped structure.
Inherited from LOCATABLE

Invariants

Links_valid: links /= Void implies not links.is_empty
Inherited from LOCATABLE

Archetyped_valid: is_archetype_root xor archetype_details = Void
Inherited from LOCATABLE

Archetype_node_id_valid: not archetype_node_id.is_empty
Inherited from LOCATABLE

 
{
    "name": "ITEM",
    "documentation": "The abstract parent of `CLUSTER` and `ELEMENT` representation classes. ",
    "is_abstract": true,
    "ancestors": [
        "LOCATABLE"
    ]
}
item

CLUSTER Class

  • Definition

  • Effective

  • BMM

  • UML

Class

CLUSTER

Description

The grouping variant of ITEM, which may contain further instances of ITEM, in an ordered list.

Inherit

ITEM

Attributes

Signature

Meaning

1..1

items: List<ITEM>

Ordered list of items - CLUSTER or ELEMENT objects - under this CLUSTER.
CLUSTER

The grouping variant of ITEM, which may contain further instances of ITEM, in an ordered list.

Inherits: Any, PATHABLE, LOCATABLE, ITEM

Attributes

name: DV_TEXT [1..1]

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.
Inherited from LOCATABLE

archetype_node_id: String [1..1]

Design-time archetype id of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at code, e.g. at0005 . This value enables a "standardised" name for this node to be generated, by referring to the generating archetype local ontology.

At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object.
Inherited from LOCATABLE

uid: UID_BASED_ID [0..1]

Optional globally unique object identifier for root points of archetyped structures.
Inherited from LOCATABLE

links: List<LINK> [0..1]

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.
Inherited from LOCATABLE

archetype_details: ARCHETYPED [0..1]

Details of archetyping used on this node.
Inherited from LOCATABLE

feeder_audit: FEEDER_AUDIT [0..1]

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
Inherited from LOCATABLE

items: List<ITEM> [1..1]

Ordered list of items - CLUSTER or ELEMENT objects - under this CLUSTER.

Functions

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

Value equality.
Inherited from Any

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

Reference equality.
Inherited from Any

Parameters
other

Reference equality.

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

parent (): PATHABLE [1..1]

Parent of this node in a compositional hierarchy.
Inherited from PATHABLE

item_at_path (
a_path: String[1]
): Any

Pre: path_unique (a_path) [1..1]

The item at a path (relative to this item); only valid for unique paths, i.e. paths that resolve to a single item.
Inherited from PATHABLE

items_at_path (
a_path: String[1]
): List<Any> [0..1]

List of items corresponding to a non-unique path.
Inherited from PATHABLE

path_exists (
a_path: String[1]
): Boolean

Pre: not a_path.is_empty [1..1]

True if the path exists in the data with respect to the current item.
Inherited from PATHABLE

path_unique (
a_path: String[1]
): Boolean

Pre: path_exists (a_path) [1..1]

True if the path corresponds to a single item in the data.
Inherited from PATHABLE

path_of_item (
a_loc: PATHABLE[1]
): String [1..1]

The path to an item relative to the root of this archetyped structure.
Inherited from PATHABLE

concept (): DV_TEXT [1..1]

Clinical concept of the archetype as a whole (= derived from the archetype_node_id' of the root node)
Inherited from LOCATABLE

is_archetype_root (): Boolean [1..1]

True if this node is the root of an archetyped structure.
Inherited from LOCATABLE

Invariants

Links_valid: links /= Void implies not links.is_empty
Inherited from LOCATABLE

Archetyped_valid: is_archetype_root xor archetype_details = Void
Inherited from LOCATABLE

Archetype_node_id_valid: not archetype_node_id.is_empty
Inherited from LOCATABLE

 
{
    "name": "CLUSTER",
    "documentation": "The grouping variant of `ITEM`, which may contain further instances of `ITEM`, in an ordered list. ",
    "ancestors": [
        "ITEM"
    ],
    "properties": {
        "items": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "items",
            "documentation": "Ordered list of items - `CLUSTER` or `ELEMENT` objects - under this `CLUSTER`. ",
            "is_mandatory": true,
            "type_def": {
                "container_type": "List",
                "type": "ITEM"
            },
            "cardinality": {
                "lower": 1,
                "upper_unbounded": true
            }
        }
    }
}
cluster

ELEMENT Class

  • Definition

  • Effective

  • BMM

  • UML

Class

ELEMENT

Description

The leaf variant of ITEM, to which a DATA_VALUE instance is attached.

Inherit

ITEM

Attributes

Signature

Meaning

0..1

null_flavour: DV_CODED_TEXT

Flavour of null value, e.g. indeterminate, not asked etc.

0..1

value: DATA_VALUE

Property representing leaf value object of ELEMENT. In real data, any concrete subtype of DATA_VALUE can be used.

Functions

Signature

Meaning

1..1

is_null (): Boolean

True if value logically not known, e.g. if indeterminate, not asked etc.

Invariants

Is_null_valid: is_null = (value = Void)

Null_flavour_indicated: is_null xor null_flavour = Void

Null_flavour_valid: is_null implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code)
ELEMENT

The leaf variant of ITEM, to which a DATA_VALUE instance is attached.

Inherits: Any, PATHABLE, LOCATABLE, ITEM

Attributes

name: DV_TEXT [1..1]

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.
Inherited from LOCATABLE

archetype_node_id: String [1..1]

Design-time archetype id of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at code, e.g. at0005 . This value enables a "standardised" name for this node to be generated, by referring to the generating archetype local ontology.

At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object.
Inherited from LOCATABLE

uid: UID_BASED_ID [0..1]

Optional globally unique object identifier for root points of archetyped structures.
Inherited from LOCATABLE

links: List<LINK> [0..1]

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.
Inherited from LOCATABLE

archetype_details: ARCHETYPED [0..1]

Details of archetyping used on this node.
Inherited from LOCATABLE

feeder_audit: FEEDER_AUDIT [0..1]

Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
Inherited from LOCATABLE

null_flavour: DV_CODED_TEXT [0..1]

Flavour of null value, e.g. indeterminate, not asked etc.

value: DATA_VALUE [0..1]

Property representing leaf value object of ELEMENT. In real data, any concrete subtype of DATA_VALUE can be used.

Functions

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

Value equality.
Inherited from Any

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

Reference equality.
Inherited from Any

Parameters
other

Reference equality.

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

parent (): PATHABLE [1..1]

Parent of this node in a compositional hierarchy.
Inherited from PATHABLE

item_at_path (
a_path: String[1]
): Any

Pre: path_unique (a_path) [1..1]

The item at a path (relative to this item); only valid for unique paths, i.e. paths that resolve to a single item.
Inherited from PATHABLE

items_at_path (
a_path: String[1]
): List<Any> [0..1]

List of items corresponding to a non-unique path.
Inherited from PATHABLE

path_exists (
a_path: String[1]
): Boolean

Pre: not a_path.is_empty [1..1]

True if the path exists in the data with respect to the current item.
Inherited from PATHABLE

path_unique (
a_path: String[1]
): Boolean

Pre: path_exists (a_path) [1..1]

True if the path corresponds to a single item in the data.
Inherited from PATHABLE

path_of_item (
a_loc: PATHABLE[1]
): String [1..1]

The path to an item relative to the root of this archetyped structure.
Inherited from PATHABLE

concept (): DV_TEXT [1..1]

Clinical concept of the archetype as a whole (= derived from the archetype_node_id' of the root node)
Inherited from LOCATABLE

is_archetype_root (): Boolean [1..1]

True if this node is the root of an archetyped structure.
Inherited from LOCATABLE

is_null (): Boolean [1..1]

True if value logically not known, e.g. if indeterminate, not asked etc.

Invariants

Links_valid: links /= Void implies not links.is_empty
Inherited from LOCATABLE

Archetyped_valid: is_archetype_root xor archetype_details = Void
Inherited from LOCATABLE

Archetype_node_id_valid: not archetype_node_id.is_empty
Inherited from LOCATABLE

Is_null_valid: is_null = (value = Void)

Null_flavour_indicated: is_null xor null_flavour = Void

Null_flavour_valid: is_null implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code)

 
{
    "name": "ELEMENT",
    "documentation": "The leaf variant of `ITEM`, to which a `DATA_VALUE` instance is attached. ",
    "ancestors": [
        "ITEM"
    ],
    "properties": {
        "null_flavour": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "null_flavour",
            "documentation": "Flavour of null value, e.g. indeterminate, not asked etc.",
            "type": "DV_CODED_TEXT"
        },
        "value": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "value",
            "documentation": "Property representing leaf value object of `ELEMENT`. In real data, any concrete subtype of `DATA_VALUE` can be used.",
            "type": "DATA_VALUE"
        }
    },
    "functions": {
        "is_null": {
            "name": "is_null",
            "documentation": "True if value logically not known, e.g. if indeterminate, not asked etc. ",
            "result": {
                "_type": "P_BMM_SIMPLE_TYPE",
                "type": "Boolean"
            }
        }
    },
    "invariants": {
        "Is_null_valid": "is_null = (value = Void)",
        "Null_flavour_indicated": "is_null xor null_flavour = Void",
        "Null_flavour_valid": "is_null implies terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_null_flavour, null_flavour.defining_code)"
    }
}
element