OpenEHR Base package
0.1.0 - First Draft International flag

OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

ACCESS_CONTROL_SETTINGS

EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object.

ACTION

Used 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.

ACTIVITY

Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms.

ACTOR

Ancestor of all real-world types, including people and organisations. An actor is any real-world entity capable of taking on a role.

ADDRESS

Address of contact, which may be electronic or geographic.

ADMIN_ENTRY

Entry 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 administrative 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.

AGENT

Generic concept of any kind of agent, including devices, software systems, but not humans or organisations.

ARCHETYPED

Archetypes 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.

ARCHETYPE_ID

Identifier for archetypes. Ideally these would identify globally unique archetypes. Lexical form: rm_originator '-' rm_name '-' rm_entity '.' concept_name { '-' specialisation }* '.v' number.

ATTESTATION

Record 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.
AUDIT_DETAILS

The set of attributes required to document the committal of an information item to a repository.

AUTHORED_RESOURCE

Abstract idea of an online resource created by a human author.

Annotations
Any

Abstract ancestor class for all other classes. Usually maps to a type like Any or Object in an object-oriented technology. Defined here to provide value and reference equality semantics.

CAPABILITY

Capability of a role, such as ehr modifier, health care provider. Capability should be backed up by credentials.

CARE_ENTRY

The abstract parent of all clinical ENTRY subtypes. A CARE_ENTRY defines protocol and guideline attributes for all clinical Entry subtypes.

CLUSTER

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

CODE_PHRASE

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

COMPOSITION

Content of one 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. NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.

CONTACT

Description of a means of contact of a Party. Actual structure is archetyped.

CONTENT_ITEM

Content of one version in a VERSIONED_CONTENT_ITEM. 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. NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.

CONTRIBUTION

Documents a Contribution (change set) of one or more versions added to a change-controlled repository.

DATA_STRUCTURE

Abstract parent class of all data structure types. Includes the as_hierarchy function which can generate the equivalent CEN EN13606 single hierarchy for each subtype’s physical representation. For example, the physical representation of an ITEM_LIST is List<ELEMENT>; its implementation of as_hierarchy will generate a CLUSTER containing the set of ELEMENT nodes from the list.

DATA_VALUE

Abstract parent of all DV_ data value types. Serves as a common ancestor of all data value types in openEHR models

DV_ABSOLUTE_QUANTITY

Abstract class defining the concept of quantified entities whose values are absolute with respect to an origin. Dates and Times are the main example.

DV_AMOUNT

Abstract class defining the concept of relative quantified 'amounts'. For relative quantities, the + and - operators are defined (unlike descendants of DV_ABSOLUTE_QUANTITY, such as the date/time types).

DV_BOOLEAN

Items which are truly boolean data, such as true/false or yes/no answers. For such data, it is important to devise the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.

DV_CODED_TEXT

A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE (effectively a code) and the rubric of that term, from a terminology service, in the language in which the data were authored.

DV_COUNT

Countable quantities. Used for countable types such as pregnancies and steps (taken by a physiotherapy patient), number of cigarettes smoked in a day.

DV_DATE

Represents an absolute point in time, as measured on the Gregorian calendar, and specified only to the day. Semantics defined by ISO 8601. Used for recording dates in real world time. The partial form is used for approximate birth dates, dates of death, etc.

DV_DATE_TIME

Represents an absolute point in time, specified to the second. Semantics defined by ISO 8601. Used for recording a precise point in real world time, and for approximate time stamps, e.g. the origin of a HISTORY in an OBSERVATION which is only partially known.

DV_DURATION

Represents a period of time with respect to a notional point in time, which is not specified. A sign may be used to indicate the duration is backwards in time rather than forwards. Used for recording the duration of something in the real world, particularly when there is a need a) to represent the duration in customary format, i.e. days, hours, minutes etc, and b) if it will be used in computational operations with date/time quantities, i.e. additions, subtractions etc.

DV_EHR_URI

A DV_EHR_URI is a DV_URI which has the scheme name 'ehr', and which can only reference items in EHRs. Used to reference items in an EHR, which may be the same as the current EHR (containing this link), or another.

