OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package
0.1.0 - First Draft
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
| Official URL: http://openehr.org/fhir/StructureDefinition/HISTORY | Version: 0.1.0 | ||||
| Standards status: Informative | Maturity Level: 3 | Computable Name: 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.
Original Source: specifications.openehr.org
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  HISTORY<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
C | 0..* | DATA_STRUCTURE | Root object of a linear history, i. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: events-valid, periodic-validity, period-consistency |
  origin<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_DATE_TIME | Time origin of this event history. | |
| period<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | Period between samples in this segment if periodic. | |
| duration<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | 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. | |
| summary<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ITEM_STRUCTURE | Optional summary data that aggregates, organizes, reduces and transforms the event series. | |
 events<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | EVENT<http://openehr.org/fhir/StructureDefinition/T> | The events in the series. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| events-valid | error | HISTORY | Events valid must be present |
(events.exists() and events.empty().not()) or summary.exists()
|
| period-consistency | error | HISTORY | Period consistency must satisfy conditional constraints |
is_periodic() implies events.all(offset.to_seconds().mod(period.to_seconds()) = 0)
|
| periodic-validity | error | HISTORY | Periodic validity must satisfy exclusive conditions |
is_periodic() xor period .empty()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HISTORY<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
C | 0..* | DATA_STRUCTURE | Root object of a linear history, i. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: links-valid, archetyped-valid, archetype-node-id-valid, events-valid, periodic-validity, period-consistency |
| name<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
 archetype_node_id<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | FEEDER_AUDIT | 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. | |
| origin<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_DATE_TIME | Time origin of this event history. | |
| period<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | Period between samples in this segment if periodic. | |
| duration<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | 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. | |
| summary<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ITEM_STRUCTURE | Optional summary data that aggregates, organizes, reduces and transforms the event series. | |
| events<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | EVENT<http://openehr.org/fhir/StructureDefinition/T> | The events in the series. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| archetype-node-id-valid | error | HISTORY | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| archetyped-valid | error | HISTORY | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| events-valid | error | HISTORY | Events valid must be present |
(events.exists() and events.empty().not()) or summary.exists()
|
| links-valid | error | HISTORY | Links valid must be present |
links.exists() implies links.empty().not()
|
| period-consistency | error | HISTORY | Period consistency must satisfy conditional constraints |
is_periodic() implies events.all(offset.to_seconds().mod(period.to_seconds()) = 0)
|
| periodic-validity | error | HISTORY | Periodic validity must satisfy exclusive conditions |
is_periodic() xor period .empty()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HISTORY<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
C | 0..* | DATA_STRUCTURE | Root object of a linear history, i. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: events-valid, periodic-validity, period-consistency |
| origin<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_DATE_TIME | Time origin of this event history. | |
| period<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | Period between samples in this segment if periodic. | |
| duration<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | 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. | |
| summary<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ITEM_STRUCTURE | Optional summary data that aggregates, organizes, reduces and transforms the event series. | |
| events<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | EVENT<http://openehr.org/fhir/StructureDefinition/T> | The events in the series. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| events-valid | error | HISTORY | Events valid must be present |
(events.exists() and events.empty().not()) or summary.exists()
|
| period-consistency | error | HISTORY | Period consistency must satisfy conditional constraints |
is_periodic() implies events.all(offset.to_seconds().mod(period.to_seconds()) = 0)
|
| periodic-validity | error | HISTORY | Periodic validity must satisfy exclusive conditions |
is_periodic() xor period .empty()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HISTORY<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
C | 0..* | DATA_STRUCTURE | Root object of a linear history, i. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: links-valid, archetyped-valid, archetype-node-id-valid, events-valid, periodic-validity, period-consistency |
| name<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_TEXT | Runtime name of this fragment, used to build runtime paths. | |
| archetype_node_id<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | string | Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. | |
| uid<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | UID_BASED_ID | Optional globally unique object identifier for root points of archetyped structures. | |
| links<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | LINK | Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). | |
| archetype_details<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ARCHETYPED | Details of archetyping used on this node. | |
| feeder_audit<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | FEEDER_AUDIT | 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. | |
| origin<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
1..1 | DV_DATE_TIME | Time origin of this event history. | |
| period<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | Period between samples in this segment if periodic. | |
| duration<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | DV_DURATION | 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. | |
| summary<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..1 | ITEM_STRUCTURE | Optional summary data that aggregates, organizes, reduces and transforms the event series. | |
| events<T : http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE> |
0..* | EVENT<http://openehr.org/fhir/StructureDefinition/T> | The events in the series. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| archetype-node-id-valid | error | HISTORY | Archetype node id valid must not be empty |
archetype_node_id.empty().not()
|
| archetyped-valid | error | HISTORY | Archetyped valid must satisfy exclusive conditions |
is_archetype_root() xor archetype_details .empty()
|
| events-valid | error | HISTORY | Events valid must be present |
(events.exists() and events.empty().not()) or summary.exists()
|
| links-valid | error | HISTORY | Links valid must be present |
links.exists() implies links.empty().not()
|
| period-consistency | error | HISTORY | Period consistency must satisfy conditional constraints |
is_periodic() implies events.all(offset.to_seconds().mod(period.to_seconds()) = 0)
|
| periodic-validity | error | HISTORY | Periodic validity must satisfy exclusive conditions |
is_periodic() xor period .empty()
|
Other representations of profile: CSV, Excel