C

NameKindDescription
C_ATTRIBUTEclassAbstract model of constraint on any kind of attribute node.
C_ATTRIBUTEartifact
C_BOOLEANclassConstraint on instances of Boolean.
Both attributes cannot be set to False, since this would mean that the Boolean
value being constrained cannot be True or False.
C_BOOLEANartifact
C_CODE_PHRASEclassExpress constraints on instances of CODE_PHRASE. The terminology_id attribute
may be specified on its own to indicate any term from a specified terminology;
the code_list attribute may be used to limit the codes to a specific list.
C_CODE_PHRASEartifact
C_COMPLEX_OBJECTclassConstraint on complex objects, i.e. any object that consists of other object constraints.
C_COMPLEX_OBJECTartifact
C_DATEclassISO 8601-compatible constraint on instances of Date in the form either of a set of
validity values, or an actual date range. There is no validity flag for year', since it
must always be by definition mandatory in order to have a sensible date at all.
Syntax expressions of instances of this class include YYYY-??-?? (date with
optional month and day).
Date ranges are probably only useful for historical dates.
C_DATEartifact
C_DATE_TIMEclassISO 8601-compatible constraint on instances of Date_Time. There is no validity
flag for year', since it must always be by definition mandatory in order to have a
sensible date/time at all. Syntax expressions of instances of this class include
YYYY-MM-DDT??:??:?? (date/time with optional time) and
YYYY-MM-DDTHH:MM:xx (date/time, seconds not allowed).
C_DATE_TIMEartifact
C_DEFINED_OBJECTclassAbstract parent type of C_OBJECT subtypes that are defined by value, i.e. whose
definitions are actually in the archetype rather than being by reference.
C_DEFINED_OBJECTartifact
C_DOMAIN_TYPEclassAbstract parent type of domain-specific constrainer types, to be defined in external packages.
C_DOMAIN_TYPEartifact
C_DURATIONclassISO 8601-compatible constraint on instances of Duration. In ISO 8601 terms,
constraints might are of the form PWD (weeks and/or days), PDTHMS (days,
hours, minutes, seconds) and so on. In official ISO 8601:2004, the W' (week)
designator cannot be mixed in; allowing it is an openEHR-wide exception.
C_DURATIONartifact
C_DV_ORDINALclassClass specifying constraints on instances of DV_ORDINAL. Custom constrainer
type for instances of DV_ORDINAL.
C_DV_QUANTITYclassConstrain instances of DV_QUANTITY.
C_DV_STATEclassConstrainer type for DV_STATE instances. The attribute c_value defines a
state/event table which constrains the allowed values of the attribute value in a
DV_STATE instance, as well as the order of transitions between values.
C_DV_STATEartifact
C_INTEGERclassConstraint on instances of Integer.
C_INTEGERartifact
C_MULTIPLE_ATTRIBUTEclassAbstract model of constraint on any kind of attribute node.
C_MULTIPLE_ATTRIBUTEartifact
C_OBJECTclassAbstract model of constraint on any kind of object node.
C_OBJECTartifact
C_PRIMITIVEclassAbstract supertype of all constrained primitive types.
C_PRIMITIVEartifact
C_PRIMITIVE_OBJECTclassConstraint on a primitive type.
C_PRIMITIVE_OBJECTartifact
C_QUANTITY_ITEMclassConstrain instances of DV_QUANTITY.
C_REALclassConstraint on instances of Real.
C_REALartifact
C_REFERENCE_OBJECTclassAbstract parent type of C_OBJECT subtypes that are defined by reference.
C_REFERENCE_OBJECTartifact
C_SINGLE_ATTRIBUTEclassPurpose Concrete model of constraint on a single-valued attribute node. The meaning of
the inherited children attribute is that they are alternatives.
C_SINGLE_ATTRIBUTEartifact
C_STRINGclassConstraint on instances of STRING.
C_STRINGartifact
C_TIMEclassISO 8601-compatible constraint on instances of Time. There is no validity flag
for hour', since it must always be by definition mandatory in order to have a
sensible time at all. Syntax expressions of instances of this class include HH:??:xx
(time with optional minutes and seconds not allowed).
C_TIMEartifact
calendar_alignmentoperationCalendar alignment extracted from value.
calendar_alignmentoperationCalendar alignment extracted from value.
calendar_alignmentoperationIndicates 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_formoperationCanonical form of Version object, created by serialising all attributes except
signature.
cardinalityrelationCardinality of this attribute constraint, if it constraints a container attribute.
CARDINALITYclassExpress constraints on the cardinality of container objects which are the values of
multiply-valued attributes, including uniqueness and ordering, providing the
means to state that a container acts like a logical list, set or bag. The cardinality
cannot contradict the cardinality of the corresponding attribute within the relevantreference model.
CARDINALITYartifact
cardinalityattribute
CARE_ENTRYclassThe abstract parent of all clinical ENTRY subtypes. A CARE_ENTRY
defines protocol and guideline attributes for all clinical Entry subtypes.
CARE_ENTRYartifact
careflow_stepattributeThe step in the careflow process which occurred as part of generating
this action, e.g. dispense , start_administration . This attribute represents
the clinical label for the activity, as opposed to current_state which
represents the state machine (ISM) computable form. Defined in archetype.
categoryattributeIndicates what broad category this Composition is belogs to, e.g.
persistent - of longitudinal validity, event , process etc.
change_controlpackageAs described in the Architecture Overview document, formal version control and change
management are used in openEHR to support the construction of EHR and other repositories
requiring the properties of consistency, indelibility, traceability and distributed sharing. The
rm.common.change_control package supplies the formal specification of these features in openEHR.
change_control_class_diag (rm)class diagram
change_control_cvclass view
change_control_dvdeployment view
change_typeattributeType of change. Coded using the openEHR Terminology audit change type group.
charsetattributeName of character encoding scheme in which this value is encoded. Coded from openEHR
Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8
being the assumed encoding. This attribute allows for variations from these assumptions.
childrenrelationChild C_OBJECT nodes. Each such node represents a constraint on the type of this
attribute in its reference model. Multiples occur both for multiple items in the case of
container attributes, and alternatives in the case of singular attributes.
CLUSTERclassThe grouping variant of ITEM, which may contain further instances of ITEM, in
an ordered list.
CLUSTERartifact
codeattribute
code_listattribute
List of allowed codes; may be empty, meaning any code in the terminology may be
used.
CODE_PHRASEclassA fully coordinated (i.e. all coordination has been performed) term from a ter-
minology service (as distinct from a particular terminology).
CODE_PHRASEartifact
code_setoperationReturn an interface to the code_set identified by the external identifier name
(e.g. ISO_639-1 ).
CODE_SET_ACCESSclassDefines an object providing proxy access to a code_set.
CODE_SET_ACCESSartifact
code_set_for_idoperationReturn an interface to the code_set identified internally in openEHR by id.
Code_set_id_character_setsattribute
Code_set_id_compression_algorithmsattribute
Code_set_id_countriesattribute
Code_set_id_languagesattribute
Code_set_id_media_typesattribute
Code_set_id_normal_statusesattribute
code_set_identifiersoperationSet of all code sets identifiers for which there is an internal openEHR name;
returned as a Map of ids keyed by internal name.
Code_set_integrity_check_algorithmsattribute
code_stringattributeThe key used by the terminology service to identify a concept or coordination of
concepts. This string is most likely parsable inside the terminology service, but
nothing can be assumed about its syntax outside that context.
codes_for_group_idoperationReturn all codes under grouper group_id' from this terminology.
codes_for_group_nameoperationReturn all codes under grouper whose name in lang' is name' from this terminology.
commit_attestationoperationAdd a new attestation to a specified original version. Attestations can only be
added to Original versions.
commit_auditrelationAudit trail corresponding to the committal of this
version to the VERSIONED_OBJECT.
commit_imported_versionoperationAdd a new imported version. Details of version id etc come from the
ORIGINAL_VERSION being committed.
commit_original_merged_versionoperationAdd a new original merged version. This commit function adds a parameter
containing the ids of other versions merged into the current one.
commit_original_versionoperationAdd a new original version.
committerrelationIdentity and optional reference into identity management service, of user who
committed the item.
commonpackageThe common Reference Model comprises a number of packages containing abstract concepts and
design patterns used in higher level openEHR models. Several concepts recur in higher level packages.
The classes LOCATABLE and ARCHETYPED provide the link between information and archetype models.
The classes ATTESTATION and PARTICIPATION are generic domain concepts that appear in various reference models.
The change_control package defines a formal model of change management and versioning which applies to
any service that needs to be able to supply previous states of its information, in particular the demographic and
EHR services.
common_packages_cvclass view
common_packages_OVERVIEWclass diagramClasses comprising the common package of the openEHR Reference Model.
composerrelationThe person primarily responsible for the content of the Composition
(but not necessarily its committal into the EHR system). This is the
identifier which should appear on the screen. It may or may not
be the person who entered the data. When it is the patient, the special
self instance of PARTY_PROXY will be used.
COMPOSITIONclassOne version in a VERSIONED_COMPOSITION. A composition is considered the
unit of modification of the record, the unit of transmission in record extracts, and
the unit of attestation by authorising clinicians. In this latter sense, it may be
considered equivalent to a signed document.
compositionpackageThe rm.composition package.
The Composition is the primary data container' in the openEHR EHR and
is the root point of clinical content. Instances of the Composition class
can be considered as self-standing data aggregations, or documents in a
document-oriented system. The key information in a COMPOSITION is
found in its content, context, and composer attributes.
composition_class_diag (rm)class diagramClass diagram of the rm.composition package.
Includes COMPOSITION and EVENT_CONTEXT classes and the content package.
composition_cvclass view
composition_dvdeployment view
compositionsattributeMaster list of all composition references in this EHR.
compression_algorithmattributeCompression type, a coded value from the openEHR Integrity check code set.
Void means no compression.
conceptattribute
The normative meaning of the archetype as a whole, expressed as a local archetype code,
typically at0000 .
conceptoperationClinical concept of the archetype as a whole (= derived from the
archetype_node_id' of the root node)
concept_nameoperation
The concept name of the archetype in language a_lang; corresponds to the term
definition of the concept attribute in the archetype ontology.
constraintattribute
constraint_bindingoperation
constraint_codesattribute
constraint_definitionoperation
constraint_modelpackageThe archetype Constraint Model is completely generic, and is designed to express the semantics of constraints
on instances of classes which are themselves described in UML (or a similar object-oriented meta-model).
Accordingly, the major abstractions in this model correspond to major abstractions in object-oriented formalisms,
including several variations of the notion of object' and the notion of attribute'. The notion of object' rather
than class' or type' is used because archetypes are about constraints on data (i.e. instances', or objects') rather
than models, which are constructed from classes'.
constraint_model_class_diag (am)class diagramClasses in the am.archetype.constraint_model package
constraint_model_cvclass view
constraint_model_deploydeployment diagramShows testing module layout for am.archetype.constraint_model package.
constraint_model_dvdeployment view
constraint_model_testartifactA module for testing the am.archetype.constraint_model package.
CONSTRAINT_REFclassReference to a constraint described in the same archetype, but outside the main
constraint structure. This is used to refer to constraints expressed in terms of
external resources, such as constraints on terminology value sets.
CONSTRAINT_REFartifact
constraint_references_validoperation
True if every CONSTRAINT_REF.reference found on a C_OBJECT node in the archetype
definition is found in ontology.constraint_codes.
constraintsrelation
constraintsrelation
constraintsrelation
contentpackageThe content package contains the CONTENT_ITEM class, ancestor
class of all content types, and the navigation and entry packages,
which contain SECTION, ENTRY and related types.
contentrelationThe content of this Composition.
content_class_diag (rm)class diagramClass diagram for the rm.composition.content package.
Includes abstact class CONTENT_ITEM and the navigation and entry packages.
content_cvclass view
content_dvdeployment view
CONTENT_ITEMclassAbstract ancestor of all concrete content types.
CONTENT_ITEMartifact
contextrelationThe clinical session context of this Composition, i.e. the contextual attributes of
the clinical session.
CONTRIBUTIONclassDocuments a contribution of one or more versions added to a change-controlled
repository.
CONTRIBUTIONartifact
contributionattributeContribution in which this version was added.
contributionsattributeList of contributions causing changes to this EHR. Each contribution
contains a list of versions, which may include references to any number
of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and
VERSIONED_FOLDER.
copyrightattributeOptional copyright statement for the resource as a knowledge resource.
CRattributecarriage return character
creating_system_idoperationIdentifier of the system that created the Version corresponding to this
Object version id.
current_revisionoperationMost recent revision in revision_history if is_controlled else (uncontrolled) .
current_stateattributeThe ISM current state. Coded by openEHR terminology group
Instruction states .