DV_ENCAPSULATED

Abstract class defining the common meta-data of all types of encapsulated data.

DV_GENERAL_TIME_SPECIFICATION

Specifies points in time in a general syntax. Based on the HL7v3 GTS data type.

DV_IDENTIFIER

Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on. DV_IDENTIFIER is used to represent any identifier of a real thing, issued by some authority or agency.

DV_INTERVAL

Generic class defining an interval (i.e. range) of a comparable type. An interval is a contiguous subrange of a comparable base type. Used to define intervals of dates, times, quantities (whose units match) and so on. The type parameter, T, must be a descendant of the type DV_ORDERED, which is necessary (but not sufficient) for instances to be compared (strictly_comparable is also needed). Without the DV_INTERVAL class, quite a few more DV_ classes would be needed to express logical intervals, namely interval versions of all the date/time classes, and of quantity classes. Further, it allows the semantics of intervals to be stated in one place unequivocally, including the conditions for strict comparison.

DV_MULTIMEDIA

A specialisation of DV_ENCAPSULATED for audiovisual and bio-signal types. Includes further metadata relating to multimedia types which are not applicable to other subtypes of DV_ENCAPSULATED.

DV_ORDERED

Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions < and is_strictly_comparable_to(), the latter of which must evaluate to True for instances being compared with the < function, or used as limits in the DV_INTERVAL<T> class

DV_ORDINAL

Generic class defining an interval (i.e. range) of a comparable type. An interval is a contiguous subrange of a comparable base type. Used to define intervals of dates, times, quantities (whose units match) and so on. The type parameter, T, must be a descendant of the type DV_ORDERED, which is necessary (but not sufficient) for instances to be compared (strictly_comparable is also needed). Without the DV_ORDINAL class, quite a few more DV_ classes would be needed to express logical intervals, namely interval versions of all the date/time classes, and of quantity classes. Further, it allows the semantics of intervals to be stated in one place unequivocally, including the conditions for strict comparison.

DV_PARAGRAPH

DEPRECATED: use markdown formatted DV_TEXT instead. Original definition: A logical composite text value consisting of a series of DV_TEXTs, i.e. plain text (optionally coded) potentially with simple formatting, to form a larger tract of prose, which may be interpreted for display purposes as a paragraph.

DV_PARSABLE

Encapsulated data expressed as a parsable String. The internal model of the data item is not described in the openEHR model in common with other encapsulated types, but in this case, the form of the data is assumed to be plaintext, rather than compressed or other types of large binary data.

DV_PERIODIC_TIME_SPECIFICATION

Specifies periodic points in time, linked to the calendar (phase-linked), or a real world repeating event, such as breakfast (event-linked). Based on the HL7v3 data types PIVL<T> and EIVL<T>.

DV_PROPORTION

Countable quantities. Used for countable types such as pregnancies and steps (taken by a physiotherapy patient), number of cigarettes smoked in a day.

DV_QUANTIFIED

Abstract class defining the concept of true quantified values, i.e. values which are not only ordered, but which have a precise magnitude.

DV_QUANTITY

Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set. Can also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).

DV_SCALE

A data type that represents scale values, where there is: a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed. Example: &#xD; Borg CR 10 Scale&#xD; &#xD; 0 No Breathlessness at all&#xD; 0.5 Very Very Slight (Just Noticeable)&#xD; 1 Very Slight&#xD; 2 Slight Breathlessness&#xD; 3 Moderate&#xD; ... etc&#xD; For scores that include only Integers, DV_SCALE may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.

DV_STATE

For representing state values which obey a defined state machine, such as a variable representing the states of an instruction or care process.

DV_TEMPORAL

Specialised temporal variant of DV_ABSOLUTE_QUANTITY whose diff type is DV_DURATION.

DV_TEXT

A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc (i.e. one DV_TEXT may be more than one word). Visual formatting and hyperlinks may be included via markdown.

DV_TIME

Represents an absolute point in time from an origin usually interpreted as meaning the start of the current day, specified to a fraction of a second. Semantics defined by ISO 8601. Used for recording real world times, rather than scientifically measured fine amounts of time. The partial form is used for approximate times of events and substance administrations.

DV_TIME_SPECIFICATION

This is an abstract class of which all timing specifications are specialisations. Specifies points in time, possibly linked to the calendar, or a real world repeating event, such as breakfast.

DV_URI

A reference to an object which structurally conforms to the Universal Resource Identifier (URI) RFC-3986 standard. The reference is contained in the value attribute, which is a String. So-called 'plain-text URIs' that contain RFC-3986 forbidden characters such as spaces etc, are allowed on the basis that they need to be RFC-3986 encoded prior to use in e.g. REST APIs or other contexts relying on machine-level conformance.

EHR

The EHR object is the root object and access point of an EHR for a subject of care.

EHR_ACCESS

EHR-wide access control object. All access decisions to data in the EHR must be made in accordance with the policies and rules in this object.

EHR_STATUS

Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.

ELEMENT

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

ENTRY

The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition. An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.

EVALUATION

Entry type for evaluation statements. Used for all kinds of statements which evaluate other information, such as interpretations of observations, diagnoses, differential diagnoses, hypotheses, risk assessments, goals and plans. Should not be used for actionable statements such as medication orders - these are represented using the INSTRUCTION type.

EVENT

Defines the abstract notion of a single event in a series. This class is generic, allowing types to be generated which are locked to particular spatial types, such as EVENT<ITEM_LIST>. Subtypes express point or intveral data.

EVENT_CONTEXT

Documents the context information of a healthcare event involving the subject of care and the health system. The context information recorded here are independent of the attributes recorded in the version audit, which document the system interaction context, i.e. the context of a user interacting with the health record system. Healthcare events include patient contacts, and any other business activity, such as pathology investigations which take place on behalf of the patient.

FEEDER_AUDIT

The FEEDER_AUDIT class defines the semantics of an audit trail which is constructed to describe the origin of data that have been transformed into openEHR form and committed to the system.

FEEDER_AUDIT_DETAILS

Audit details for any system in a feeder system chain. Audit details here means the general notion of who/where/when the information item to which the audit is attached was created. None of the attributes is defined as mandatory, however, in different scenarios, various combinations of attributes will usually be mandatory. This can be controlled by specifying feeder audit details in legacy archetypes.

FOLDER

The concept of a named folder. It is strongly recommended that the inherited attribute uid be populated in top-level (i.e. tree-root) FOLDER objects, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the top FOLDER object.

GENERIC_ID

Generic identifier type for identifiers whose format is otherwise unknown to openEHR. Includes an attribute for naming the identification scheme (which may well be local).

GROUP

A group is a real world group of parties which is created by another party, usually an organisation, for some specific purpose. A typical clinical example is that of the specialist care team, e.g. cardiology team . The members of the group usually work together.

HIER_OBJECT_ID

Concrete type corresponding to hierarchical identifiers of the form defined by UID_BASED_ID.

HISTORY

Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of ITEM_STRUCTURE, ensuring that each Event in the events of a given instance is of the same structural type, i.e. ITEM_TREE, ITEM_LIST etc. For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the EVENT.offset must be a multiple of period for each Event. Missing events in a period History are however allowed.

IMPORTED_VERSION

Versions whose content is an ORIGINAL_VERSION copied from another location; this class inherits commit_audit and contribution from VERSION<T>, providing imported versions with their own audit trail and Contribution, distinct from those of the imported ORIGINAL_VERSION.

INSTRUCTION

Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms.

INSTRUCTION_DETAILS

Used to record details of the Instruction causing an Action.

INTERNET_ID

Model of a reverse internet domain, as used to uniquely identify an internet domain. In the form of a dot-separated string in the reverse order of a domain name, specified by IETF RFC 1034.

INTERVAL_EVENT

Defines a single interval event in a series.

ISM_TRANSITION

Model of a transition in the Instruction State Machine, caused by a careflow step. The attributes document the careflow step as well as the ISM transition.

ISO_OID

Model of ISO’s Object Identifier (oid) as defined by the standard ISO/IEC 8824. Oids are formed from integers separated by dots. Each non-leaf node in an Oid starting from the left corresponds to an assigning authority, and identifies that authority’s namespace, inside which the remaining part of the identifier is locally unique.

ITEM

The abstract parent of CLUSTER and ELEMENT representation classes.

ITEM_LIST

Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty. ITEM_LIST is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc. Not to be used for time-based lists, which should be represented with the proper temporal class, i.e. HISTORY.

ITEM_SINGLE

Logical single value data structure. Used to represent any data which is logically a single value, such as a person’s height or weight.

ITEM_STRUCTURE

Abstract parent class of all spatial data types.

ITEM_TABLE

Logical relational database style table data structure, in which columns are named and ordered with respect to each other. Implemented using Cluster-per-row encoding. Each row Cluster must have an identical number of Elements, each of which in turn must have identical names and value types in the corresponding positions in each row. Some columns may be designated key' columns, containing key data for each row, in the manner of relational tables. This allows row-naming, where each row represents a body site, a blood antigen etc. All values in a column have the same data type. Used for representing any data which is logically a table of values, such as blood pressure, most protocols, many blood tests etc. Misuse: Not to be used for time-based data, which should be represented with the temporal class HISTORY. The table may be empty.

ITEM_TAG

A tag with optional value that is associated with a target information entity identified by a UID.

ITEM_TREE

Logical tree data structure. The tree may be empty. Used for representing data which are logically a tree such as audiology results, microbiology results, biochemistry results.

LINK

The LINK type defines a logical relationship between two items, such as two ENTRYs or an ENTRY and a COMPOSITION. Links can be used across compositions, and across EHRs. Links can potentially be used between interior (i.e. non archetype root) nodes, although this probably should be prevented in archetypes. Multiple LINKs can be attached to the root object of any LINK structure to give the effect of a 1→N link. 1:1 and 1:N relationships between LINK content elements (e.g. ENTRYs) can be expressed by using one, or more than one, respectively, LINKs. Chains of links can be used to see problem threads or other logical groupings of items. Links should be between LINK structures only, i.e. between objects representing complete domain concepts because relationships between sub-elements of whole concepts are not necessarily meaningful, and may be downright confusing. Sensible links only exist between whole ENTRYs, SECTIONs, COMPOSITIONs and so on.

LOCATABLE

The LOCATABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of LOCATABLE. The defining characteristics of LOCATABLE objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient.

LOCATABLE_REF

Reference to a LOCATABLE instance inside the top-level content structure inside a VERSION<T> identified by the id attribute. The path attribute is applied to the object that VERSION.data points to

OBJECT_ID

Ancestor class of identifiers of informational objects. Ids may be completely meaningless, in which case their only job is to refer to something, or may carry some information to do with the identified object. Object ids are used inside an object to identify that object. To identify another object in another service, use an OBJECT_REF, or else use a UID for local objects identified by UID. If none of the subtypes is suitable, direct instances of this class may be used.

OBJECT_REF

Class describing a reference to another object, which may exist locally or be maintained outside the current namespace, e.g. in another service. Services are usually external, e.g. available in a LAN (including on the same host) or the internet via Corba, SOAP, or some other distributed protocol. However, in small systems they may be part of the same executable as the data containing the Id.

OBJECT_VERSION_ID

Globally unique identifier for one version of a versioned object; lexical form: object_id '::' creating_system_id '::' version_tree_id.

OBSERVATION

Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred. OBSERVATION data is expressed using the class HISTORY<T>, which guarantees that it is situated in time. OBSERVATION is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported phenomena, e.g. pain. Not to be used for recording opinion or future statements of any kind, including instructions, intentions, plans etc.

ORGANISATION

Generic description of organisations. An organisation is a legally constituted body whose existence (in general) outlives the existence of parties considered to be part of it.

ORIGINAL_VERSION

A Version containing locally created content and optional attestations.

PARTICIPATION

Model of a participation of a Party (any Actor or Role) in an activity. Used to represent any participation of a Party in some activity, which is not explicitly in the model, e.g. assisting nurse. Can be used to record past or future participations. Should not be used in place of more permanent relationships between demographic entities.

PARTY

Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The name attribute inherited from LOCATABLE is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the identities attribute, not the name attribute).

