A

NameKindDescription
access_controlpackageThe rm.security.access_control package.
access_control_class_diag (rm)class diagramClass diagram op the rm.security.access_control package.
Includes abstract class ACCESS_CONTROL_SETTINGS.
access_control_cvclass view
access_control_dvdeployment view
ACCESS_CONTROL_SETTINGSclassAccess Control Settings for the EHR and components.
Intended to support multiple access control schemes.
Currently implementation dependent.
ACCESS_CONTROL_SETTINGSartifact
ACCESS_GROUP_REFclassReference to access group in an access control service.
ACCESS_GROUP_REFartifact
accreditatonattributeAccreditation of translator, usually a national translator's registration
or association membership id.
accuracyattributeAccuracy of measurement, expressed as a half-range value of the diff type
for this quantity (i.e. an accuracy of x means + or x).
accuracyattributeAccuracy of measurement, expressed either
as a half-range percent value
(accuracy_is_percent = True) or a half-range
quantity. A value of 0 means that accuracy
was not recorded.
accuracy_is_percentattributeIf True, indicates that when this object was
created, accuracy was recorded as a percent
value; if False, as an absolute quantity value.
ACTIONclassUsed to record a clinical action that has been performed, which may
have been ad hoc, or due to the execution of an Activity in an Instruction
workflow. Every Action corresponds to a careflow step of some kind or another.
ACTIONartifact
actionattributeSide-effect action to execute during the firing of this transition.
action_archetype_idattributePerl-compliant regular expression pattern, enclosed in //' delimiters,
indicating the valid archetype identifiers of archetypes for Actions
corresponding to this Activity specification.
Defaults to /.*/ , meaning any archetype.
activitiesrelationList of all activities in Instruction.
ACTIVITYclassDefines a single activity within an Instruction, such as a medication
administration.
ACTIVITYartifact
activity_idattributeIdentifier of Activity within Instruction, in the form of its archetype path.
addoperationAddition of a differential amount to this quantity.
addoperationAdd a time period to this date.
addoperationAdd a time period to this date_time.
addoperationAdd a time period to this time.
adl_versionattribute
ADL version if archteype was read in from an ADL sharable archetype.
ADMIN_ENTRYclassEntry subtype for administrative information, i.e. information about setting up the
clinical process, but not itself clinically relevant. Archetypes will define contained
information.
Used for admistrative details of admission, episode, ward location, discharge,
appointment (if not stored in a practice management or appointments system).
Not to be used for any clinically significant information.
ADMIN_ENTRYartifact
all_codesoperationReturn all codes known in this code set.
all_codesoperationReturn all codes known in this terminology.
all_version_idsoperationReturn a list of ids of all versions in this object.
all_versionsoperationReturn a list of all versions in this object.
alternate_textattributeText to display in lieu of multimedia display/replay.
alternativesoperationList of alternative constraints for the single
child of this attribute within the data.
ampackageThe openEHR am package contains the models necessary to describe the semantics of archetypes and templates, and their use within openEHR. These include ADL, the Archetype Definition Language (expressed in the form of a syntax specification), the archetype and template packages, defining the object-oriented semantics of archetypes and templates, and the openehr_profile package, which defines a profile of the generic archetype model defined in the archetype package, for use in openEHR (and other health computing endeavours).
am_cvclass view
am_package_OVERVIEWclass diagram
any_allowedoperationTrue if any value (i.e. instance) of the reference model type would be allowed.
Redefined in descendants.
archetypepackage
ARCHETYPEclassArchetype equivalent to ARCHETYPED class in Common reference model.
Defines semantics of identfication, lifecycle, versioning, composition and specialisation.
An archetype is a modelled as a particular kind of AUTHORED_RESOURCE, and as such,
includes descriptive meta-data, language information and revision history. The ARCHETYPE
class adds identifying information, a definition - expressed in terms of constraints on instances of an
object model, and an ontology.
ARCHETYPEartifact
archetypepackageThe archetype service model defines the interface to online repositories of archetypes, and can be used both by GUI applications designed for human browsing as well as access by other software services such as the EHR.
archetype_class_diag (am)class diagramClasses in the am.archetype package.
Includes ARCHETYPE, VALIDITY_KIND.
ARCHETYPE_CONSTRAINTclassArchetype equivalent to LOCATABLE class in openEHR Common reference model.
Defines common constraints for any inheritor of LOCATABLE in any reference model.
ARCHETYPE_CONSTRAINTartifact
archetype_cvclass view
archetype_deploydeployment diagramShows testing module layout for am.archetype package.
archetype_detailsrelationDetails of archetyping used on this node.
archetype_dvdeployment view
archetype_idattribute
Multi-axial identifier of this archetype in archetype space.
ARCHETYPE_IDoperationConstructor passing in atomic identifier components. Beware of specialisation
and version_id semantics.
ARCHETYPE_IDoperation
archetype_idattributeGlobally unique archetype identifier.
ARCHETYPE_IDclassIdentifier for archetypes. Ideally these would identify globally uniqued archetypes.
Lexical form:
rm_originator -' rm_name -' rm_entity .' concept_name { -' specialisation }* .v' number
ARCHETYPE_IDartifact
ARCHETYPE_INTERNAL_REFclassA constraint defined by proxy, using a reference to an object constraint defined
elsewhere in the same archetype.
Note that since this object refers to another node, there are two objects with avail-
able occurrences values. The local occurrences value on an
ARCHETYPE_INTERNAL_REF should always be used; when setting this from a seri-
alised form, if no occurrences is mentioned, the target occurrences should be used
(not the standard default of {1..1}); otherwise the locally specified occurrences
should be used as normal. When serialising out, if the occurrences is the same as
that of the target, it can be left out.
ARCHETYPE_INTERNAL_REFartifact
archetype_node_idattributeDesign-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.
ARCHETYPE_ONTOLOGYclassLocal ontology of an archetype.
ARCHETYPE_ONTOLOGYartifact
ARCHETYPE_SLOTclassConstraint describing a slot' where another archetype can occur.
ARCHETYPE_SLOTartifact
ARCHETYPE_TERMclassRepresentation of any coded entity (term or constraint) in the archetype ontology.
ARCHETYPE_TERMartifact
archetype_testartifactA module for testing the am.archetype package.
ARCHETYPEDclassArchetypes act as the configuration basis for the particular structures of instances
defined by the reference model. To enable archetypes to be used to create valid
data, key classes in the reference model act as root points for archetyping;
accordingly, these classes have the archetype_details attribute set.

