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/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions

Logical Model: EHR_STATUS - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the EHR-STATUS logical model.

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

0. EHR_STATUS
Definition

Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.


Base definition for all types defined in FHIR type system.

ShortSingle object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etcBase 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. EHR_STATUS.name
Definition

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. EHR_STATUS.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.

ShortDesign-time archetype identifier of this node taken from its generating archetype
Comments

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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EHR_STATUS.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. EHR_STATUS.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
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. EHR_STATUS.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. EHR_STATUS.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
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. EHR_STATUS.subject
Definition

The subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons.

ShortThe subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-SELF
Is Modifierfalse
16. EHR_STATUS.is-queryable
Definition

True if this EHR should be included in population queries, i.e. if this EHR is considered active in the population.

ShortTrue if this EHR should be included in population queries, i.e. if this EHR is considered active in the population
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHR_STATUS.is-modifiable
Definition

True if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to.

ShortTrue if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHR_STATUS.other-details
Definition

Any other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE.

ShortAny other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE
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. EHR_STATUS
Definition

Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.

ShortSingle object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHR_STATUS.subject
Definition

The subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons.

ShortThe subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-SELF
Is Modifierfalse
4. EHR_STATUS.is-queryable
Definition

True if this EHR should be included in population queries, i.e. if this EHR is considered active in the population.

ShortTrue if this EHR should be included in population queries, i.e. if this EHR is considered active in the population
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EHR_STATUS.is-modifiable
Definition

True if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to.

ShortTrue if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EHR_STATUS.other-details
Definition

Any other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE.

ShortAny other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE
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. EHR_STATUS
Definition

Single object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc. This object is always modifiable, in order to change the status of the EHR as a whole.

ShortSingle object per EHR containing various EHR-wide status flags and settings, including whether this EHR can be queried, modified etc
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHR_STATUS.name
Definition

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. EHR_STATUS.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.

ShortDesign-time archetype identifier of this node taken from its generating archetype
Comments

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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EHR_STATUS.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. EHR_STATUS.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
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/LINK
Is Modifierfalse
10. EHR_STATUS.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. EHR_STATUS.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
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT
Is Modifierfalse
14. EHR_STATUS.subject
Definition

The subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons.

ShortThe subject of this EHR. The external_ref attribute can be used to contain a direct reference to the subject in a demographic or identity service. Alternatively, the association between patients and their records may be done elsewhere for security reasons
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/PARTY-SELF
Is Modifierfalse
16. EHR_STATUS.is-queryable
Definition

True if this EHR should be included in population queries, i.e. if this EHR is considered active in the population.

ShortTrue if this EHR should be included in population queries, i.e. if this EHR is considered active in the population
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHR_STATUS.is-modifiable
Definition

True if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to.

ShortTrue if the EHR, other than the EHR_STATUS object, is allowed to be written to. The EHR_STATUS object itself can always be written to
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHR_STATUS.other-details
Definition

Any other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE.

ShortAny other details of the EHR summary object, in the form of an archetyped ITEM_STRUCTURE
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE
Is Modifierfalse