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

Page standards status: Informative Maturity Level: 3

Definitions for the DV-ORDERED logical model.

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

0. DV_ORDERED
Definition

Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions < and _is_strictly_comparable_to()_, the latter of which must evaluate to True for instances being compared with the < function, or used as limits in the DV_INTERVAL\<T> class.

Data value types which are to be used as limits in the DV_INTERVAL\<T> class must inherit from this class, and implement the function _is_strictly_comparable_to()_ to ensure that instances compare meaningfully. For example, instances of DV_QUANTITY can only be compared if they measure the same kind of physical quantity.


Base definition for all types defined in FHIR type system.

ShortAbstract class defining the concept of ordered values, which includes ordinals as well as true quantities.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
InvariantsOther_reference_ranges_validity: Other reference ranges validity must be present (other_reference_ranges.exists() implies other_reference_ranges.empty().not())
Is_simple_validity: Is simple validity must satisfy conditional constraints ((normal_range .empty() and other_reference_ranges .empty()) implies is_simple())
Normal_range_and_status_consistency: Normal range and status consistency must be present ((normal_range.exists() and normal_status.exists()) implies (normal_status.code_string.is_equal (“N”) xor normal_range.not().has (self)))
2. DV_ORDERED.CR
Definition

Carriage return character.

ShortCarriage return character.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DV_ORDERED.LF
Definition

Line feed character.

ShortLine feed character.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DV_ORDERED.Local-terminology-id
Definition

Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype

ShortPredefined terminology identifier
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DV_ORDERED.normal-status
Definition

Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group normal_status.

ShortOptional normal status indicator of value with respect to normal range for this value.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
10. DV_ORDERED.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL
Is Modifierfalse
12. DV_ORDERED.other-reference-ranges
Definition

Optional tagged other reference ranges for this value in its particular measurement context.

ShortOptional tagged other reference ranges for this value in its particular measurement context.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE<http://openehr.org/fhir/StructureDefinition/DV-ORDERED>
Is Modifierfalse

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

0. DV_ORDERED
Definition

Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions < and _is_strictly_comparable_to()_, the latter of which must evaluate to True for instances being compared with the < function, or used as limits in the DV_INTERVAL\<T> class.

Data value types which are to be used as limits in the DV_INTERVAL\<T> class must inherit from this class, and implement the function _is_strictly_comparable_to()_ to ensure that instances compare meaningfully. For example, instances of DV_QUANTITY can only be compared if they measure the same kind of physical quantity.

ShortAbstract class defining the concept of ordered values, which includes ordinals as well as true quantities.
Control0..*
BindingThe codes SHALL be taken from Normal statuses
(required to https://specifications.openehr.org/fhir/valueset-normal_statuses)
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOther_reference_ranges_validity: Other reference ranges validity must be present (other_reference_ranges.exists() implies other_reference_ranges.empty().not())
Is_simple_validity: Is simple validity must satisfy conditional constraints ((normal_range .empty() and other_reference_ranges .empty()) implies is_simple())
Normal_range_and_status_consistency: Normal range and status consistency must be present ((normal_range.exists() and normal_status.exists()) implies (normal_status.code_string.is_equal (“N”) xor normal_range.not().has (self)))
2. DV_ORDERED.normal-status
Definition

Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group normal_status.

ShortOptional normal status indicator of value with respect to normal range for this value.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. DV_ORDERED.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL
Is Modifierfalse
6. DV_ORDERED.other-reference-ranges
Definition

Optional tagged other reference ranges for this value in its particular measurement context.

ShortOptional tagged other reference ranges for this value in its particular measurement context.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE<http://openehr.org/fhir/StructureDefinition/DV-ORDERED>
Is Modifierfalse

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

0. DV_ORDERED
Definition

Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions < and _is_strictly_comparable_to()_, the latter of which must evaluate to True for instances being compared with the < function, or used as limits in the DV_INTERVAL\<T> class.

Data value types which are to be used as limits in the DV_INTERVAL\<T> class must inherit from this class, and implement the function _is_strictly_comparable_to()_ to ensure that instances compare meaningfully. For example, instances of DV_QUANTITY can only be compared if they measure the same kind of physical quantity.

ShortAbstract class defining the concept of ordered values, which includes ordinals as well as true quantities.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOther_reference_ranges_validity: Other reference ranges validity must be present (other_reference_ranges.exists() implies other_reference_ranges.empty().not())
Is_simple_validity: Is simple validity must satisfy conditional constraints ((normal_range .empty() and other_reference_ranges .empty()) implies is_simple())
Normal_range_and_status_consistency: Normal range and status consistency must be present ((normal_range.exists() and normal_status.exists()) implies (normal_status.code_string.is_equal (“N”) xor normal_range.not().has (self)))
2. DV_ORDERED.CR
Definition

Carriage return character.

ShortCarriage return character.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DV_ORDERED.LF
Definition

Line feed character.

ShortLine feed character.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DV_ORDERED.Local-terminology-id
Definition

Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype

ShortPredefined terminology identifier
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DV_ORDERED.normal-status
Definition

Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group normal_status.

ShortOptional normal status indicator of value with respect to normal range for this value.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
10. DV_ORDERED.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL
Is Modifierfalse
12. DV_ORDERED.other-reference-ranges
Definition

Optional tagged other reference ranges for this value in its particular measurement context.

ShortOptional tagged other reference ranges for this value in its particular measurement context.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE<http://openehr.org/fhir/StructureDefinition/DV-ORDERED>
Is Modifierfalse