An instance of the class ARCHETYPED contains the relevant archetype identification
information, allowing generating archetypes to be matched up with data instances.
ARCHETYPEDartifact
archetypedpackageThe rm.common.archetyped package defines the core types PATHABLE, LOCATABLE, ARCHETYPED, and LINK
archetyped_class_diag (rm)class diagramClasses in the rm.common.archetypes package.
Includes PATHABLE, LOCATABLE, ARCHETYPED and others.
archetyped_cvclass view
archetyped_deploydeployment diagramShows testing module layout for rm.common.archetyped package.
archetyped_dvdeployment view
as_hierarchyoperationHierarchical equivalent of the physical representation of each subtype,
compatible with CEN EN 13606 structures.
as_hierarchyoperationGenerate a CEN EN13606-compatible hierarchy consisting of a single CLUSTER
containing the ELEMENTs of this list.
as_hierarchyoperationGenerate a CEN EN13606-compatible hierarchy consisting of a single
ELEMENT.
as_hierarchyoperationGenerate a CEN EN13606-compatible hierarchy consisting of a single
CLUSTER containing the CLUSTERs representing the columns of this
table.
as_hierarchyoperationGenerate a CEN EN13606-compatible hierarchy, which is the same as the
tree's physical representation.
as_urioperationA URI form of the reference, created by concatenating the following:
ehr:// + id.value + / + path
assertionpackageAssertions are expressed in archetypes in typed first-order predicate logic (FOL). They are used in
two places: to express archetype slot constraints, and to express invariants in complex object con-
straints. In both of these places, their role is to constrain something inside the archetype. Constraints
on external resources such as terminologies are expressed in the constraint binding part of the arche-
type ontology.
ASSERTIONclassStructural model of a typed first order predicate logic assertion, in the form of an
expression tree, including optional variable definitions.
ASSERTIONartifact
assertion_class_diag (am)class diagramClasses in the am.archetype.assertion package.
Includes ASSERTION, ASSERTION_VARIABLE and operator classes.
assertion_cvclass view
assertion_dvdeployment view
ASSERTION_VARIABLEclass
ASSERTION_VARIABLEartifact
assignerattributeOrganisation that assigned the id to the item being identified.
assumedpackage
assumed_class_diag (rm)class diagram
assumed_cvclass view
assumed_dvdeployment view
assumed_typespackagesome Assumed Types for the openEHR Reference Model.
assumed_types_class_diag (rm)class diagramTypes normally provided by implementation technology via a class library.
assumed_types_cvclass view
assumed_types_dvdeployment view
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeValue to be assumed if none sent in data.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueoperationValue to be assumed if none sent in data.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueattributeThe value to assume if this item is not included in data, due to being part of an
optional structure.
ATTESTATIONclassRecord an attestation of a party (the committer) to item(s) of record content.
An attestation is an explicit signing by one healthcare agent of particular
content for various particular purposes, including:
for authorisation of a controlled substance or procedure (e.g.
sectioning of patient under mental health act);
witnessing of content by senior clinical professional;
indicating acknowledgement of content by intended recipient,
e.g. GP who ordered a test result.

ATTESTATIONartifact
attestationsrelationSet of attestations relating to this version.
attested_viewattributeOptional visual representation of content attested e.g. screen image.
attributesrelationList of constraints on attributes of the reference model type
represented by this object.
auditrelationAudit trail corresponding to the committal of this Contribution.
AUDIT_DETAILSclassThe set of attributes required to document the committal of an information item to
a repository.
AUDIT_DETAILSartifact
auditsrelationThe audits for this revision; there will always
be at least one commit audit (which may itself
be an ATTESTATION), there may also be fur-ther attestations.
authorattributeTranslator name and other demographic details.
AUTHORED_RESOURCEclassAbstract idea of an online resource created by a human author.
AUTHORED_RESOURCEartifact