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

Logical Model: INTERVAL_EVENT - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the INTERVAL-EVENT logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. INTERVAL_EVENT
Definition

Defines a single interval event in a series.


Base definition for all types defined in FHIR type system.

ShortDefines a single interval event in a seriesBase for all types and resources
Control0..*
Type ParameterT : ITEM_STRUCTURE
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. INTERVAL_EVENT.name
Definition

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.

ShortRuntime name of this fragment, used to build runtime paths
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. INTERVAL_EVENT.archetype-node-id
Definition

Design-time archetype identifier 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 terminology.

ShortDesign-time archetype identifier of this node taken from its generating archetype
Comments

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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. INTERVAL_EVENT.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. INTERVAL_EVENT.links
Definition

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

ShortLinks to other archetyped structures
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. INTERVAL_EVENT.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. INTERVAL_EVENT.feeder-audit
Definition

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

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. INTERVAL_EVENT.time
Definition

Time of this event. If the width is non-zero, it is the time point of the trailing edge of the event

ShortTime of this event
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
16. INTERVAL_EVENT.state
Definition

Optional state data for this event.

ShortOptional state data for this event
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse
18. INTERVAL_EVENT.data
Definition

The data of this event.

ShortThe data of this event
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Any<T>
Is Modifierfalse
20. INTERVAL_EVENT.width
Definition

Duration of the time interval during which the values recorded under data are true and, if set, the values recorded under state are true. Void if an instantaneous event.

ShortDuration of the time interval during which the values recorded under data are true
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
22. INTERVAL_EVENT.sample-count
Definition

Optional count of original samples to which this event corresponds.

ShortOptional count of original samples to which this event corresponds
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. INTERVAL_EVENT.math-function
Definition

Mathematical function of the data of this event, e.g. maximum, mean etc. Coded using openEHR vocabulary event math function. Default value 640|actual|, meaning 'actual value'.

ShortMathematical function of the data of this event
Control1..1
BindingThe codes SHALL be taken from Event Math Function
(required to https://specifications.openehr.org/fhir/valueset-event_math_function)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. INTERVAL_EVENT
Definition

Defines a single interval event in a series.

ShortDefines a single interval event in a series
Control0..*
Type ParameterT : ITEM_STRUCTURE
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. INTERVAL_EVENT.width
Definition

Duration of the time interval during which the values recorded under data are true and, if set, the values recorded under state are true. Void if an instantaneous event.

ShortDuration of the time interval during which the values recorded under data are true
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
4. INTERVAL_EVENT.sample-count
Definition

Optional count of original samples to which this event corresponds.

ShortOptional count of original samples to which this event corresponds
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. INTERVAL_EVENT.math-function
Definition

Mathematical function of the data of this event, e.g. maximum, mean etc. Coded using openEHR vocabulary event math function. Default value 640|actual|, meaning 'actual value'.

ShortMathematical function of the data of this event
Control1..1
BindingThe codes SHALL be taken from Event Math Function
(required to https://specifications.openehr.org/fhir/valueset-event_math_function)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. INTERVAL_EVENT
Definition

Defines a single interval event in a series.

ShortDefines a single interval event in a series
Control0..*
Type ParameterT : ITEM_STRUCTURE
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. INTERVAL_EVENT.name
Definition

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.

ShortRuntime name of this fragment, used to build runtime paths
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. INTERVAL_EVENT.archetype-node-id
Definition

Design-time archetype identifier 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 terminology.

ShortDesign-time archetype identifier of this node taken from its generating archetype
Comments

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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. INTERVAL_EVENT.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. INTERVAL_EVENT.links
Definition

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

ShortLinks to other archetyped structures
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. INTERVAL_EVENT.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. INTERVAL_EVENT.feeder-audit
Definition

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

ShortAudit trail from non-openEHR system of original commit of information forming the content of this node
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. INTERVAL_EVENT.time
Definition

Time of this event. If the width is non-zero, it is the time point of the trailing edge of the event

ShortTime of this event
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
16. INTERVAL_EVENT.state
Definition

Optional state data for this event.

ShortOptional state data for this event
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse
18. INTERVAL_EVENT.data
Definition

The data of this event.

ShortThe data of this event
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/Any<T>
Is Modifierfalse
20. INTERVAL_EVENT.width
Definition

Duration of the time interval during which the values recorded under data are true and, if set, the values recorded under state are true. Void if an instantaneous event.

ShortDuration of the time interval during which the values recorded under data are true
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
22. INTERVAL_EVENT.sample-count
Definition

Optional count of original samples to which this event corresponds.

ShortOptional count of original samples to which this event corresponds
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. INTERVAL_EVENT.math-function
Definition

Mathematical function of the data of this event, e.g. maximum, mean etc. Coded using openEHR vocabulary event math function. Default value 640|actual|, meaning 'actual value'.

ShortMathematical function of the data of this event
Control1..1
BindingThe codes SHALL be taken from Event Math Function
(required to https://specifications.openehr.org/fhir/valueset-event_math_function)
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse