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

Page standards status: Informative Maturity Level: 3

Definitions for the EXTRACT-ENTITY-MANIFEST logical model.

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

0. EXTRACT_ENTITY_MANIFEST
Definition

The manifest for one entity (e.g. EHR subject), identifying the entity and optionally specifying top-level items to be included in the Extract. The list actually included may be modified by the _version_spec_ part of the specification, and also by the link_depth attribute. In repeat (standing order) requests, the final inclusion may be modified by the send_changes_only value for EXTRACT_UPDATE_SPEC._update_method_.

Various identifiers may be provided for the entity; these are to be used by the receiver system to locate the entity. The _extract_id_key_ attribute is used to record the identifier that will be used throughout the Extract for this entity, including in instances of EXTRACT_ENTITY_IDENTIFIER.


Base definition for all types defined in FHIR type system.

ShortThe manifest for one entity (e.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_ENTITY_MANIFEST.extract-id-key
Definition

Identifier by which this entity is known in the Extract. May be one of the other identifiers, e.g. ehr_id or subject_id, or it may be something else, including a simple integer.

ShortIdentifier by which this entity is known in the Extract.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_ENTITY_MANIFEST.ehr-id
Definition

EHR / EMR identifier for the entity at the target system.

ShortEHR / EMR identifier for the entity at the target system.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EXTRACT_ENTITY_MANIFEST.subject-id
Definition

Subject (i.e. patient or similar) identifier for the entity at the target system.

ShortSubject (i.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_ENTITY_MANIFEST.other-ids
Definition

Other identifiers that may be used to find the entity at the target system, keyed by type. May include medicare numbers, drivers license number, tax number etc.

ShortOther identifiers that may be used to find the entity at the target system, keyed by type.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_ENTITY_MANIFEST.item-list
Definition

List of Uids of items to be included in the Extract, in cases where individual items are being requested by id. More typically, this attribute is not used, and the EXTRACT_SPEC._criteria query_ defines the Extract contents. If set, for openEHR data, these are Uids identifying the version containers.

ShortList of Uids of items to be included in the Extract, in cases where individual items are being requested by id.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse

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

0. EXTRACT_ENTITY_MANIFEST
Definition

The manifest for one entity (e.g. EHR subject), identifying the entity and optionally specifying top-level items to be included in the Extract. The list actually included may be modified by the _version_spec_ part of the specification, and also by the link_depth attribute. In repeat (standing order) requests, the final inclusion may be modified by the send_changes_only value for EXTRACT_UPDATE_SPEC._update_method_.

Various identifiers may be provided for the entity; these are to be used by the receiver system to locate the entity. The _extract_id_key_ attribute is used to record the identifier that will be used throughout the Extract for this entity, including in instances of EXTRACT_ENTITY_IDENTIFIER.

ShortThe manifest for one entity (e.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EXTRACT_ENTITY_MANIFEST.extract-id-key
Definition

Identifier by which this entity is known in the Extract. May be one of the other identifiers, e.g. ehr_id or subject_id, or it may be something else, including a simple integer.

ShortIdentifier by which this entity is known in the Extract.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_ENTITY_MANIFEST.ehr-id
Definition

EHR / EMR identifier for the entity at the target system.

ShortEHR / EMR identifier for the entity at the target system.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EXTRACT_ENTITY_MANIFEST.subject-id
Definition

Subject (i.e. patient or similar) identifier for the entity at the target system.

ShortSubject (i.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_ENTITY_MANIFEST.other-ids
Definition

Other identifiers that may be used to find the entity at the target system, keyed by type. May include medicare numbers, drivers license number, tax number etc.

ShortOther identifiers that may be used to find the entity at the target system, keyed by type.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_ENTITY_MANIFEST.item-list
Definition

List of Uids of items to be included in the Extract, in cases where individual items are being requested by id. More typically, this attribute is not used, and the EXTRACT_SPEC._criteria query_ defines the Extract contents. If set, for openEHR data, these are Uids identifying the version containers.

ShortList of Uids of items to be included in the Extract, in cases where individual items are being requested by id.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse

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

0. EXTRACT_ENTITY_MANIFEST
Definition

The manifest for one entity (e.g. EHR subject), identifying the entity and optionally specifying top-level items to be included in the Extract. The list actually included may be modified by the _version_spec_ part of the specification, and also by the link_depth attribute. In repeat (standing order) requests, the final inclusion may be modified by the send_changes_only value for EXTRACT_UPDATE_SPEC._update_method_.

Various identifiers may be provided for the entity; these are to be used by the receiver system to locate the entity. The _extract_id_key_ attribute is used to record the identifier that will be used throughout the Extract for this entity, including in instances of EXTRACT_ENTITY_IDENTIFIER.

ShortThe manifest for one entity (e.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EXTRACT_ENTITY_MANIFEST.extract-id-key
Definition

Identifier by which this entity is known in the Extract. May be one of the other identifiers, e.g. ehr_id or subject_id, or it may be something else, including a simple integer.

ShortIdentifier by which this entity is known in the Extract.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_ENTITY_MANIFEST.ehr-id
Definition

EHR / EMR identifier for the entity at the target system.

ShortEHR / EMR identifier for the entity at the target system.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EXTRACT_ENTITY_MANIFEST.subject-id
Definition

Subject (i.e. patient or similar) identifier for the entity at the target system.

ShortSubject (i.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EXTRACT_ENTITY_MANIFEST.other-ids
Definition

Other identifiers that may be used to find the entity at the target system, keyed by type. May include medicare numbers, drivers license number, tax number etc.

ShortOther identifiers that may be used to find the entity at the target system, keyed by type.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EXTRACT_ENTITY_MANIFEST.item-list
Definition

List of Uids of items to be included in the Extract, in cases where individual items are being requested by id. More typically, this attribute is not used, and the EXTRACT_SPEC._criteria query_ defines the Extract contents. If set, for openEHR data, these are Uids identifying the version containers.

ShortList of Uids of items to be included in the Extract, in cases where individual items are being requested by id.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse