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/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions

Logical Model: HISTORY - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the HISTORY logical model.

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

0. HISTORY
Definition

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.


Base definition for all types defined in FHIR type system.

ShortRoot object of a linear history, i.Base 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
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Events_valid: Events valid must be present ((events.exists() and then events.empty().not()) or summary.exists())
Periodic_validity: Periodic validity must satisfy exclusive conditions (is_periodic() xor period .empty())
Period_consistency: Period consistency must satisfy conditional constraints (is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0))
2. HISTORY.name
Definition

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

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. HISTORY.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.

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.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HISTORY.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. HISTORY.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 (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. HISTORY.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. HISTORY.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, or from a conversion gateway which has synthesised this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. HISTORY.origin
Definition

Time origin of this event history. The first event is not necessarily at the origin point.

ShortTime origin of this event history.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
16. HISTORY.period
Definition

Period between samples in this segment if periodic.

ShortPeriod between samples in this segment if periodic.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
18. HISTORY.duration
Definition

Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.

ShortDuration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
20. HISTORY.summary
Definition

Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data.

ShortOptional summary data that aggregates, organizes, reduces and transforms the event series.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse
22. HISTORY.events
Definition

The events in the series. This attribute is of a generic type whose parameter must be a descendant of ITEM_SUTRUCTURE.

ShortThe events in the series.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/EVENT<http://openehr.org/fhir/StructureDefinition/T>
Is Modifierfalse

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

0. HISTORY
Definition

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.

ShortRoot object of a linear history, i.
Control0..*
Type ParameterT : ITEM_STRUCTURE
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsEvents_valid: Events valid must be present ((events.exists() and then events.empty().not()) or summary.exists())
Periodic_validity: Periodic validity must satisfy exclusive conditions (is_periodic() xor period .empty())
Period_consistency: Period consistency must satisfy conditional constraints (is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0))
2. HISTORY.origin
Definition

Time origin of this event history. The first event is not necessarily at the origin point.

ShortTime origin of this event history.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
4. HISTORY.period
Definition

Period between samples in this segment if periodic.

ShortPeriod between samples in this segment if periodic.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
6. HISTORY.duration
Definition

Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.

ShortDuration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
8. HISTORY.summary
Definition

Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data.

ShortOptional summary data that aggregates, organizes, reduces and transforms the event series.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse
10. HISTORY.events
Definition

The events in the series. This attribute is of a generic type whose parameter must be a descendant of ITEM_SUTRUCTURE.

ShortThe events in the series.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/EVENT<http://openehr.org/fhir/StructureDefinition/T>
Is Modifierfalse

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

0. HISTORY
Definition

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.

ShortRoot object of a linear history, i.
Control0..*
Type ParameterT : ITEM_STRUCTURE
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Events_valid: Events valid must be present ((events.exists() and then events.empty().not()) or summary.exists())
Periodic_validity: Periodic validity must satisfy exclusive conditions (is_periodic() xor period .empty())
Period_consistency: Period consistency must satisfy conditional constraints (is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0))
2. HISTORY.name
Definition

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

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. HISTORY.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.

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.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HISTORY.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. HISTORY.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 (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. HISTORY.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. HISTORY.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, or from a conversion gateway which has synthesised this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. HISTORY.origin
Definition

Time origin of this event history. The first event is not necessarily at the origin point.

ShortTime origin of this event history.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DATE-TIME
Is Modifierfalse
16. HISTORY.period
Definition

Period between samples in this segment if periodic.

ShortPeriod between samples in this segment if periodic.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
18. HISTORY.duration
Definition

Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.

ShortDuration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
20. HISTORY.summary
Definition

Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data.

ShortOptional summary data that aggregates, organizes, reduces and transforms the event series.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse
22. HISTORY.events
Definition

The events in the series. This attribute is of a generic type whose parameter must be a descendant of ITEM_SUTRUCTURE.

ShortThe events in the series.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/EVENT<http://openehr.org/fhir/StructureDefinition/T>
Is Modifierfalse