FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-HISTORY.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-HISTORY.html |
| URL | http://openehr.org/fhir/StructureDefinition/HISTORY |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | HISTORY |
| Title | HISTORY |
| Realm | uv |
| Authority | hl7 |
| Description | 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. |
| Type | http://openehr.org/fhir/StructureDefinition/HISTORY |
| Kind | logical |
| StructureDefinition | ||
| hl7.fhir.uv.openehr-test#current | openEHR-EHR-OBSERVATION.blood-pressure.v2 | openEHR-EHR-OBSERVATION.blood_pressure.v2 |
| openehr.base#0.1.0-snapshot | OBSERVATION | OBSERVATION |
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | DATA-STRUCTURE | DATA_STRUCTURE |
| openehr.base#0.1.0-snapshot | DV-DATE-TIME | DV_DATE_TIME |
| openehr.base#0.1.0-snapshot | DV-DURATION | DV_DURATION |
| openehr.base#0.1.0-snapshot | EVENT | EVENT |
| openehr.base#0.1.0-snapshot | ITEM-STRUCTURE | ITEM_STRUCTURE |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition HISTORY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "HISTORY",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"contained": [
{
"resourceType": "OperationDefinition",
"id": "is_periodic",
"name": "is_periodic",
"title": "is_periodic",
"status": "active",
"kind": "operation",
"description": "Indicates whether history is periodic. \n",
"code": "is_periodic",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "boolean"
}
]
}
],
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_history_class"
},
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#is_periodic"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/HISTORY",
"version": "0.1.0-snapshot",
"name": "HISTORY",
"title": "HISTORY",
"status": "active",
"experimental": false,
"date": "2025-09-06T15:35:39+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "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.\n\nFor 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. ",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://openehr.org/fhir/StructureDefinition/HISTORY",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/DATA-STRUCTURE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "HISTORY",
"path": "HISTORY",
"short": "Root object of a linear history, i.",
"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.\n\nFor 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. ",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "Links_valid",
"severity": "error",
"human": "Links valid must be present",
"expression": "links.exists() implies links.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetyped_valid",
"severity": "error",
"human": "Archetyped valid must satisfy exclusive conditions",
"expression": "is_archetype_root() xor archetype_details .empty()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Archetype_node_id_valid",
"severity": "error",
"human": "Archetype node id valid must not be empty",
"expression": "archetype_node_id.empty().not()",
"source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key": "Events_valid",
"severity": "error",
"human": "Events valid must be present",
"expression": "(events.exists() and then events.empty().not()) or summary.exists()"
},
{
"key": "Periodic_validity",
"severity": "error",
"human": "Periodic validity must satisfy exclusive conditions",
"expression": "is_periodic() xor period .empty()"
},
{
"key": "Period_consistency",
"severity": "error",
"human": "Period consistency must satisfy conditional constraints",
"expression": "is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HISTORY.name",
"path": "HISTORY.name",
"short": "Runtime name of this fragment, used to build runtime paths.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "HISTORY.archetype-node-id",
"path": "HISTORY.archetype_node_id",
"short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
"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. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.",
"min": 1,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_node_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "HISTORY.uid",
"path": "HISTORY.uid",
"short": "Optional globally unique object identifier for root points of archetyped structures.",
"definition": "Optional globally unique object identifier for root points of archetyped structures.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.uid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier": false
},
{
"id": "HISTORY.links",
"path": "HISTORY.links",
"short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "LOCATABLE.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier": false
},
{
"id": "HISTORY.archetype-details",
"path": "HISTORY.archetype_details",
"short": "Details of archetyping used on this node.",
"definition": "Details of archetyping used on this node.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.archetype_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier": false
},
{
"id": "HISTORY.feeder-audit",
"path": "HISTORY.feeder_audit",
"short": "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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "LOCATABLE.feeder_audit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier": false
},
{
"id": "HISTORY.origin",
"path": "HISTORY.origin",
"short": "Time origin of this event history.",
"definition": "Time origin of this event history. The first event is not necessarily at the origin point.",
"min": 1,
"max": "1",
"base": {
"path": "HISTORY.origin",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "HISTORY.period",
"path": "HISTORY.period",
"short": "Period between samples in this segment if periodic.",
"definition": "Period between samples in this segment if periodic.",
"min": 0,
"max": "1",
"base": {
"path": "HISTORY.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
}
],
"isModifier": false
},
{
"id": "HISTORY.duration",
"path": "HISTORY.duration",
"short": "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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HISTORY.duration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
}
],
"isModifier": false
},
{
"id": "HISTORY.summary",
"path": "HISTORY.summary",
"short": "Optional summary data that aggregates, organizes, reduces and transforms the event series.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HISTORY.summary",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"isModifier": false
},
{
"id": "HISTORY.events",
"path": "HISTORY.events",
"short": "The events in the series.",
"definition": "The events in the series. This attribute is of a generic type whose parameter must be a descendant of `ITEM_SUTRUCTURE`.",
"min": 0,
"max": "*",
"base": {
"path": "HISTORY.events",
"min": 0,
"max": "*"
},
"type": [
{
"extension": [
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/T"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/EVENT"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "HISTORY",
"path": "HISTORY",
"short": "Root object of a linear history, i.",
"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.\n\nFor 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. ",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Events_valid",
"severity": "error",
"human": "Events valid must be present",
"expression": "(events.exists() and then events.empty().not()) or summary.exists()"
},
{
"key": "Periodic_validity",
"severity": "error",
"human": "Periodic validity must satisfy exclusive conditions",
"expression": "is_periodic() xor period .empty()"
},
{
"key": "Period_consistency",
"severity": "error",
"human": "Period consistency must satisfy conditional constraints",
"expression": "is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)"
}
],
"isModifier": false
},
{
"id": "HISTORY.origin",
"path": "HISTORY.origin",
"short": "Time origin of this event history.",
"definition": "Time origin of this event history. The first event is not necessarily at the origin point. ",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "HISTORY.period",
"path": "HISTORY.period",
"short": "Period between samples in this segment if periodic.",
"definition": "Period between samples in this segment if periodic.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
}
],
"isModifier": false
},
{
"id": "HISTORY.duration",
"path": "HISTORY.duration",
"short": "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.",
"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. ",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DURATION"
}
],
"isModifier": false
},
{
"id": "HISTORY.summary",
"path": "HISTORY.summary",
"short": "Optional summary data that aggregates, organizes, reduces and transforms the event series.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"isModifier": false
},
{
"id": "HISTORY.events",
"path": "HISTORY.events",
"short": "The events in the series.",
"definition": "The events in the series. This attribute is of a generic type whose parameter must be a descendant of `ITEM_SUTRUCTURE`.",
"min": 0,
"max": "*",
"type": [
{
"extension": [
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/T"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/EVENT"
}
],
"isModifier": false
}
]
}
}