Public Properties Index

PropertyClassDescription
ARCHETYPE_ONTOLOGY
COMPOSITION
accreditatonTRANSLATION_DETAILSAccreditation of translator, usually a national translator's registration
or association membership id.
accuracyDV_ABSOLUTE_QUANTITYAccuracy of measurement, expressed as a half-range value of the diff type
for this quantity (i.e. an accuracy of x means + or x).
accuracyDV_AMOUNTAccuracy 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_percentDV_AMOUNTIf True, indicates that when this object was
created, accuracy was recorded as a percent
value; if False, as an absolute quantity value.
actionTRANSITIONSide-effect action to execute during the firing of this transition.
action_archetype_idACTIVITYPerl-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.
activitiesINSTRUCTIONList of all activities in Instruction.
activity_idINSTRUCTION_DETAILSIdentifier of Activity within Instruction, in the form of its archetype path.
adl_versionARCHETYPE
ADL version if archteype was read in from an ADL sharable archetype.
alternate_textDV_MULTIMEDIAText to display in lieu of multimedia display/replay.
archetype_detailsLOCATABLEDetails of archetyping used on this node.
archetype_idARCHETYPE
Multi-axial identifier of this archetype in archetype space.
archetype_idARCHETYPEDGlobally unique archetype identifier.
archetype_node_idLOCATABLEDesign-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.
assignerDV_IDENTIFIEROrganisation that assigned the id to the item being identified.
assumed_valueC_BOOLEANThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_DATEThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_DATE_TIMEThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_DEFINED_OBJECTValue to be assumed if none sent in data.
assumed_valueC_DURATIONThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_INTEGERThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_REALThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_STRINGThe value to assume if this item is not included in data, due to being part of an
optional structure.
assumed_valueC_TIMEThe value to assume if this item is not included in data, due to being part of an
optional structure.
attestationsORIGINAL_VERSIONSet of attestations relating to this version.
attested_viewATTESTATIONOptional visual representation of content attested e.g. screen image.
attributesC_COMPLEX_OBJECTList of constraints on attributes of the reference model type
represented by this object.
auditCONTRIBUTIONAudit trail corresponding to the committal of this Contribution.
auditsREVISION_HISTORY_ITEMThe 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.
authorTRANSLATION_DETAILSTranslator name and other demographic details.
cardinalityC_MULTIPLE_ATTRIBUTECardinality of this attribute constraint, if it constraints a container attribute.
cardinalityTEMPLATE_CARDINALITY_SPEC
careflow_stepISM_TRANSITIONThe 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.
categoryCOMPOSITIONIndicates what broad category this Composition is belogs to, e.g.
persistent - of longitudinal validity, event , process etc.
change_typeAUDIT_DETAILSType of change. Coded using the openEHR Terminology audit change type group.
charsetDV_ENCAPSULATEDName 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.
childrenC_ATTRIBUTEChild 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.
codeARCHETYPE_TERM
code_listC_CODE_PHRASE
List of allowed codes; may be empty, meaning any code in the terminology may be
used.
Code_set_id_character_setsOPENEHR_CODE_SET_IDENTIFIERS
Code_set_id_compression_algorithmsOPENEHR_CODE_SET_IDENTIFIERS
Code_set_id_countriesOPENEHR_CODE_SET_IDENTIFIERS
Code_set_id_languagesOPENEHR_CODE_SET_IDENTIFIERS
Code_set_id_media_typesOPENEHR_CODE_SET_IDENTIFIERS
Code_set_id_normal_statusesOPENEHR_CODE_SET_IDENTIFIERS
Code_set_integrity_check_algorithmsOPENEHR_CODE_SET_IDENTIFIERS
code_stringCODE_PHRASEThe 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.
commit_auditVERSIONAudit trail corresponding to the committal of this
version to the VERSIONED_OBJECT.
committerAUDIT_DETAILSIdentity and optional reference into identity management service, of user who
committed the item.
composerCOMPOSITIONThe 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.
compositionsEHRMaster list of all composition references in this EHR.
compression_algorithmDV_MULTIMEDIACompression type, a coded value from the openEHR Integrity check code set.
Void means no compression.
conceptARCHETYPE
The normative meaning of the archetype as a whole, expressed as a local archetype code,
typically at0000 .
constraintTEMPLATE_CONSTRAINT_SPEC
constraint_codesARCHETYPE_ONTOLOGY
constraintsTEMPLATE_ATTRIBUTE_SPEC
constraintsTEMPLATE_NODE_SPEC
constraintsTEMPLATE_OBJECT_SPEC
contentCOMPOSITIONThe content of this Composition.
contextCOMPOSITIONThe clinical session context of this Composition, i.e. the contextual attributes of
the clinical session.
contributionVERSIONContribution in which this version was added.
contributionsEHRList 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.
copyrightRESOURCE_DESCRIPTION_ITEMOptional copyright statement for the resource as a knowledge resource.
CRBASIC_DEFINITIONScarriage return character
current_stateISM_TRANSITIONThe ISM current state. Coded by openEHR terminology group
Instruction states .
dataADMIN_ENTRYThe data of the Entry; modelled in archetypes.
dataDV_MULTIMEDIAThe actual data found at uri, if supplied inline.
dataEVALUATIONThe data of this evaluation, in the form of a spatial data structure.
dataEVENTThe data of this event.
dataGENERIC_ENTRYThe data' from the source message or record.

