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: ENTRY - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the ENTRY logical model.

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

0. ENTRY
Definition

The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.

An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.


Base definition for all types defined in FHIR type system.

ShortThe abstract parent of all `ENTRY` subtypes.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
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Subject_validity: Subject validity must satisfy conditional constraints (subject_is_self() implies subject.generating_type = “PARTY_SELF”)
Other_participations_valid: Other participations valid must be present (other_participations.exists() implies other_participations.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. ENTRY.name
Definition

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. ENTRY.archetype-node-id
Definition

Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

At an archetype root point, the value of this attribute is always the stringified form of the _archetype_id_ found in the _archetype_details_ object.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ENTRY.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. ENTRY.links
Definition

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.

ShortLinks to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. ENTRY.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. ENTRY.feeder-audit
Definition

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.

ShortAudit 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.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. ENTRY.language
Definition

Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages .

ShortMandatory indicator of the localised language in which this Entry is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
16. ENTRY.encoding
Definition

Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets.

ShortName of character set in which text values in this Entry are encoded.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
18. ENTRY.other-participations
Definition

Other participations at ENTRY level.

ShortOther participations at `ENTRY` level.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/PARTICIPATION
Is Modifierfalse
20. ENTRY.workflow-id
Definition

Identifier of externally held workflow engine data for this workflow execution, for this subject of care.

ShortIdentifier of externally held workflow engine data for this workflow execution, for this subject of care.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
22. ENTRY.subject
Definition

Id of human subject of this ENTRY, e.g.:

  • organ donor
  • foetus
  • a family member
  • another clinically relevant person.
ShortId of human subject of this `ENTRY`, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
24. ENTRY.provider
Definition

Optional identification of provider of the information in this ENTRY, which might be:

  • the patient
  • a patient agent, e.g. parent, guardian
  • the clinician
  • a device or software

Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.

ShortOptional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse

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

0. ENTRY
Definition

The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.

An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.

ShortThe abstract parent of all `ENTRY` subtypes.
Control0..*
BindingThe codes SHALL be taken from Character Set
(required to https://specifications.openehr.org/fhir/valueset-character_sets)
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsSubject_validity: Subject validity must satisfy conditional constraints (subject_is_self() implies subject.generating_type = “PARTY_SELF”)
Other_participations_valid: Other participations valid must be present (other_participations.exists() implies other_participations.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. ENTRY.language
Definition

Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages .

ShortMandatory indicator of the localised language in which this Entry is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. ENTRY.encoding
Definition

Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets.

ShortName of character set in which text values in this Entry are encoded.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
6. ENTRY.other-participations
Definition

Other participations at ENTRY level.

ShortOther participations at `ENTRY` level.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/PARTICIPATION
Is Modifierfalse
8. ENTRY.workflow-id
Definition

Identifier of externally held workflow engine data for this workflow execution, for this subject of care.

ShortIdentifier of externally held workflow engine data for this workflow execution, for this subject of care.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
10. ENTRY.subject
Definition

Id of human subject of this ENTRY, e.g.:

  • organ donor
  • foetus
  • a family member
  • another clinically relevant person.
ShortId of human subject of this `ENTRY`, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
12. ENTRY.provider
Definition

Optional identification of provider of the information in this ENTRY, which might be:

  • the patient
  • a patient agent, e.g. parent, guardian
  • the clinician
  • a device or software

Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.

ShortOptional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse

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

0. ENTRY
Definition

The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.

An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.

ShortThe abstract parent of all `ENTRY` subtypes.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLinks_valid: Links valid must be present (links.exists() implies links.empty().not())
Archetyped_valid: Archetyped valid must satisfy exclusive conditions (is_archetype_root() xor archetype_details .empty())
Archetype_node_id_valid: Archetype node id valid must not be empty (archetype_node_id.empty().not())
Subject_validity: Subject validity must satisfy conditional constraints (subject_is_self() implies subject.generating_type = “PARTY_SELF”)
Other_participations_valid: Other participations valid must be present (other_participations.exists() implies other_participations.empty().not())
Is_archetype_root: Is archetype root (is_archetype_root())
2. ENTRY.name
Definition

Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

ShortRuntime name of this fragment, used to build runtime paths.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-TEXT
Is Modifierfalse
4. ENTRY.archetype-node-id
Definition

Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

At an archetype root point, the value of this attribute is always the stringified form of the _archetype_id_ found in the _archetype_details_ object.

ShortDesign-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ENTRY.uid
Definition

Optional globally unique object identifier for root points of archetyped structures.

ShortOptional globally unique object identifier for root points of archetyped structures.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/UID-BASED-ID
Is Modifierfalse
8. ENTRY.links
Definition

Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.

ShortLinks to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. ENTRY.archetype-details
Definition

Details of archetyping used on this node.

ShortDetails of archetyping used on this node.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ARCHETYPED
Is Modifierfalse
12. ENTRY.feeder-audit
Definition

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.

ShortAudit 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.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. ENTRY.language
Definition

Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages .

ShortMandatory indicator of the localised language in which this Entry is written.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
16. ENTRY.encoding
Definition

Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets.

ShortName of character set in which text values in this Entry are encoded.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
18. ENTRY.other-participations
Definition

Other participations at ENTRY level.

ShortOther participations at `ENTRY` level.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/PARTICIPATION
Is Modifierfalse
20. ENTRY.workflow-id
Definition

Identifier of externally held workflow engine data for this workflow execution, for this subject of care.

ShortIdentifier of externally held workflow engine data for this workflow execution, for this subject of care.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/OBJECT-REF
Is Modifierfalse
22. ENTRY.subject
Definition

Id of human subject of this ENTRY, e.g.:

  • organ donor
  • foetus
  • a family member
  • another clinically relevant person.
ShortId of human subject of this `ENTRY`, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse
24. ENTRY.provider
Definition

Optional identification of provider of the information in this ENTRY, which might be:

  • the patient
  • a patient agent, e.g. parent, guardian
  • the clinician
  • a device or software

Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.

ShortOptional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-PROXY
Is Modifierfalse