PARTY_IDENTIFIED

Proxy data for an identified party other than the subject of the record, minimally consisting of human-readable identifier(s), such as name, formal (and possibly computable) identifiers such as NHS number, and an optional link to external data. There must be at least one of name, identifier or external_ref present. Used to describe parties where only identifiers may be known, and there is no entry at all in the demographic system (or even no demographic system). Typically for health care providers, e.g. name and provider number of an institution. Should not be used to include patient identifying information.

PARTY_IDENTITY

An identity owned by a Party, such as a person name or company name, and which is used by the Party to identify itself. Actual structure is archetyped.

PARTY_PROXY

Abstract concept of a proxy description of a party, including an optional link to data for this party in a demographic or other identity management system. Sub- typed into PARTY_IDENTIFIED and PARTY_SELF.

PARTY_REF

Identifier for parties in a demographic or identity service. There are typically a number of subtypes of the PARTY class, including PERSON, ORGANISATION, etc. Abstract supertypes are allowed if the referenced object is of a type not known by the current implementation of this class (in other words, if the demographic model is changed by the addition of a new PARTY or ACTOR subtypes, valid PARTY_REFs can still be constructed to them).

PARTY_RELATED

Proxy type for identifying a party and its relationship to the subject of the record. Use where the relationship between the party and the subject of the record must be known.

PARTY_RELATIONSHIP

Generic description of a relationship between parties.

PARTY_SELF

Party proxy representing the subject of the record. Used to indicate that the party is the owner of the record. May or may not have external_ref set.

PATHABLE

The PATHABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of PATHABLE. The defining characteristics of PATHABLE objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient.

PERSON

Generic description of persons. Provides a dedicated type to which Person archetypes can be targeted.

POINT_EVENT

Defines a single point event in a series.

REFERENCE_RANGE

Defines a named range to be associated with any DV_ORDERED datum. Each such range is particular to the patient and context, e.g. sex, age, and any other factor which affects ranges. May be used to represent normal, therapeutic, dangerous, critical etc ranges.

RESOURCE_DESCRIPTION

Defines the descriptive meta-data of a resource.

RESOURCE_DESCRIPTION_ITEM

Language-specific detail of resource description. When a resource is translated for use in another language environment, each RESOURCE_DESCRIPTION_ITEM needs to be copied and translated into the new language.

REVISION_HISTORY

Defines the notion of a revision history of audit items, each associated with the version for which that audit was committed. The list is in most-recent-first order.

REVISION_HISTORY_ITEM

An entry in a revision history, corresponding to a version from a versioned container. Consists of AUDIT_DETAILS instances with revision identifier of the revision to which the AUDIT_DETAILS instance belongs.

ROLE

Generic description of a role performed by an Actor. The role corresponds to a competency of the Party. Roles are used to define the responsibilities undertaken by a Party for a purpose. Roles should have credentials qualifying the performer to perform the role.

SECTION

Represents a heading in a heading structure, or section tree. Created according to archetyped structures for typical headings such as SOAP, physical examination, but also pathology result heading structures. Should not be used instead of ENTRY hierarchical structures.

TEMPLATE_ID

Identifier for templates. Lexical form to be determined.

TERMINOLOGY_ID

Identifier for terminologies such as accessed via a terminology query service. In this class, the value attribute identifies the Terminology in the terminology service, e.g. SNOMED-CT . A terminology is assumed to be in a particular language, which must be explicitly specified. Lexical form: name [ '(' version ')' ].

TERM_MAPPING

Items which are truly boolean data, such as true/false or yes/no answers. For such data, it is important to devise the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.

TRANSLATION_DETAILS

Class providing details of a natural language translation.

TranslatedString
UID

Abstract parent of classes representing unique identifiers which identify information entities in a durable way. UIDs only ever identify one IE in time or space and are never re-used.

UID_BASED_ID

Abstract model of UID-based identifiers consisting of a root part and an optional extension; lexical form: root '::' extension

UUID

Model of ISO’s Object Identifier (oid) as defined by the standard ISO/IEC 8824. Oids are formed from integers separated by dots. Each non-leaf node in an Oid starting from the left corresponds to an assigning authority, and identifies that authority’s namespace, inside which the remaining part of the identifier is locally unique.

