FHIR IG analytics
| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EXTRACT-VERSION-SPEC.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/openehr-fhir/base-spec/StructureDefinition-EXTRACT-VERSION-SPEC.html |
| URL | http://openehr.org/fhir/StructureDefinition/EXTRACT_VERSION_SPEC |
| Version | 0.1.0 |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | EXTRACT_VERSION_SPEC |
| Title | EXTRACT_VERSION_SPEC |
| Realm | uv |
| Authority | hl7 |
| Description | 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. |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT_VERSION_SPEC |
| Kind | logical |
Resources that use this resource
| StructureDefinition |
| openehr.base#current | EXTRACT_SPEC | EXTRACT_SPEC |
Resources that this resource uses
| StructureDefinition |
| openehr.base#current | Any | Any |
| openehr.base#current | DV_INTERVAL | DV_INTERVAL |
Narrative
Note: links and images are rebased to the (stated) source
Source1
{
"resourceType": "StructureDefinition",
"id": "EXTRACT-VERSION-SPEC",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/BASE/latest/foundation_types.html#_any_class"
},
{
"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/EXTRACT_VERSION_SPEC",
"version": "0.1.0",
"name": "EXTRACT_VERSION_SPEC",
"title": "EXTRACT_VERSION_SPEC",
"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": "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": "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/EXTRACT_VERSION_SPEC",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/Any",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0"
}
],
"element": [
{
"id": "EXTRACT_VERSION_SPEC",
"path": "EXTRACT_VERSION_SPEC",
"short": "Specification of what versions should be included in an Extract.",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "includes-revision-history-valid",
"severity": "error",
"human": "Includes revision history valid must satisfy conditional constraints",
"expression": "include_data.not() implies include_revision_history"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EXTRACT_VERSION_SPEC.include-all-versions",
"path": "EXTRACT_VERSION_SPEC.include_all_versions",
"short": "True if all versions of each item in the Extract are included.",
"definition": "True if all versions of each item in the Extract are included.",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT_VERSION_SPEC.include_all_versions",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.commit-time-interval",
"path": "EXTRACT_VERSION_SPEC.commit_time_interval",
"short": "Specifies commit time interval of items to source repository to include in Extract.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "EXTRACT_VERSION_SPEC.commit_time_interval",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/DV_INTERVAL"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.include-revision-history",
"path": "EXTRACT_VERSION_SPEC.include_revision_history",
"short": "True if revision histories of the items in the Extract are included.",
"definition": "True if revision histories of the items in the Extract are included. If included, it is always the full revision history.",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT_VERSION_SPEC.include_revision_history",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.include-data",
"path": "EXTRACT_VERSION_SPEC.include_data",
"short": "`True` if the data of items matched by the content spec should be included.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT_VERSION_SPEC.include_data",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "EXTRACT_VERSION_SPEC",
"path": "EXTRACT_VERSION_SPEC",
"short": "Specification of what versions should be included in an Extract.",
"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.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "includes-revision-history-valid",
"severity": "error",
"human": "Includes revision history valid must satisfy conditional constraints",
"expression": "include_data.not() implies include_revision_history"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.include-all-versions",
"path": "EXTRACT_VERSION_SPEC.include_all_versions",
"short": "True if all versions of each item in the Extract are included.",
"definition": "True if all versions of each item in the Extract are included.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.commit-time-interval",
"path": "EXTRACT_VERSION_SPEC.commit_time_interval",
"short": "Specifies commit time interval of items to source repository to include in Extract.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"extension": [
{
"extension": [
{
"url": "name",
"valueCode": "T"
},
{
"url": "type",
"valueUri": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/DV_INTERVAL"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.include-revision-history",
"path": "EXTRACT_VERSION_SPEC.include_revision_history",
"short": "True if revision histories of the items in the Extract are included.",
"definition": "True if revision histories of the items in the Extract are included. If included, it is always the full revision history.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "EXTRACT_VERSION_SPEC.include-data",
"path": "EXTRACT_VERSION_SPEC.include_data",
"short": "`True` if the data of items matched by the content spec should be included.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
]
}
}
EXTRACT_VERSION_SPEC 
include_all_versions 
commit_time_interval 
FHIR
FHIRsmith