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

Official URL: http://openehr.org/fhir/StructureDefinition/EXTRACT Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: EXTRACT

Generic model of an Extract of some information from a repository.

Original Source: specifications.openehr.org

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Sequence_nr_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... time_created 1..1 DV_DATE_TIME Creation time of this Extract
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error EXTRACT Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error EXTRACT Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Links_valid error EXTRACT Links valid must be present links.exists() implies links.empty().not()
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed

This structure is derived from LOCATABLE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Sequence_nr_valid
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Sequence_nr_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... time_created 1..1 DV_DATE_TIME Creation time of this Extract
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error EXTRACT Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error EXTRACT Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Links_valid error EXTRACT Links valid must be present links.exists() implies links.empty().not()
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed

This structure is derived from LOCATABLE

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Sequence_nr_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... time_created 1..1 DV_DATE_TIME Creation time of this Extract
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error EXTRACT Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error EXTRACT Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Links_valid error EXTRACT Links valid must be present links.exists() implies links.empty().not()
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed

Differential View

This structure is derived from LOCATABLE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Sequence_nr_valid
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EXTRACT C 0..* LOCATABLE Generic model of an Extract of some information from a repository.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid, Sequence_nr_valid
... name 1..1 DV_TEXT Runtime name of this fragment, used to build runtime paths.
... archetype_node_id 1..1 string Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
... uid 0..1 UID_BASED_ID Optional globally unique object identifier for root points of archetyped structures.
... archetype_details 0..1 ARCHETYPED Details of archetyping used on this node.
... feeder_audit 0..1 FEEDER_AUDIT 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.
... chapters 0..* EXTRACT_CHAPTER The content extracted and serialised from the source repository for this Extract.
... specification 0..1 EXTRACT_SPEC The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.
... request_id 0..1 HIER_OBJECT_ID Reference to causing Request, if any.
... time_created 1..1 DV_DATE_TIME Creation time of this Extract
... system_id 1..1 HIER_OBJECT_ID Identifier of creating system.
... sequence_nr 1..1 integer Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.
... participations 0..* EXTRACT_PARTICIPATION Participations relevant to the creation of this Extract.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Archetype_node_id_valid error EXTRACT Archetype node id valid must not be empty archetype_node_id.empty().not()
Archetyped_valid error EXTRACT Archetyped valid must satisfy exclusive conditions is_archetype_root() xor archetype_details .empty()
Links_valid error EXTRACT Links valid must be present links.exists() implies links.empty().not()
Sequence_nr_valid error EXTRACT Sequence nr valid must satisfy range constraints null # TODO: manual translation needed

This structure is derived from LOCATABLE

Summary

Mandatory: 0 element(3 nested mandatory elements)

Maturity: 3

 

Other representations of profile: CSV, Excel