EXTRACT_VERSION_SPEC - Definitions - OpenEHR Base package v0.1.0

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: EXTRACT_VERSION_SPEC - Detailed Descriptions

Page standards status: Informative

Maturity Level: 3

Definitions for the EXTRACT-VERSION-SPEC logical model.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

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

0. EXTRACT_VERSION_SPEC
Definition	Specification of what versions should be included in an Extract. By default, only latest versions are included in the Extract, in which case this part of the Extract specification is not needed at all. The attributes `_include_all_versions_` and `_commit_time_interval_` are used to modify this; the former forces all versions to be included; the latter limits the versions to be those latest versions committed in the time interval, or if `_include_all_versions_` is `True`, all versions committed in the time interval. Base definition for all types defined in FHIR type system.
Short	Specification of what versions should be included in an Extract.Base for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	Includes_revision_history_valid: Includes revision history valid must satisfy conditional constraints (`include_dat.not()a implies include_revision_history`)
2. EXTRACT_VERSION_SPEC.include-all-versions
Definition	True if all versions of each item in the Extract are included.
Short	True if all versions of each item in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_VERSION_SPEC.commit-time-interval
Definition	Specifies commit time interval of items to source repository to include in Extract. By default, only latest versions whose commit times fall in the range are included. If include_all_versions is True, then the range includes all versions committed within the interval.
Short	Specifies commit time interval of items to source repository to include in Extract.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME>
Is Modifier	false
6. EXTRACT_VERSION_SPEC.include-revision-history
Definition	True if revision histories of the items in the Extract are included. If included, it is always the full revision history.
Short	True if revision histories of the items in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_VERSION_SPEC.include-data
Definition	`True` if the data of items matched by the content spec should be included. This is the default. If `False`, only revision history is included in serialised versions. Turning this option on in openEHR systems causes `X_VERSIONED_OBJECTs` to have `_revision_history_` set, but versions Void. Useful for interrogating a server without having to look at any content data. In other systems it may or may not have a sensible meaning.
Short	`True` if the data of items matched by the content spec should be included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

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

0. EXTRACT_VERSION_SPEC
Definition	Specification of what versions should be included in an Extract. By default, only latest versions are included in the Extract, in which case this part of the Extract specification is not needed at all. The attributes `_include_all_versions_` and `_commit_time_interval_` are used to modify this; the former forces all versions to be included; the latter limits the versions to be those latest versions committed in the time interval, or if `_include_all_versions_` is `True`, all versions committed in the time interval.
Short	Specification of what versions should be included in an Extract.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	Includes_revision_history_valid: Includes revision history valid must satisfy conditional constraints (`include_dat.not()a implies include_revision_history`)
2. EXTRACT_VERSION_SPEC.include-all-versions
Definition	True if all versions of each item in the Extract are included.
Short	True if all versions of each item in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_VERSION_SPEC.commit-time-interval
Definition	Specifies commit time interval of items to source repository to include in Extract. By default, only latest versions whose commit times fall in the range are included. If include_all_versions is True, then the range includes all versions committed within the interval.
Short	Specifies commit time interval of items to source repository to include in Extract.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME>
Is Modifier	false
6. EXTRACT_VERSION_SPEC.include-revision-history
Definition	True if revision histories of the items in the Extract are included. If included, it is always the full revision history.
Short	True if revision histories of the items in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_VERSION_SPEC.include-data
Definition	`True` if the data of items matched by the content spec should be included. This is the default. If `False`, only revision history is included in serialised versions. Turning this option on in openEHR systems causes `X_VERSIONED_OBJECTs` to have `_revision_history_` set, but versions Void. Useful for interrogating a server without having to look at any content data. In other systems it may or may not have a sensible meaning.
Short	`True` if the data of items matched by the content spec should be included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

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

0. EXTRACT_VERSION_SPEC
Definition	Specification of what versions should be included in an Extract. By default, only latest versions are included in the Extract, in which case this part of the Extract specification is not needed at all. The attributes `_include_all_versions_` and `_commit_time_interval_` are used to modify this; the former forces all versions to be included; the latter limits the versions to be those latest versions committed in the time interval, or if `_include_all_versions_` is `True`, all versions committed in the time interval.
Short	Specification of what versions should be included in an Extract.
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
Invariants	Includes_revision_history_valid: Includes revision history valid must satisfy conditional constraints (`include_dat.not()a implies include_revision_history`)
2. EXTRACT_VERSION_SPEC.include-all-versions
Definition	True if all versions of each item in the Extract are included.
Short	True if all versions of each item in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_VERSION_SPEC.commit-time-interval
Definition	Specifies commit time interval of items to source repository to include in Extract. By default, only latest versions whose commit times fall in the range are included. If include_all_versions is True, then the range includes all versions committed within the interval.
Short	Specifies commit time interval of items to source repository to include in Extract.
Control	0..1
Type	http://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME>
Is Modifier	false
6. EXTRACT_VERSION_SPEC.include-revision-history
Definition	True if revision histories of the items in the Extract are included. If included, it is always the full revision history.
Short	True if revision histories of the items in the Extract are included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_VERSION_SPEC.include-data
Definition	`True` if the data of items matched by the content spec should be included. This is the default. If `False`, only revision history is included in serialised versions. Turning this option on in openEHR systems causes `X_VERSIONED_OBJECTs` to have `_revision_history_` set, but versions Void. Useful for interrogating a server without having to look at any content data. In other systems it may or may not have a sensible meaning.
Short	`True` if the data of items matched by the content spec should be included.
Control	1..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

IG © 2022+ openEHR + HL7. Package openehr.base#0.1.0 based on FHIR 5.0.0. Generated 2025-10-16
Links: Table of Contents | QA Report