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_SPEC - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the EXTRACT-SPEC logical model.

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

0. EXTRACT_SPEC
Definition

Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract).

Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract.


Base definition for all types defined in FHIR type system.

ShortSpecification of an Extract's contents.Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EXTRACT_SPEC.version-spec
Definition

Specification of which versions of information items to include in the Extract. If Void, the default is latest versions only (which is reasonable for non-versioning systems as well).

ShortSpecification of which versions of information items to include in the Extract.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-VERSION-SPEC
Is Modifierfalse
4. EXTRACT_SPEC.manifest
Definition

Specification of entities (e.g. records) to include in the Extract.

ShortSpecification of entities (e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-MANIFEST
Is Modifierfalse
6. EXTRACT_SPEC.extract-type
Definition

Coded term indicating the type of content required, e.g.

  • |openehr-ehr|
  • |openehr-demographic|
  • |generic-emr|
  • |other|

Coded by openEHR Terminology group 'extract content type'.

ShortCoded term indicating the type of content required, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_SPEC.include-multimedia
Definition

Indicates whether in-line instances of DV_MULTIMEDIA in the source data are included or not.

ShortIndicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_SPEC.priority
Definition

Requested priority of this request to be handled by server. Priority schemes are likely to be local, and use values agreed by both ends.

TBD: alternative is standard coded terms

ShortRequested priority of this request to be handled by server.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EXTRACT_SPEC.link-depth
Definition

Degree of links to follow emanating from content items specified for inclusion. The kind of links to follow is dependent on the type of Extract.

All items at the target end of followed links at the given depth are also included in the extract; EXTRACT_CONTENT_ITEM._is_primary_ is used to differentiate.

  • 0 = don't follow;
  • 1 = follow first degree links;
  • 2 = follow 2nd degree links;
  • ....
  • n = follow nth degree links
ShortDegree of links to follow emanating from content items specified for inclusion.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. EXTRACT_SPEC.criteria
Definition

Queries specifying the contents of this Extract.

ShortQueries specifying the contents of this Extract.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-PARSABLE
Is Modifierfalse
16. EXTRACT_SPEC.other-details
Definition

Other specification items. Archetypable.

ShortOther specification items.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse

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

0. EXTRACT_SPEC
Definition

Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract).

Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract.

ShortSpecification of an Extract's contents.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EXTRACT_SPEC.version-spec
Definition

Specification of which versions of information items to include in the Extract. If Void, the default is latest versions only (which is reasonable for non-versioning systems as well).

ShortSpecification of which versions of information items to include in the Extract.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-VERSION-SPEC
Is Modifierfalse
4. EXTRACT_SPEC.manifest
Definition

Specification of entities (e.g. records) to include in the Extract.

ShortSpecification of entities (e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-MANIFEST
Is Modifierfalse
6. EXTRACT_SPEC.extract-type
Definition

Coded term indicating the type of content required, e.g.

  • |openehr-ehr|
  • |openehr-demographic|
  • |generic-emr|
  • |other|

Coded by openEHR Terminology group 'extract content type'.

ShortCoded term indicating the type of content required, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_SPEC.include-multimedia
Definition

Indicates whether in-line instances of DV_MULTIMEDIA in the source data are included or not.

ShortIndicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_SPEC.priority
Definition

Requested priority of this request to be handled by server. Priority schemes are likely to be local, and use values agreed by both ends.

TBD: alternative is standard coded terms

ShortRequested priority of this request to be handled by server.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EXTRACT_SPEC.link-depth
Definition

Degree of links to follow emanating from content items specified for inclusion. The kind of links to follow is dependent on the type of Extract.

All items at the target end of followed links at the given depth are also included in the extract; EXTRACT_CONTENT_ITEM._is_primary_ is used to differentiate.

  • 0 = don't follow;
  • 1 = follow first degree links;
  • 2 = follow 2nd degree links;
  • ....
  • n = follow nth degree links
ShortDegree of links to follow emanating from content items specified for inclusion.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. EXTRACT_SPEC.criteria
Definition

Queries specifying the contents of this Extract.

ShortQueries specifying the contents of this Extract.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-PARSABLE
Is Modifierfalse
16. EXTRACT_SPEC.other-details
Definition

Other specification items. Archetypable.

ShortOther specification items.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse

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

0. EXTRACT_SPEC
Definition

Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract).

Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract.

ShortSpecification of an Extract's contents.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EXTRACT_SPEC.version-spec
Definition

Specification of which versions of information items to include in the Extract. If Void, the default is latest versions only (which is reasonable for non-versioning systems as well).

ShortSpecification of which versions of information items to include in the Extract.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-VERSION-SPEC
Is Modifierfalse
4. EXTRACT_SPEC.manifest
Definition

Specification of entities (e.g. records) to include in the Extract.

ShortSpecification of entities (e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT-MANIFEST
Is Modifierfalse
6. EXTRACT_SPEC.extract-type
Definition

Coded term indicating the type of content required, e.g.

  • |openehr-ehr|
  • |openehr-demographic|
  • |generic-emr|
  • |other|

Coded by openEHR Terminology group 'extract content type'.

ShortCoded term indicating the type of content required, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_SPEC.include-multimedia
Definition

Indicates whether in-line instances of DV_MULTIMEDIA in the source data are included or not.

ShortIndicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_SPEC.priority
Definition

Requested priority of this request to be handled by server. Priority schemes are likely to be local, and use values agreed by both ends.

TBD: alternative is standard coded terms

ShortRequested priority of this request to be handled by server.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EXTRACT_SPEC.link-depth
Definition

Degree of links to follow emanating from content items specified for inclusion. The kind of links to follow is dependent on the type of Extract.

All items at the target end of followed links at the given depth are also included in the extract; EXTRACT_CONTENT_ITEM._is_primary_ is used to differentiate.

  • 0 = don't follow;
  • 1 = follow first degree links;
  • 2 = follow 2nd degree links;
  • ....
  • n = follow nth degree links
ShortDegree of links to follow emanating from content items specified for inclusion.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. EXTRACT_SPEC.criteria
Definition

Queries specifying the contents of this Extract.

ShortQueries specifying the contents of this Extract.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-PARSABLE
Is Modifierfalse
16. EXTRACT_SPEC.other-details
Definition

Other specification items. Archetypable.

ShortOther specification items.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse