| Operation | Class | Description |
| add | DV_ABSOLUTE_QUANTITY | Addition of a differential amount to this quantity. |
| add | DV_DATE | Add a time period to this date. |
| add | DV_DATE_TIME | Add a time period to this date_time. |
| add | DV_TIME | Add a time period to this time. |
| all_codes | CODE_SET_ACCESS | Return all codes known in this code set. |
| all_codes | TERMINOLOGY_ACCESS | Return all codes known in this terminology. |
| all_version_ids | VERSIONED_OBJECT | Return a list of ids of all versions in this object. |
| all_versions | VERSIONED_OBJECT | Return a list of all versions in this object. |
| alternatives | C_SINGLE_ATTRIBUTE | List of alternative constraints for the single child of this attribute within the data. |
| any_allowed | C_DEFINED_OBJECT | True if any value (i.e. instance) of the reference model type would be allowed. Redefined in descendants. |
| ARCHETYPE_ID | ARCHETYPE_ID | Constructor passing in atomic identifier components. Beware of specialisation and version_id semantics. |
| ARCHETYPE_ID | ARCHETYPE_ID | |
| as_hierarchy | DATA_STRUCTURE | Hierarchical equivalent of the physical representation of each subtype, compatible with CEN EN 13606 structures. |
| as_hierarchy | ITEM_LIST | Generate a CEN EN13606-compatible hierarchy consisting of a single CLUSTER containing the ELEMENTs of this list. |
| as_hierarchy | ITEM_SINGLE | Generate a CEN EN13606-compatible hierarchy consisting of a single ELEMENT. |
| as_hierarchy | ITEM_TABLE | Generate a CEN EN13606-compatible hierarchy consisting of a single CLUSTER containing the CLUSTERs representing the columns of this table. |
| as_hierarchy | ITEM_TREE | Generate a CEN EN13606-compatible hierarchy, which is the same as the tree's physical representation. |
| as_uri | LOCATABLE_REF | A URI form of the reference, created by concatenating the following: ehr:// + id.value + / + path |
| assumed_value | C_PRIMITIVE | Value to be assumed if none sent in data. |
| branch_number | VERSION_TREE_ID | Number of branch from the trunk point; numbering starts at 1. |
| branch_version | VERSION_TREE_ID | Version of the branch; numbering starts at 1. |
| calendar_alignment | DV_GENERAL_TIME_SPECIFICATION | Calendar alignment extracted from value. |
| calendar_alignment | DV_PERIODIC_TIME_SPECIFICATION | Calendar alignment extracted from value. |
| calendar_alignment | DV_TIME_SPECIFICATION | Indicates what prototypical point in the calendar the specification is aligned to, e.g. 5th of the month . Empty if not aligned. Extracted from the value' attribute. |
| canonical_form | VERSION | Canonical form of Version object, created by serialising all attributes except signature. |
| code_set | TERMINOLOGY_SERVICE | Return an interface to the code_set identified by the external identifier name (e.g. ISO_639-1 ). |
| code_set_for_id | TERMINOLOGY_SERVICE | Return an interface to the code_set identified internally in openEHR by id. |
| code_set_identifiers | TERMINOLOGY_SERVICE | Set of all code sets identifiers for which there is an internal openEHR name; returned as a Map of ids keyed by internal name. |
| codes_for_group_id | TERMINOLOGY_ACCESS | Return all codes under grouper group_id' from this terminology. |
| codes_for_group_name | TERMINOLOGY_ACCESS | Return all codes under grouper whose name in lang' is name' from this terminology. |
| commit_attestation | VERSIONED_OBJECT | Add a new attestation to a specified original version. Attestations can only be added to Original versions. |
| commit_imported_version | VERSIONED_OBJECT | Add a new imported version. Details of version id etc come from the ORIGINAL_VERSION being committed. |
| commit_original_merged_version | VERSIONED_OBJECT | Add a new original merged version. This commit function adds a parameter containing the ids of other versions merged into the current one. |
| commit_original_version | VERSIONED_OBJECT | Add a new original version. |
| concept | LOCATABLE | Clinical concept of the archetype as a whole (= derived from the archetype_node_id' of the root node) |
| concept_name | ARCHETYPE | The concept name of the archetype in language a_lang; corresponds to the term definition of the concept attribute in the archetype ontology. |
| constraint_binding | ARCHETYPE_ONTOLOGY | |
| constraint_definition | ARCHETYPE_ONTOLOGY | |
| constraint_references_valid | ARCHETYPE | True if every CONSTRAINT_REF.reference found on a C_OBJECT node in the archetype definition is found in ontology.constraint_codes. |
| creating_system_id | OBJECT_VERSION_ID | Identifier of the system that created the Version corresponding to this Object version id. |
| current_revision | AUTHORED_RESOURCE | Most recent revision in revision_history if is_controlled else (uncontrolled) . |
| data | IMPORTED_VERSION | Data of wrapped ORIGINAL_VERSION. |
| data | VERSION | Original content of this Version. |
| default_value | C_DEFINED_OBJECT | Generate a default value from this constraint object. |
| default_value | C_PRIMITIVE | Generate a default value from this constraint object. |
| diff | DV_ABSOLUTE_QUANTITY | Difference of two quantities. |
| diff | DV_DATE | Difference of two temporal quantities. |
| diff | DV_TEMPORAL | Difference of two temporal quantities. |
| domain_concept | ARCHETYPE_ID | Name of the concept represented by this archetype, including specialisation, e.g. Biochemistry_result-cholesterol . |
| DV_PROPORTION | DV_PROPORTION | copy constructor |
| DV_PROPORTION | DV_PROPORTION | Class constructor |
| element_at_path | ITEM_TREE | Return the leaf element at the path a_path'. |
| event_alignment | DV_GENERAL_TIME_SPECIFICATION | Event alignment extracted from value. |
| event_alignment | DV_PERIODIC_TIME_SPECIFICATION | Event alignment extracted from value. |
| event_alignment | DV_TIME_SPECIFICATION | Indicates what real-world event the specification is aligned to if any. Extracted from the value' attribute. |
| extension | UID_BASED_ID | 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. |
| fragment_id | DV_URI | A part of, a fragment or a sub-function within an object. Allows references to sub-parts of objects, such as a certain line and character position in a text object. The syntax and semantics are defined by the application responsible for the object. |
| has | Interval | 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))) |
| has_assumed_value | C_DEFINED_OBJECT | True if there is an assumed value. |
| has_assumed_value | C_PRIMITIVE | True if there is an assumed value. |
| has_code | CODE_SET_ACCESS | True if code set knows about a_code'. |
| has_code_for_group_id | TERMINOLOGY_ACCESS | True if a_code' is known in group group_id' in the openEHR terminology. |
| has_code_set | TERMINOLOGY_SERVICE | True if code_set linked to internal name (e.g. languages ) is available. |
| has_constraint_code | ARCHETYPE_ONTOLOGY | |
| has_element_path | ITEM_TREE | True if path a_path' is a valid leaf path. |
| has_extension | UID_BASED_ID | True if extension /= Void |
| has_integrity_check | DV_MULTIMEDIA | Computed from the value of the integrity_check_algorithm attribute: True if an integrity check has been computed. |
| has_key | Hash | Test for membership of a key |
| has_lang | CODE_SET_ACCESS | True if code set knows about a_lang' . |
| has_language | ARCHETYPE_ONTOLOGY | |
| has_path | ARCHETYPE_CONSTRAINT | True if the relative path a_path exists at this node. |
| has_term_code | ARCHETYPE_ONTOLOGY | |
| has_terminology | ARCHETYPE_ONTOLOGY | |
| has_terminology | TERMINOLOGY_SERVICE | True if terminology named name known by this service. Allowable names include:- * openehr * centc251 * any name from are taken from the US NLM UMLS meta-data list at http://www.nlm.nih.gov/research/umls/metaa1.html |
| has_version_at_time | VERSIONED_OBJECT | True if a version for time a_time' exists. |
| has_version_id | VERSIONED_OBJECT | True if a version with an_id exists. |
| id | CODE_SET_ACCESS | External identifier of this code set. |
| id | TERMINOLOGY_ACCESS | Identification of this Terminology. |
| institution_specified | DV_GENERAL_TIME_SPECIFICATION | Extracted from value. |
| institution_specified | DV_PERIODIC_TIME_SPECIFICATION | Extracted from value. |
| institution_specified | DV_TIME_SPECIFICATION | Indicates if the specification is aligned with institution schedules, e.g. a hospital nursing changeover or meal serving times. Extracted from the value' attribute. |
| internal_references_valid | ARCHETYPE | True if every ARCHETYPE_INTERNAL_REF. target_path refers to a legitimate node in the archetype definition. |
| interval_start_time | INTERVAL_EVENT | Start time of the interval of this event. |
| is_archetype_root | LOCATABLE | True if this node is the root of an archetyped structure. |
| is_bag | CARDINALITY | True if the semantics of this cardinality represent a set, i.e. unordered, unique membership. |
| is_branch | OBJECT_VERSION_ID | True if this version identifier represents a branch. |
| is_branch | VERSION | True if this Version represents a branch. Derived from uid attribute. |
| is_branch | VERSION_TREE_ID | True if this version identifier represents a branch, i.e. has branch_number and branch_version parts. |
| is_compressed | DV_MULTIMEDIA | Computed from the value of the compression_algorithm attribute: True if the data is stored in compressed form. |
| is_external | DV_MULTIMEDIA | Computed from the value of the uri attribute: True if the data is stored externally to the record, as indicated by `uri'. A copy may also be stored internally, in which case `is_expanded' is also true. |
| is_in_range | REFERENCE_RANGE | Indicates if the value val' is inside the range. |
| is_inline | DV_MULTIMEDIA | Computed from the value of the data attribute. True if the data is stored in expanded form, ie within the EHR itself. |
| is_integral | DV_PROPORTION | True if the numerator and denominator values are integers, i.e. if the precision is 0. |
| is_integral | DV_QUANTITY | |
| is_list | CARDINALITY | True if the semantics of this cardinality represent a list, i.e. ordered, non-unique membership. |
| is_merged | ORIGINAL_VERSION | True if this Version was created from more than just the preceding (checked out) version. |
| is_normal | DV_ORDERED | Value is in the normal range, determined by comparison of the value to the normal_range if present, or by the normal_status marker if present. |
| is_null | ELEMENT | True if value logically not known, e.g. if indeterminate, not asked etc. |
| is_original_version | VERSIONED_OBJECT | True if version with an_id is an ORIGINAL_VERSION. |
| is_periodic | HISTORY | Indicates whether history is periodic. |
| is_persistent | COMPOSITION | True if category is a persistent type, False otherwise. Useful for finding Compositions in an EHR which are guaranteed to be of interest to most users. |
| is_persistent | VERSIONED_COMPOSITION | Indicates whether this composition set is persistent; derived from first version. |
| is_set | CARDINALITY | True if the semantics of this cardinality represent a bag, i.e. unordered, non-unique membership. |
| is_simple | DV_ORDERED | True if this quantity has no reference ranges. |
| is_specialised | ARCHETYPE | True if this archetype is a specialisation of another. |
| is_strictly_comparable_to | DV_DATE | Test if two instances are strictly comparable. |
| is_strictly_comparable_to | DV_DATE_TIME | Test if two instances are strictly comparable. |
| is_strictly_comparable_to | DV_ORDERED | Test if two instances are strictly comparable. |
| is_strictly_comparable_to | DV_TIME | Test if two instances are strictly comparable. |
| is_subset_of | ARCHETYPE_CONSTRAINT | True if constraints represented by other are narrower than this node. Note: not easily evaluatable for CONSTRAINT_REF nodes. |
| is_valid | ARCHETYPE | True if the archetype is valid overall; various tests should be used, including checks on node_ids, internal references, and constraint references. |
| is_valid | ARCHETYPE_CONSTRAINT | True if this node (and all its sub-nodes) is a valid archetype node for its type. This function should be implemented by each subtype to perform semantic validation of itself, and then call the is_valid function in any subparts, and generate the result appropriately. |
| is_valid_units_string | MEASUREMENT_SERVICE | True if the units string units' is a valid string according to the HL7 UCUM specification. |
| item | Hash | Return item for key a_key'. Equivalent to ISO 11404 fetch operation. |
| item_at_path | PATHABLE | The item at a path (relative to this item); only valid for unique paths, i.e. paths that resolve to a single item. |
| item_count | ITEM_LIST | |
| items_at_path | PATHABLE | List of items corresponding to a non-unique path. |
| languages_available | AUTHORED_RESOURCE | Total list of languages available in this resource, derived from original_language and translations. |
| latest_trunk_version | VERSIONED_OBJECT | Return the most recently added trunk version. |
| latest_version | VERSIONED_OBJECT | Return the most recently added version (i.e. on trunk or any branch). |
| lifecycle_state | IMPORTED_VERSION | Lifecycle state of the content item in wrapped ORIGINAL_VERSION, derived as item.lifecycle_state. |
| lifecycle_state | VERSION | Lifecycle state of this version; coded by openEHR vocabulary version lifecycle state . |
| limits | DV_ORDINAL | Limits of the ordinal enumeration, to allow comparison of an ordinal value to its limits. |
| logical_paths | ARCHETYPE | Set of language-dependent paths extracted from archetype. Paths obey the same syntax as physical_paths, but with node_ids replaced by their meanings from the ontology. |
| magnitude | DV_DATE | Numeric value of the date as days since the calendar origin point 1/1/0000. |
| magnitude | DV_DATE_TIME | numeric value of the date/time as seconds since the calendar origin point. |
| magnitude | DV_PROPORTION | Effective magnitude represented by ratio. |
| magnitude | DV_TIME | Numeric value of the time as seconds since the start of day. |
| members | C_MULTIPLE_ATTRIBUTE | List of constraints representing members of the container value of this attribute within the data. Semantics of the uniqueness and ordering of items in the container are given by the cardinality. |
| most_recent_version | REVISION_HISTORY | The version id of the most recent item, as a String. |
| most_recent_version_time_committed | REVISION_HISTORY | The commit date/time of the most recent item, as a String. |
| name | TERMINOLOGY_ID | 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. |
| names | ITEM_LIST | |
| node_ids_valid | ARCHETYPE | True if every node_id found on a C_OBJECT node is found in ontology.term_codes. |
| object_id | OBJECT_VERSION_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. |
| offset | EVENT | Offset of this event from origin, computed as time.diff(parent.origin) |
| openehr_code_sets | TERMINOLOGY_SERVICE | Set of all code set identifiers known in the terminology service. |
| operator+ | DV_AMOUNT | Sum of this quantity and another whose formal type must be the difference type of this quantity. |
| operator- | DV_AMOUNT | Negated version of current object, such as used for representing a difference, e.g. a weight loss. |
| operator< | DV_DATE | Tests if this date is earlier than the cited date. |
| operator< | DV_ORDERED | Tests if this item is less than other, which must be of the same concrete type. |
| operator= | DV_AMOUNT | |
| operator= | DV_PROPORTION | assignment operator |
| owner_id | VERSION | Unique identifier of the owning VERSIONED_OBJECT. |
| parent | PATHABLE | Parent of this node in a compositional hierarchy. |
| path | ARCHETYPE_CONSTRAINT | Path of this node relative to root of archetype. |
| path | DV_URI | A string whose format is a function of the scheme. Identifies the location in <scheme>-space of an information entity. Typical values include hierarchical directory paths for any machine. For example, with scheme = "ftp", path might be /pub/images/image_01. The strings "." and ".." are reserved for use in the path. Paths may include internet/intranet location identifiers of the form: sub_domain...domain, e.g. "info.cern.ch" |
| path_exists | PATHABLE | True if the path exists in the data with respect to the current item. |
| path_of_item | PATHABLE | The path to an item relative to the root of this archetyped structure. |
| path_unique | PATHABLE | True if the path corresponds to a single item in the data. |
| period | DV_PERIODIC_TIME_SPECIFICATION | The period of the repetition, computationally derived from the syntax representation. Extracted from the value' attribute. |
| physical_paths | ARCHETYPE | Set of language-independent paths extracted from archetype. Paths obey Xpath-like syntax and are formed from alternations of C_OBJECT.node_id and C_ATTRIBUTE.rm_attribute_name values. |
| preceding_version_uid | IMPORTED_VERSION | Computed version of inheritance precursor, derived as item.preceding_version_uid. |
| preceding_version_uid | VERSION | Unique identifier of the version of which this version is a modification; Void if this is the first version. |
| previous_version | ARCHETYPE | Version of predecessor archetype of this archetype, if any. |
| qualified_rm_entity | ARCHETYPE_ID | Globally qualified reference model entity, e.g. openehr-composition-OBSERVATION . |
| query | DV_URI | Query string to send to application implied by scheme and path. Enables queries to applications, including databases to be included in the URI. Supports any query meaningful to the server, including SQL. |
| revision_history | VERSIONED_OBJECT | History of all audits and attestations in this versioned repository. |
| rm_entity | ARCHETYPE_ID | Name of the ontological level within the reference model to which this archetype is targeted, e.g. for openEHR, folder , composition , section , entry . |
| rm_name | ARCHETYPE_ID | Name of the reference model, e.g. rim , ehr_rm , en13606 . |
| rm_originator | ARCHETYPE_ID | Organisation originating the reference model on which this archetype is based, e.g. openehr , cen , hl7 . |
| root | UID_BASED_ID | 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. |
| rubric_for_code | TERMINOLOGY_ACCESS | Return all rubric of code code' in language lang'. |
| scheme | DV_URI | A distributed information "space" in which information objects exist. The scheme simultaneously specifies an information space and a mechanism for accessing objects in that space. For example if scheme = "ftp", it identifies the information space in which all ftpable objects exist, and also the application - ftp - which can be used to access them. Values may include: "ftp", "telnet", "mailto", "gopher" and many others. Refer to WWW URI RFC for a full list. New information spaces can be accommodated within the URI specification. |
| scheme | EHR_ACCESS | The name of the access control scheme in use; corresponds to the concrete instance of the settings attribute. |
| short_concept_name | ARCHETYPE | The short concept name of the archetype extracted from the archetype_id. |
| size | DV_ENCAPSULATED | Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc. do not change the value of this attribute. |
| size | DV_MULTIMEDIA | Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc do not change the value of this attribute. |
| size | DV_PARSABLE | Size in bytes of value. |
| source | TEMPLATE_NODE_SPEC | |
| specialisation | ARCHETYPE_ID | Name of specialisation of concept, if this archetype is a specialisation of another archetype, e.g. cholesterol . |
| specialisation_depth | ARCHETYPE | Specialisation depth of this archetype; larger than 0 if this archetype has a parent. Derived from ontology.specialisation_depth. |
| subject_is_self | ENTRY | Returns True if this Entry is about the subject of the EHR, in which case the subject attribute is of type PARTY_SELF. |
| subtract | DV_ABSOLUTE_QUANTITY | Result of subtracting a differential amount from this quantity. |
| subtract | DV_DATE | Subtract a time period from this date. |
| subtract | DV_DATE_TIME | Subtract a time period from this date_time. |
| subtract | DV_TIME | Subtract a duration from this time. |
| target | TEMPLATE_NODE_SPEC | |
| term_binding | ARCHETYPE_ONTOLOGY | |
| term_definition | ARCHETYPE_ONTOLOGY | |
| terminology | TERMINOLOGY_SERVICE | Return an interface to the terminology named name. Allowable names include:- openehr centc251 any name from are taken from the US NLM UMLS meta-data list at http://www.nlm.nih.gov/research/umls/metaa1.html |
| terminology_identifiers | TERMINOLOGY_SERVICE | 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 |
| trunk_lifecycle_state | VERSIONED_OBJECT | Return the lifecycle state from the latest trunk version. Useful for determining if the version container is logically deleted. |
| trunk_version | VERSION_TREE_ID | Trunk version number; numbering starts at 1. |
| uid | IMPORTED_VERSION | Computed version of inheritance precursor, derived as item.uid. |
| uid | VERSION | Unique identifier of this version, containing owner_id, version_tree_id and creating_system_id. |
| units_equivalent | MEASUREMENT_SERVICE | True if two units strings correspond to the same measured property. |
| valid_code_set_id | OPENEHR_CODE_SET_IDENTIFIERS | Validity function to test if an identifier is in the set defined by this class. |
| valid_magnitude_status | DV_QUANTIFIED | Test whether a string value is one of the valid values for the magnitude_status attribute. |
| valid_percentage | DV_AMOUNT | Test whether a number is a valid percentage, i.e. between 0 and 100. |
| valid_proportion_kind | PROPORTION_KIND | True if n is one of the defined types. |
| valid_terminology_group_id | OPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS | Validity function to test if an identifier is in the set defined by this class. |
| valid_value | C_DEFINED_OBJECT | True if a_value is valid with respect to constraint expressed in concrete instance of this type. |
| valid_value | C_PRIMITIVE | True if a_value is valid with respect to constraint expressed in concrete instance of this type. |
| validity_is_range | C_DATE | |
| validity_is_range | C_DATE_TIME | |
| validity_is_range | C_TIME | True if validity is in the form of a range; useful for developers to check which kind of constraint has been set. |
| version | ARCHETYPE | Version of this archetype, extracted from id. |
| version_at_time | VERSIONED_OBJECT | Return the version for time a_time'. |
| version_count | VERSIONED_OBJECT | Return the total number of versions in this object. |
| version_id | ARCHETYPE_ID | Version of this archetype. |
| version_id | TERMINOLOGY_ID | Version of this terminology, if versioning supported, else the empty string. |
| version_tree_id | 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 . |
| version_with_id | VERSIONED_OBJECT | Return the version with id = a_ver_id'. |
| ~DV_ENCAPSULATED | DV_ENCAPSULATED | |
| ~DV_MULTIMEDIA | DV_MULTIMEDIA | |
| ~DV_ORDERED | DV_ORDERED | |
| ~DV_TIME_SPECIFICATION | DV_TIME_SPECIFICATION | Destructor |
| ~PATHABLE | PATHABLE |