** SHOULD BE of Type ITEM_TREE **
dataOBSERVATIONThe data of this observation, in the form of a history of values which
may be of any complexity.
dataORIGINAL_VERSIONThe data being versioned. If not present, this corresponds to logical deletion.
day_validityC_DATEValidity of day in constrained date.
day_validityC_DATE_TIMEValidity of day in constrained date.
days_allowedC_DURATIONTrue if days are allowed in the constrained Duration.
default_valueTEMPLATE_DEFAULT_VALUE_SPEC
defining_codeDV_CODED_TEXTThe term which the value' attribute is the textual rendition (i.e. rubric) of.
definitionARCHETYPE
Root node of this archetype.
definitionASSERTION_VARIABLE
definitionTEMPLATE_SPEC
denominatorDV_PROPORTIONdenominator of ratio.
descriptionACTIONDescription of the activity to be performed, in the form of an
archetyped structure.
descriptionACTIVITYDescription of the activity, in the form of an archetyped structure.
descriptionAUDIT_DETAILSReason for committal.
descriptionAUTHORED_RESOURCEDescription and lifecycle information of the resource.
detailsRESOURCE_DESCRIPTIONDetails of all parts of resource description that are natural language-dependent,
keyed by language code.
directoryEHROptional directory structure for this EHR.
disallowedVALIDITY_KINDConstant to indicate disallowed presence of something.
durationHISTORYDuration of the entire History; either corresponds to the duration of all the events,
and/or the duration represented by the summary, if it exists.
ehr_accessEHRReference to EHR_ACCESS object for this EHR.
ehr_idEHRThe id of this EHR.
ehr_statusEHRReference to EHR_STATUS object for this EHR.
encodingDV_TEXTName 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.
encodingENTRYName of character set in which text values in this Entry are encoded.
Coded from openEHR Code Set character sets .
end_timeEVENT_CONTEXTOptional end time of the clinical session.
eventTRANSITIONEvent which fires this transition.
eventsHISTORYThe events in the series.
excludesARCHETYPE_SLOTList of constraints defining other archetypes that cannot be included at this point.
existenceC_ATTRIBUTEConstraint on every attribute, regardless of whether it is singular or of a container type,
which indicates whether its target object exists or not (i.e. is mandatory or not).
existenceTEMPLATE_EXISTENCE_SPEC
expiry_timeINSTRUCTIONOptional expiry date/time to assist determination of when an
Instruction can be assumed to have expired. This helps prevent
false listing of Instructions as Active when they clearly must have
been terminated in some way or other.
expressionASSERTIONRoot of expression tree.
external_refPARTY_PROXYOptional reference to more detailed demographic or identification information
for this party, in an external system.
false_validC_BOOLEANTrue if the value False is allowed.
feeder_auditLOCATABLEAudit trail from non-openEHR system of original commit of information
forming the content of this node, or from a conversion gateway which
has synthesised this node.
feeder_system_auditFEEDER_AUDITAny audit information for the information item from the feeder system,
if different from the originating system.
feeder_system_item_idsFEEDER_AUDITIdentifiers used for the item in the feeder system, where the feeder system
is distinct from the originating system.
fillersTEMPLATE_SLOT_SPEC
foldersFOLDERSub-folders of this FOLDER.
formalismDV_PARSABLEname of the formalism, e.g. GLIF 1.0 , Proforma etc.
formattingDV_TEXTA format string of the form name:value; name:value... ,
e.g. "font-weight : bold; font-family : Arial; font-size : 12pt;".

