Generated Narrative: StructureDefinition EXTRACT-VERSION-SPEC

NameFlagsCard.TypeDescription & Constraintsdoco
.. EXTRACT_VERSION_SPEC C0..*AnySpecification of what versions should be included in an Extract.
Constraints: Includes_revision_history_valid
... include_all_versions 1..1booleanTrue if all versions of each item in the Extract are included.
... commit_time_interval 0..1DV_INTERVAL<DV_DATE_TIME>Specifies commit time interval of items to source repository to include in Extract.
... include_revision_history 1..1booleanTrue if revision histories of the items in the Extract are included.
... include_data 1..1boolean`True` if the data of items matched by the content spec should be included.

doco Documentation for this format
 <status value="active"/> <experimental value="false"/> <date value="2025-09-06T15:35:39+10:00"/> <publisher value="openEHR + HL7"/> <contact> <telecom> <system value="url"/> <value value="http://www.openehr.org"/> </telecom> </contact> <description value="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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> </coding> </jurisdiction> <fhirVersion value="5.0.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="http://openehr.org/fhir/StructureDefinition/EXTRACT_VERSION_SPEC"/> <baseDefinition value="http://openehr.org/fhir/StructureDefinition/Any"/> <derivation value="specialization"/> <snapshot> <extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version"> <valueString value="0.1.0-snapshot"/> </extension> <element id="EXTRACT_VERSION_SPEC"> <path value="EXTRACT_VERSION_SPEC"/> <short value="Specification of what versions should be included in an Extract."/> <definition value="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."/> <min value="0"/> <max value="*"/> <base> <path value="Base"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="Includes_revision_history_valid"/> <severity value="error"/> <human value="Includes revision history valid must satisfy conditional constraints"/> <expression value="include_dat.not()a implies include_revision_history"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="EXTRACT_VERSION_SPEC.include-all-versions"> <path value="EXTRACT_VERSION_SPEC.include_all_versions"/> <short value="True if all versions of each item in the Extract are included."/> <definition value="True if all versions of each item in the Extract are included."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_VERSION_SPEC.include_all_versions"/> <min value="1"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.commit-time-interval"> <path value="EXTRACT_VERSION_SPEC.commit_time_interval"/> <short value="Specifies commit time interval of items to source repository to include in Extract."/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="EXTRACT_VERSION_SPEC.commit_time_interval"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter"> <extension url="name"> <valueCode value="T"/> </extension> <extension url="type"> <valueUri value="http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"/> </extension> </extension> <code value="http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.include-revision-history"> <path value="EXTRACT_VERSION_SPEC.include_revision_history"/> <short value="True if revision histories of the items in the Extract are included."/> <definition value="True if revision histories of the items in the Extract are included. If included, it is always the full revision history."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_VERSION_SPEC.include_revision_history"/> <min value="1"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.include-data"> <path value="EXTRACT_VERSION_SPEC.include_data"/> <short value="`True` if the data of items matched by the content spec should be included."/> <definition value="`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."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_VERSION_SPEC.include_data"/> <min value="1"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> </snapshot> <differential> <element id="EXTRACT_VERSION_SPEC"> <path value="EXTRACT_VERSION_SPEC"/> <short value="Specification of what versions should be included in an Extract."/> <definition value="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."/> <min value="0"/> <max value="*"/> <constraint> <key value="Includes_revision_history_valid"/> <severity value="error"/> <human value="Includes revision history valid must satisfy conditional constraints"/> <expression value="include_dat.not()a implies include_revision_history"/> </constraint> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.include-all-versions"> <path value="EXTRACT_VERSION_SPEC.include_all_versions"/> <short value="True if all versions of each item in the Extract are included."/> <definition value="True if all versions of each item in the Extract are included."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.commit-time-interval"> <path value="EXTRACT_VERSION_SPEC.commit_time_interval"/> <short value="Specifies commit time interval of items to source repository to include in Extract."/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <extension url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter"> <extension url="name"> <valueCode value="T"/> </extension> <extension url="type"> <valueUri value="http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"/> </extension> </extension> <code value="http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.include-revision-history"> <path value="EXTRACT_VERSION_SPEC.include_revision_history"/> <short value="True if revision histories of the items in the Extract are included."/> <definition value="True if revision histories of the items in the Extract are included. If included, it is always the full revision history."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_VERSION_SPEC.include-data"> <path value="EXTRACT_VERSION_SPEC.include_data"/> <short value="`True` if the data of items matched by the content spec should be included."/> <definition value="`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."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> </differential> </StructureDefinition>