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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: 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:

• Use this Logical Model: OBSERVATION

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_TEXT	Runtime name of this fragment, used to build runtime paths.
archetype_node_id<T : ITEM_STRUCTURE>		1..1	string	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
uid<T : ITEM_STRUCTURE>		0..1	UID_BASED_ID	Optional globally unique object identifier for root points of archetyped structures.
links<T : 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 : ITEM_STRUCTURE>		0..1	ARCHETYPED	Details of archetyping used on this node.
feeder_audit<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

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 then 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.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)
Periodic_validity	error	HISTORY	Periodic validity must satisfy exclusive conditions	is_periodic() xor period .empty()

This structure is derived from DATA_STRUCTURE

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
Events_valid	error	HISTORY	Events valid must be present	(events.exists() and then events.empty().not()) or summary.exists()
Period_consistency	error	HISTORY	Period consistency must satisfy conditional constraints	is_periodic() implies events.for_all (e: EVENT | e.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: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_TEXT	Runtime name of this fragment, used to build runtime paths.
archetype_node_id<T : ITEM_STRUCTURE>		1..1	string	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
uid<T : ITEM_STRUCTURE>		0..1	UID_BASED_ID	Optional globally unique object identifier for root points of archetyped structures.
links<T : 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 : ITEM_STRUCTURE>		0..1	ARCHETYPED	Details of archetyping used on this node.
feeder_audit<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

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 then 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.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)
Periodic_validity	error	HISTORY	Periodic validity must satisfy exclusive conditions	is_periodic() xor period .empty()

This structure is derived from DATA_STRUCTURE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_TEXT	Runtime name of this fragment, used to build runtime paths.
archetype_node_id<T : ITEM_STRUCTURE>		1..1	string	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
uid<T : ITEM_STRUCTURE>		0..1	UID_BASED_ID	Optional globally unique object identifier for root points of archetyped structures.
links<T : 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 : ITEM_STRUCTURE>		0..1	ARCHETYPED	Details of archetyping used on this node.
feeder_audit<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

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 then 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.for_all (e: EVENT | e.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

This structure is derived from DATA_STRUCTURE

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
Events_valid	error	HISTORY	Events valid must be present	(events.exists() and then events.empty().not()) or summary.exists()
Period_consistency	error	HISTORY	Period consistency must satisfy conditional constraints	is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)
Periodic_validity	error	HISTORY	Periodic validity must satisfy exclusive conditions	is_periodic() xor period .empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HISTORY<T : 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 : ITEM_STRUCTURE>		1..1	DV_TEXT	Runtime name of this fragment, used to build runtime paths.
archetype_node_id<T : ITEM_STRUCTURE>		1..1	string	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
uid<T : ITEM_STRUCTURE>		0..1	UID_BASED_ID	Optional globally unique object identifier for root points of archetyped structures.
links<T : 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 : ITEM_STRUCTURE>		0..1	ARCHETYPED	Details of archetyping used on this node.
feeder_audit<T : 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 : ITEM_STRUCTURE>		1..1	DV_DATE_TIME	Time origin of this event history.
period<T : ITEM_STRUCTURE>		0..1	DV_DURATION	Period between samples in this segment if periodic.
duration<T : 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 : ITEM_STRUCTURE>		0..1	ITEM_STRUCTURE	Optional summary data that aggregates, organizes, reduces and transforms the event series.
events<T : ITEM_STRUCTURE>		0..*	EVENT<http://openehr.org/fhir/StructureDefinition/T>	The events in the series.
Documentation for this format

Constraints

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 then 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.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)
Periodic_validity	error	HISTORY	Periodic validity must satisfy exclusive conditions	is_periodic() xor period .empty()

This structure is derived from DATA_STRUCTURE

Summary

Mandatory: 0 element(1 nested mandatory element)

Maturity: 3

Other representations of profile: CSV, Excel

Contained resources

• is_periodic