Support Package

Overview

The Support Reference Model comprises types used throughout the openEHR models, including assumed primitive types defined outside of openEHR. The package structure is illustrated below. The assumed_types 'pseudo-package' stands for types assumed by the openEHR specifcations to exist in an implementation technology, such as a programming language, schema language or database environment. The four Support packages define the semantics respectively for constants, terminology access, access to externally defined scientific units and conversion information. The class EXTERNAL_ENVIRONMENT_ACCESS is a mixin class providing access to the service interface classes.

RM support overview
Figure 1. rm.support and assumed_types Packages

Class Definitions

EXTERNAL_ENVIRONMENT_ACCESS Class

  • Definition

  • Effective

  • BMM

  • UML

Class

EXTERNAL_ENVIRONMENT_ACCESS (abstract)

Description

A mixin class providing access to services in the external environment.

Inherit

TERMINOLOGY_SERVICE, MEASUREMENT_SERVICE
EXTERNAL_ENVIRONMENT_ACCESS (abstract)

A mixin class providing access to services in the external environment.

Inherits: OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS, OPENEHR_CODE_SET_IDENTIFIERS, TERMINOLOGY_SERVICE, MEASUREMENT_SERVICE

Constants

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Terminology_id_openehr: String = "openehr" [1..1]

Name of openEHR’s own terminology.

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_audit_change_type: String = "audit change type" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_attestation_reason: String = "attestation reason" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_composition_category: String = "composition category" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_event_math_function: String = "event math function" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_instruction_states: String = "instruction states" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_instruction_transitions: String = "instruction transitions" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_null_flavours: String = "null flavours" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_property: String = "property" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_participation_function: String = "participation function" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_participation_mode: String = "participation mode" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_setting: String = "setting" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_term_mapping_purpose: String = "term mapping purpose" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_subject_relationship: String = "subject relationship" [1..1]

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.Group_id_version_life_cycle_state: String = "version lifecycle state" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_character_sets: String = "character sets" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_compression_algorithms: String = "compression algorithms" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_countries: String = "countries" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_integrity_check_algorithms: String = "integrity check algorithms" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_languages: String = "languages" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_media_types: String = "media types" [1..1]

OPENEHR_CODE_SET_IDENTIFIERS.Code_set_id_normal_statuses: String = "normal statuses" [1..1]

Functions

OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS.valid_terminology_group_id (
an_id: Boolean[1]
): Boolean [1..1]

Validity function to test if an identifier is in the set defined by this class.

OPENEHR_CODE_SET_IDENTIFIERS.valid_code_set_id (
an_id: String[1]
): Boolean [1..1]

Validity function to test if an identifier is in the set defined by this class.

TERMINOLOGY_SERVICE.terminology (
name: String[1]
): TERMINOLOGY_ACCESS [1..1]

Return an interface to the terminology named name. Allowable names include:-

TERMINOLOGY_SERVICE.code_set (
name: String[1]
): CODE_SET_ACCESS

Pre: has_code_set (name) [1..1]

Return an interface to the code_set identified by the external identifier name (e.g. ISO_639-1).

TERMINOLOGY_SERVICE.code_set_for_id (
id: String[1]
): CODE_SET_ACCESS

Pre: valid_code_set_id (id) [1..1]

Return an interface to the code_set identified internally in openEHR by id.

TERMINOLOGY_SERVICE.has_terminology (
name: String[1]
): Boolean [1..1]

True if terminology named name known by this service. Allowable names include:-

TERMINOLOGY_SERVICE.has_code_set (
name: String[1]
): Boolean [1..1]

True if code_set linked to internal name (e.g. languages ) is available.

TERMINOLOGY_SERVICE.terminology_identifiers (): List<String> [0..1]

Set of all terminology identifiers known in the terminology service. Values from the US NLM UMLS meta-data list at:- http://www.nlm.nih.gov/research/umls/metaa1.html

TERMINOLOGY_SERVICE.openehr_code_sets (): Hash<String,String> [1..1]

Set of all code set identifiers known in the terminology service.

TERMINOLOGY_SERVICE.code_set_identifiers (): List<String> [0..1]

Set of all code sets identifiers for which there is an internal openEHR name; returned as a Map of ids keyed by internal name.

MEASUREMENT_SERVICE.is_valid_units_string (
units: String[1]
): Boolean [1..1]

True if the units string units' is a valid string according to the HL7 UCUM specification.

MEASUREMENT_SERVICE.units_equivalent (
units1: String[1],
units2: String[1]
): Boolean [1..1]

True if two units strings correspond to the same measured property.

 
{
    "name": "EXTERNAL_ENVIRONMENT_ACCESS",
    "documentation": "A mixin class providing access to services in the external environment.",
    "is_abstract": true,
    "ancestors": [
        "TERMINOLOGY_SERVICE",
        "MEASUREMENT_SERVICE"
    ]
}
EXTERNAL_ENVIRONMENT_ACCESS