VERSION

Version control abstraction, defining semantics for versioning one complex object.

VERSIONED_COMPOSITION

Version-controlled composition abstraction, defined by inheriting VERSIONED_OBJECT<COMPOSITION>.

VERSIONED_EHR_ACCESS

Version container for EHR_ACCESS instance.

VERSIONED_EHR_STATUS

Version container for EHR_STATUS instance.

VERSIONED_FOLDER

A version-controlled hierarchy of FOLDERs giving the effect of a directory.

VERSIONED_OBJECT

Version control abstraction, defining semantics for versioning one complex object.

VERSIONED_PARTY

Ancestor of all Party types, including real world entities and their roles. A Party is any entity which can participate in an activity. The name attribute inherited from LOCATABLE is used to indicate the actual type of party (note that the actual names, i.e. identities of parties are indicated in the identities attribute, not the name attribute).

VERSION_TREE_ID

Version tree identifier for one version. Lexical form: trunk_version [ '.' branch_number '.' branch_version ].

WebTemplate
WebTemplateInput
WebTemplateInputListItem
WebTemplateInputValidation
WebTemplateInputValidationRange
WebTemplateItem
WebTemplateTermBinding
WebTemplateTermBindingValue

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Attestation Reason

Attestation Reason

Audit Change Type

Audit Change Type

Character Set

Character Set

Composition Category

Composition Category

Compression algorithms

Compression algorithms

Event Math Function

Event Math Function

Extract Action Type

Extract Action Type

Extract Content Type

Extract Content Type

Extract Update Trigger Event Type

Extract Update Trigger Event Type

Input Type ValueSet

Input Type ValueSet

Instruction States

Instruction States

Instruction Transitions

Instruction Transitions

Integrity check algorithms

Integrity check algorithms

Item Lifecycle State ValueSet

Item Lifecycle State ValueSet

Item ProportionType ValueSet

Item ProportionType ValueSet

Item rmType ValueSet

Item rmType ValueSet

Normal statuses

Normal statuses

Null Flavours

Null Flavours

PROPORTION_KIND

Class of enumeration constants defining types of proportion for the DV_PROPORTION class.

Participation Function

Participation Function

Participation Mode

Participation Mode

Property

Property

Range MaxOp ValueSet

Range MaxOp ValueSet

Range MinOp ValueSet

Range MinOp ValueSet

Setting

Setting

Subject Relationship

Subject Relationship

Term Binding Type ValueSet

Term Binding Type ValueSet

Term Mapping Purpose

Term Mapping Purpose

Territories

Territories

Version Lifecycle State

Version Lifecycle State

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Attestation Reason

Attestation Reason

Audit Change Type

Audit Change Type

Character Set

Character Set

Composition Category

Composition Category

Compression algorithms

Compression algorithms

Event Math Function

Event Math Function

Extract Action Type

Extract Action Type

Extract Content Type

Extract Content Type

Extract Update Trigger Event Type

Extract Update Trigger Event Type

Input Type CodeSystem

Input Type CodeSystem

Instruction States

Instruction States

Instruction Transitions

Instruction Transitions

Integrity check algorithms

Integrity check algorithms

Item LifecycleState CodeSystem

Item LifecycleState CodeSystem

Item ProportionType CodeSystem

Item ProportionType CodeSystem

Item rmType CodeSystem

Item rmType CodeSystem

Normal statuses

Normal statuses

Null Flavours

Null Flavours

PROPORTION_KIND

Class of enumeration constants defining types of proportion for the DV_PROPORTION class.

Participation Function

Participation Function

Participation Mode

Participation Mode

Property

Type of quantity being measured

Range MaxOp CodeSystem

Range MaxOp CodeSystem

Range MinOp CodeSystem

Range MinOp CodeSystem

Setting

Setting

Subject Relationship

Subject Relationship

Term Binding CodeSystem

Term Binding CodeSystem

Term Mapping Purpose

Term Mapping Purpose

Version Lifecycle State

Version Lifecycle State