Values taken from W3C CSS2 properties lists back-ground and font .
fractional_seconds_allowedC_DURATIONTrue if fractional seconds are allowed in the constrained Duration.
functionPARTICIPATIONThe function of the Party in this participation (note that a given party
might participate in more than one way in a particular activity). This
attribute should be coded, but cannot be limited to the
HL7v3:ParticipationFunction vocabulary, since it is too limited and
hospital-oriented.
Group_id_attestation_reasonOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_audit_change_typeOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_composition_categoryOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_event_math_functionOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_instruction_statesOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_instruction_transitionsOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_null_flavoursOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_participation_functionOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_participation_modeOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_propertyOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_settingOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_subject_relationshipOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_term_mapping_purposeOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
Group_id_version_life_cycle_stateOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERS
guardTRANSITIONGuard condition which must be true for this transition to fire.
guideline_idCARE_ENTRYOptional external identifier of guideline creating this action if relevant.
health_care_facilityEVENT_CONTEXTThe health care facility under whose care the event took place. This is the
most specific workgroup or delivery unit within a care delivery enterprise that
has an official identifier in the health system, and can be used to ensure
medico-legal accountability.
hour_validityC_DATE_TIMEValidity of hour in constrained time.
hours_allowedC_DURATIONTrue if hours are allowed in the constrained Duration.
hyperlinkDV_TEXT
Optional link sitting behind a section of plain text or
coded term item.
idDV_IDENTIFIERThe identifier value. Often structured, according to the definition of the issuing
authority's rules.
idLOCATABLE_REFThe identifier of the Version.
idOBJECT_REFGlobally unique id of an object, regardless of where it is stored.
id_namespaceOBJECT_REFNamespace to which this identifier belongs in the local system context
(and possibly in any other openEHR compliant environment) e.g.
terminology , demographic . These names are not yet standardised. Legal
values for the namespace are:

local | unknown | [a-zA-Z][a-zA-Z0-9_-:/&+?]*
identifiersPARTY_IDENTIFIEDOne or more formal identifiers (possibly computable).
includesARCHETYPE_SLOTList of constraints defining other archetypes
that could be included at this point.
instruction_detailsACTIONDetails to of the Instruction that caused this Action
to be performed, if there was one.
instruction_idINSTRUCTION_DETAILSReference to causing Instruction.
integrity_checkDV_MULTIMEDIABinary cryptographic integrity checksum.
integrity_check_algorithmDV_MULTIMEDIAType of integrity check, a coded value from the openEHR Integrity check code set.
intervalCARDINALITYThe interval of this cardinality.
invariantsARCHETYPE
Invariant statements about this object. Statements are expressed in first order predicate
logic, and usually refer to at least two attributes.
is_controlledAUTHORED_RESOURCETrue if this resource is under any kind of change control (even file copying),
in which case revision history is created.
is_modifiableEHR_STATUSTrue if this EHR is allowed to be written to.
is_orderedCARDINALITYTrue if the members of the container attribute
to which this cardinality refers are ordered.
is_pendingATTESTATIONTrue if this attestation is outstanding;
False means it has been completed.
is_queryableEHR_STATUSTrue if this EHR should be included in population queries, i.e. if
this EHR is considered active in the population.
is_uniqueCARDINALITYTrue if the members of the container attribute
to which this cardinality refers are unique.
ism_transitionACTIONDetails of transition in the Instruction state machine caused by this Action.
issuerDV_IDENTIFIERAuthority which issues the kind of id used in the id field of this object.
itemC_PRIMITIVE_OBJECTObject actually defining the constraint.
itemEXPR_LEAF
itemIMPORTED_VERSIONThe ORIGINAL_VERSION object that was imported.
itemITEM_SINGLE
itemsARCHETYPE_TERM
itemsATTESTATIONItems attested, expressed as fully qualified runtime paths to the items
in question. Although not recommended, these may include fine-grained
items which have been attested in some other system. Otherwise it is
assumed to be for the entire VERSION with which it is associated.
itemsCLUSTEROrdered list of items - CLUSTER or ELEMENT objects - under this CLUSTER.
itemsDV_PARAGRAPHItems making up the paragraph, each of which is a text item (which may have its
own formatting, and/or have hyperlinks).
itemsFOLDERThe list of references to other (usually) versioned objects logically in this folder.
itemsITEM_LISTPhysical representation of the list.
itemsITEM_TREEThe items comprising the ITEM_TREE. Can include 0 or more CLUSTERs and/or
0 or more individual ELEMENTs.
itemsREVISION_HISTORYThe items in this history in most-recent-last order.
itemsSECTIONOrdered list of content items under this section, which may include:
more SECTIONs
ENTRYs
keywordsRESOURCE_DESCRIPTION_ITEMKeywords which characterise this resource, used e.g. for indexing and searching.
languageCOMPOSITIONMandatory indicator of the localised language in which this Composition
is written. Coded from openEHR Code Set languages . The language of an
Entry if different from the Composition is indicated in ENTRY.language.
languageDV_ENCAPSULATEDOptional indicator of the localised language in which the data is written, if relevant.
Coded from openEHR Code Set languages.
languageDV_TEXTOptional indicator of the localised language in which the value is written.
Coded from openEHR Code Set languages . Only used when either the text object is
in a different language from the enclosing ENTRY, or else the text object is
being used outside of an ENTRY or other enclosing structure which indicates the
language.
languageENTRYMandatory indicator of the localised language in which this Entry is written.
Coded from openEHR Code Set languages .
languageRESOURCE_DESCRIPTION_ITEMThe localised language in which the items in this description item are written.
Coded from openEHR Code Set languages .
languageTRANSLATION_DETAILSLanguage of the translation.
left_operandEXPR_BINARY_OPERATOR
LFBASIC_DEFINITIONSline feed character
lifecycle_stateORIGINAL_VERSIONLifecycle state of the content item in this version.
lifecycle_statusRESOURCE_DESCRIPTIONLifecycle state of the resource, typically including states such as: initial,
submitted, experimental, awaiting_approval, approved, superseded, obsolete.
linksLOCATABLELinks to other archetyped structures (data whose root object inherits from
ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to
structures in other compositions.
listC_DV_ORDINAL
Set of allowed DV_ORDINAL values.
listC_DV_QUANTITYList of value/units pairs.
listC_INTEGERSet of Integers specifying constraint.
listC_REALSet of Reals specifying constraint .
listC_STRINGSet of Strings specifying constraint.
list_openC_STRINGTrue if the list is being used to specify the constraint but is not considered
exhaustive.
locationEVENT_CONTEXTThe actual location where the session occurred, e.g. microbiol lab 2 ,
home , ward A3 and so on.
locationFEEDER_AUDIT_DETAILSIdentifier of the particular site/facility within an organisation which handled
the item. For computability, this identifier needs to be e.g. a PKI identifier
which can be included in the identifier list of the PARTY_IDENTIFIED object.
lowerDV_INTERVAL
lowerIntervallower bound.
lower_includedIntervallower boundary value included in range if not lower_unbounded.
lower_unboundedIntervallower boundary open (i.e. = -infinity)
magnitudeC_QUANTITY_ITEMConstraint on the magnitude of the DV_QUANTITY.
magnitudeDV_COUNT
magnitudeDV_QUANTIFIEDNumeric value of the quantity in canonical (i.e. single value) form.
Implemented as constant, function or attribute in subtypes as
appropriate. The type Ordered_numeric is mapped to the available
appropriate type in each implementation technology.

*** BEWARE ***
magnitudeDV_QUANTITY
magnitude_statusDV_QUANTIFIEDOptional status of magnitude with values:
= : magnitude is a point value
< : value is < magnitude
> : value is > magnitude
<= : value is <= magnitude
>= : value is >= magnitude
~ : value is approximately magnitude
If not present, meaning is = .
mandatoryVALIDITY_KINDConstant to indicate mandatory presence of something.
mappingsDV_TEXTTerms from other terminologies most closely matching this term,
typically used where the originator (e.g. pathology lab) of information
uses a local terminology but also supplies one or more equivalents from
well known terminologies (e.g. LOINC).
matchTERM_MAPPING
The relative match of the target term with respect to the mapped text item.
Result meanings:
>': the mapping is to a broader term
e.g. orginal text = arbovirus infection , target = viral infection
=': the mapping is to a (supposedly) equivalent to the original item
<': the mapping is to a narrower term.
e.g. original text = diabetes , mapping = diabetes mellitus .
?': the kind of mapping is unknown.
The first three values are taken from the ISO standards 2788 ( Guide to
Establishment and development of monolingual thesauri ) and 5964
( Guide to Establishment and development of multilingual thesauri ).
math_functionINTERVAL_EVENTMathematical function of the data of this event, e.g. maximum , mean etc.
Coded using openEHR Terminology group event math function .
meaningLINKUsed to describe the relationship, usually in clinical terms, such as in response
to (the relationship between test results and an order), follow-up to and so on.
Such relationships can represent any clinically meaningful connection between
pieces of information. Values for meaning include those described in
Annex C, ENV 13606 pt 2 under the categories of generic , documenting
and reporting , organisational , clinical , circumstancial , and view management .
meaningREFERENCE_RANGETerm whose value indicates the meaning of this range, e.g. normal , critical ,
therapeutic etc.
media_typeDV_MULTIMEDIAData media type coded from openEHR code set media types (interface for the IANA MIME types code set).
millisecond_validityC_DATE_TIMEValidity of millisecond in constrained time.
millisecond_validityC_TIMEValidity of millisecond in constrained time.
minute_validityC_DATE_TIMEValidity of minute in constrained time.
minute_validityC_TIMEValidity of minute in constrained time.
minutes_allowedC_DURATIONTrue if minutes are allowed in the constrained Duration.
misuseRESOURCE_DESCRIPTION_ITEMDescription of any misuses of the resource, i.e. contexts in which it should not be used.
modePARTICIPATIONThe mode of the performer / activity interaction, e.g. present, by telephone, by
email etc.
month_validityC_DATEValidity of month in constrained date.
month_validityC_DATE_TIMEValidity of month in constrained date.
months_allowedC_DURATIONTrue if months are allowed in the constrained Duration.
nameASSERTION_VARIABLE
nameLOCATABLERuntime name of this fragment, used to build runtime paths. This is the term
provided via a clinical application or batch process to name this EHR
construct: its retention in the EHR faithfully preserves the original label
by which this entry was known to end users.
namePARTY_IDENTIFIEDOptional human-readable name (in String form).
nameSTATEname of this state
narrativeINSTRUCTIONMandatory human-readable version of what the Instruction is about.
next_stateTRANSITIONTarget state of transition.
node_idC_OBJECTSemantic id of this node, used to differentiate sibling nodes of the same type.
[Previously called meaning']. Each node_id must be defined in the archetype ontology as a
term code.
normal_statusDV_ORDEREDOptional normal status indicator of value with respect to normal range for this
value. Often included by lab, even if the normal range itself is not included.
Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR
terminology group normal status .
null_flavorELEMENTflavour of null value, e.g. indeterminate, not asked etc.
numeratorDV_PROPORTIONnumerator of ratio
occurrencesC_OBJECTOccurrences of this object node in the data, under the owning attribute. Upper limit can
only be greater than 1 if owning attribute has a cardinality of more than 1.
occurrencesTEMPLATE_OCCURRENCES_SPEC
ontologyARCHETYPE
The ontology of the archetype.
op_eqOPERATOR_KINDEquals operator ( =' or ==')
op_leOPERATOR_KINDLess-than or equals operator ( <=')
op_neOPERATOR_KINDNot equals operator ( !=' or /=' or <>')
operandEXPR_UNARY_OPERATOR
optionalVALIDITY_KINDConstant to indicate optional presence of something.
originHISTORYTime origin of this event history. The first event is not necessarily at the origin
point.
original_authorRESOURCE_DESCRIPTIONOriginal author of this resource, with all relevant details, including organisation.
original_contentFEEDER_AUDITOptional inline inclusion of or reference to original content corresponding
to the openEHR content at this node. Typically a URI reference to a document
or message in a persistent store associated with the EHR.
original_languageAUTHORED_RESOURCELanguage in which this resource was initially authored. Although there is no language
primacy of resources overall, the language of original authoring is required to ensure
natural language translations can preserve quality. Language is relevant in both the
description and ontology sections.
original_resource_uriRESOURCE_DESCRIPTION_ITEMURIs of original clinical document(s) or description of which resource is a
formalisation, in the language of this description item; keyed by meaning.
originating_system_auditFEEDER_AUDITAny audit information for the information item from the originating system.
originating_system_item_idsFEEDER_AUDITIdentifiers used for the item in the originating system,
e.g. filler and placer ids.
other_contextEVENT_CONTEXTOther optional context which will be archetyped.
other_contributorsRESOURCE_DESCRIPTIONOther contributors to the resource, probably listed in name <email> form.
other_detailsEHR_STATUSAny other details of the EHR summary object, in the form of an archetyped
Item_structure.
other_detailsRESOURCE_DESCRIPTIONAdditional non language-senstive resource meta-data, as a list of
name/value pairs.
other_detailsRESOURCE_DESCRIPTION_ITEMAdditional language-senstive resource metadata, as a list of name/value pairs.
other_detailsTRANSLATION_DETAILSAny other meta-data.
other_input_version_uidsORIGINAL_VERSIONIdentifiers of other versions whose content was merged into this
version, if any.
other_participationENTRYOther participations at ENTRY level.
ownerTEMPLATE_NODE_SPEC
owner_idVERSIONED_OBJECTReference to object to which this version container belongs, e.g. the id of
the containing EHR or other relevant owning entity.
parentC_OBJECTC_ATTRIBUTE that owns this C_OBJECT.
parent_archetypeARCHETYPE_ONTOLOGY
parent_archetype_idARCHETYPE
Identifier of the specialisation parent of this archetype.
parent_resourceRESOURCE_DESCRIPTIONReference to owning resource.
participationsEVENT_CONTEXTParties involved in the healthcare event. These would normally include the
physician(s) and often the patient (but not the latter if the clinical session
is a pathology test for example).
pathLOCATABLE_REFThe path to an instance in question, as an absolute path with respect to
the object found at VERSION.data. An empty path means that
the object referred to by id being specified.
pathTEMPLATE_NODE_SPEC
pathTEMPLATE_SLOT_SPEC
path_specsTEMPLATE_ARCHETYPE_SPEC
patternC_STRINGRegular expression pattern for proposed instances of String to match.
performerPARTICIPATIONThe id and possibly demographic system link of the party participating in
the activity.
periodHISTORYPeriod between samples in this segment if periodic.
pk_fractionPROPORTION_KINDNumerator and denominator are integral, and the presentation
method uses a slash, e.g. 1/2 .
pk_integer_fractionPROPORTION_KINDNumerator and denominator are integral, and the presentation
method uses a slash, e.g. 1/2 ; if the numerator is greater than the
denominator, e.g. n=3, d=2, the presentation is 1 1/2 .
pk_percentPROPORTION_KINDDenominator is 100, numerator is
understood as a percentage value.
pk_ratioPROPORTION_KINDRatio type. Numerator and denominator may be any value.
pk_unitaryPROPORTION_KINDDenominator must be 1
preceding_version_uidORIGINAL_VERSIONStored version of inheritance precursor.
precisionC_QUANTITY_ITEMConstraint on the precision of the DV_QUANTITY. A value of -1 means that
precision is unconstrained.
precisionDV_PROPORTIONPrecision to which the numerator and denominator values of the
proportion are expressed, in terms of number of decimal places. The
value 0 implies an integral quantity. The value -1 implies no limit, i.e.
any number of decimal places.
precisionDV_QUANTITY
proofATTESTATIONProof of attestation.
propertyC_DV_QUANTITYOptional constraint on units property .
protocolCARE_ENTRYDescription of the method (i.e. how) the information in this entry was
arrived at. For OBSERVATIONs, this is a description of the method or
instrument used. For EVALUATIONs, how the evaluation was arrived at.
For INSTRUCTIONs, how to execute the Instruction. This may take the
form of references to guidelines, including manually followed and
executable; knowledge references such as a paper in Medline; clinical
reasons within a larger care process.
providerENTRYOptional identification of provider of the information in this ENTRY,
which might be:
* the patient
* a patient agent, e.g. parent, guardian
* the clinician
* a device or software

Generally only used when the recorder needs to make it explicit. Otherwise,
Composition composer and other participants are assumed.
providerFEEDER_AUDIT_DETAILS
Optional provider(s) who created, committed,
forwarded or otherwise handled the item.
purposeRESOURCE_DESCRIPTION_ITEMPurpose of the resource.
purposeTERM_MAPPING
Purpose of the mapping e.g. automated data mining , billing , interoperability
rangeC_DATEInterval of Dates specifying constraint.
rangeC_DATE_TIMERange of Date_times specifying constraint.
rangeC_DURATIONRange of Durations specifying constraint.
rangeC_INTEGERRange of Integers specifying constraint.
rangeC_REALRange of Real specifying constraint.
rangeC_TIMEInterval of Times specifying constraint.
rangeREFERENCE_RANGEThe data range for this meaning, e.g. critical etc.
reasonATTESTATIONReason of this attestation. Optionally coded by the openEHR Terminology
group attestation reason ; includes values like authorisation , witness etc.
referenceCONSTRAINT_REFReference to a constraint in the archetype local ontology.
reference_typeEXPR_LEAF
relationshipPARTY_RELATEDRelationship of subject of this ENTRY to the subject of the record.
May be coded. If it is the patient, coded as self .
resource_package_uriRESOURCE_DESCRIPTIONURI of package to which this resource belongs.
revision_historyAUTHORED_RESOURCEThe revision history of the resource. Only required if is_controlled = True
(avoids large revision histories for informal or private editing situations).
right_operandEXPR_BINARY_OPERATOR
rm_attribute_nameC_ATTRIBUTEReference model attribute within the enclosing type represented by a C_OBJECT.
rm_type_nameC_OBJECTReference model type that this node corresponds to.
rm_versionARCHETYPEDVersion of the openEHR reference model used to create this object.
Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .
rowsITEM_TABLEPhysical representation of the table as a list of CLUSTERs, each
containing the data of one row of the table.
sample_countINTERVAL_EVENTOptional count of original samples to which this event corresponds.
schemeGENERIC_IDName of the scheme to which this identifier conforms. Ideally this
name will be recognisable globally but realistically it may be a local ad
hoc scheme whose name is not controlled or standardised in any way.
second_validityC_DATE_TIMEValidity of second in constrained time.
second_validityC_TIMEValidity of second in constrained time.
seconds_allowedC_DURATIONTrue if seconds are allowed in the constrained Duration.
settingEVENT_CONTEXTThe setting in which the clinical session took place. Coded using the
openEHR Terminology, setting group.
settingsEHR_ACCESSAccess control settings for the EHR. Instance is a subtype of the type
ACCESS_CONTROL_SETTINGS, allowing for the use of different access
control schemes.
signatureVERSIONOpenPGP digital signature or digest of content
committed in this Version.
slot_ownerTEMPLATE_SLOT_SPEC
slot_specsTEMPLATE_ARCHETYPE_SPEC
sourceTEMPLATE_ATTRIBUTE_SPEC
sourceTEMPLATE_OBJECT_SPEC
specialisation_depthARCHETYPE_ONTOLOGY
start_timeEVENT_CONTEXTStart time of the clinical session or other kind of event during which a provider
performs a service of any kind for the patient.
stateEVENTOptional state data for this event.
stateOBSERVATIONOptional recording of the state of subject of this observation during
the observation process, in the form of a separate history of values
which may be of any complexity. State may also be recorded
within the History of the data attribute.
statesSTATE_MACHINE
string_expressionASSERTIONString form of expression, in case an expression evaluator taking String expressions is
used for evaluation.
subjectEHR_STATUSThe subject of this EHR. The external_ref attribute can be used to
contain a direct reference to the subject in a demographic or
identity service. Alternatively, the association between patients
and their records may be done elsewhere for security reasons.
subjectENTRYId of human subject of this ENTRY, e.g.:
* organ donor
* foetus
* a family member
* another clinically relevant person.
subjectFEEDER_AUDIT_DETAILSIdentifiers for subject of the received information item.
summaryHISTORYOptional summary data expressing e.g. text or image which summarises entire
History.
symbolDV_ORDINALCoded textual representation of this value in the enumeration, which may
be strings made from + symbols, or other enumerations of terms such
as mild , moderate , severe , or even the same number series as the values,
e.g. 1 , 2 , 3 . Codes come from archetype.
system_idAUDIT_DETAILSIdentity of the system where the change was committed. Ideally this is a
machine- and human-processable identifier, but it may not be.
system_idEHRThe id of the EHR system on which this EHR was created.
system_idFEEDER_AUDIT_DETAILSIdentifier of the system which handled the information item.
tagASSERTIONExpression tag, used for differentiating mul-
tiple assertions.
targetLINKThe logical to object in the link relation, as per the linguistic sense of the meaning
attribute.
targetTEMPLATE_ATTRIBUTE_SPEC
targetTEMPLATE_OBJECT_SPEC
targetTERM_MAPPINGThe target term of the mapping.
target_pathARCHETYPE_INTERNAL_REFReference to an object node using archetype path notation.
template_idARCHETYPEDGlobally unique template identifier, if a template was active at this point
in the structure. Normally, a template would only be used at the top of a
top-level structure, but the possibility exists for templates at lower levels.
template_idTEMPLATE_SPEC
term_attribute_namesARCHETYPE_ONTOLOGY
term_codesARCHETYPE_ONTOLOGY
terminologies_availableARCHETYPE_ONTOLOGYList of terminologies to which term or con-
straint bindings exist in this terminology.
terminology_idC_CODE_PHRASE
Syntax string expressing constraint on allowed primary terms.
terminology_idCODE_PHRASEIdentifier of the distinct terminology from which the code_string (or its elements)
was extracted.
Terminology_id_openehrOPENEHR_TERMINOLOGY_GROUP_IDENTIFIERSName of openEHR's own terminology.
territoryCOMPOSITIONName of territory in which this Composition was written. Coded from
openEHR countries code set, which is an expression of the ISO 3166 standard.
thumbnailDV_MULTIMEDIAThe thumbnail for this item, if one exists; mainly for graphics formats.
timeACTIONPoint in time at which this action completed.
timeEVENTTime of this event. If the width is non-zero, it is the time point of the
trailing edge of the event.
timeFEEDER_AUDIT_DETAILSTime of handling the item. For an originating system, this will be time
of creation, for an intermediate feeder system, this will be a time
of accession or other time of handling, where available.
timePARTICIPATIONThe time interval during which the participation took place, if it is used in an
observational context (i.e. recording facts about the past); or the intended
time interval of the participation when used in future contexts, such as EHR
Instructions.
time_committedAUDIT_DETAILSTime of committal of the item.
time_createdEHRTime of creation of the EHR.
time_createdVERSIONED_OBJECTTime of initial creation of this versioned object.
timezone_validityC_DATEValidity of timezone in constrained date. ** CHECK THIS **
timezone_validityC_DATE_TIMEValidity of timezone in constrained date.
timezone_validityC_TIMEValidity of timezone in constrained time.
timingACTIVITYTiming of the activity, in the form of a parsable string, such
as an HL7 GTS or ISO8601 string.
transitionISM_TRANSITIONThe ISM transition which occurred to arrive in the current_state.
Coded by openEHR terminology group Instruction transitions .
transitionsNON_TERMINAL_STATE
translationsAUTHORED_RESOURCEList of details for each natural translation made of this resource, keyed by language.
For each translation listed here, there must be corresponding sections in all
language-dependent parts of the resource. The original_language does not appear
in this list.
true_validC_BOOLEANTrue if the value True is allowed.
typeDV_IDENTIFIERThe identifier type, such as prescription , or Social Security Number . One day a controlled vocabulary
might be possible for this.
typeDV_PROPORTIONIndicates semantic type of proportion, including percent, unitary etc.
typeEXPR_ITEM
typeLINKThe type attribute is used to indicate a clinical or domain-level meaning for the
kind of link, for example problem or issue . If type values are designed
appropriately, they can be used by the requestor of EHR extracts to categorise
links which must be followed and which can be broken when the extract is created.
typeOBJECT_REFName of the class (concrete or abstract) of object to which this identifier
type refers, e.g. PARTY , PERSON , GUIDELINE etc.
These class names are from the relevant reference model. The type name
ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).
uidARCHETYPE
OID identifier of this archetype.
uidCONTRIBUTIONUnique identifier for this contribution.
uidLOCATABLEOptional globally unique object identifier for root points of archetyped
structures.
uidORIGINAL_VERSIONStored version of inheritance precursor.
uidVERSIONED_OBJECTUnique identifier of this version container. This id will be the same in all
instances of the same container in a distributed environment, meaning that it
can be understood as the uid of the virtual version tree .
unitsC_QUANTITY_ITEMConstraint on units of the DV_QUANTITY.
unitsDV_QUANTITY
upperDV_INTERVAL
upperIntervalUpper bound.
upper_includedIntervalupper boundary value included in range if not upper_unbounded.
upper_unboundedIntervalupper boundary open (i.e. = +infinity)
uriDV_MULTIMEDIAURI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference.
useRESOURCE_DESCRIPTION_ITEMDescription of the uses of the resource, i.e. contexts in which it could be used.
valueC_DV_STATE
valueDV_BOOLEANBoolean value of this item.
Actual values may be language or implementation dependent.
valueDV_DATEISO8601 date string .
valueDV_DATE_TIMEISO8601 date/time string
valueDV_ORDINALValue in ordered enumeration of values. Any integer value can be used.
valueDV_PARSABLEThe string, which may validly be empty in some syntaxes.
valueDV_STATEThe state name. State names are determined by a state/event table defined
in archetypes, and coded using openEHR Terminology or local archetype terms,
as specified by the archetype.
valueDV_TEXTDisplayable rendition of the item, regardless of its underlying structure.
For DV_CODED_TEXT, this is the rubric of the complete term as provided by
the terminology service. No carriage returns, line feeds, or other
non-printing characters permitted.
valueDV_TIMEISO8601 time string
valueDV_TIME_SPECIFICATIONthe specification, in the HL7v3 syntax for PIVL or EIVL types.
valueDV_URIValue of URI as a String.
valueELEMENTdata value of this leaf.
valueOBJECT_ID
The value of the id in the form defined below.
valueUIDThe value of the id.
valueVALIDITY_KINDActual value
valueVERSION_TREE_IDString form of this identifier.
variablesASSERTION
Definitions of variables used in the assertion expression.
version_idFEEDER_AUDIT_DETAILSAny identifier used in the system such as "interim" , "final" , or numeric versions if
available.
version_idREVISION_HISTORY_ITEMVersion identifier for this revision.
versionsCONTRIBUTIONSet of references to versions causing changes to this EHR. Each contribution
contains a list of versions, which may include paths pointing to any
number of VERSIONABLE items, i.e. items of type COMPOSITION and FOLDER.
weeks_allowedC_DURATIONTrue if weeks are allowed in the constrained Duration.
wf_definitionINSTRUCTIONOptional workflow engine executable expression of the Instruction.
wf_detailsINSTRUCTION_DETAILSVarious workflow engine state details, potentially including such things as:
* condition that fired to cause this Action to be done (with actual variables
substituted);
* list of notifications which actually occurred (with all variables substituted);
* other workflow engine state.
This specification does not currently define the actual structure or semantics
of this field.
widthINTERVAL_EVENTLength of the interval during which the state was true. Void if an
instantaneous event.
workflow_idENTRYIdentifier of externally held workflow engine data for this workflow execution,
for this subject of care.
years_allowedC_DURATIONTrue if years are allowed in the constrained Duration.