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

Page standards status: Informative Maturity Level: 3

Definitions for the DV-ORDINAL logical model.

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

0. DV_ORDINAL
Definition

A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) integer values only.

Note that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values:

  • -3, -2, -1, 0, 1, 2, 3 -- reflex response values
  • 0, 1, 2 -- Apgar values

This class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. {neg, trace, +, ++, +++} are used for leucocytes, protein, nitrites etc; for non-haemolysed blood {neg, trace, moderate}; for haemolysed blood {small, moderate, large}.

For scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use DV_SCALE. DV_SCALE may also be used in future for representing purely Integer-based scales, however, the DV_ORDINAL type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.


Base definition for all types defined in FHIR type system.

ShortA data type that represents integral score values, 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
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)))
Limits_valid: Limits valid (null # TODO: manual translation needed)
Reference_range_valid: Reference range valid (null # TODO: manual translation needed)
2. DV_ORDINAL.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_ORDINAL.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_ORDINAL.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_ORDINAL.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_ORDINAL.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL
Is Modifierfalse
12. DV_ORDINAL.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
14. DV_ORDINAL.symbol
Definition

Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as mild, moderate, severe, or even the same number series as the values, e.g. 1, 2, 3.

ShortCoded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. DV_ORDINAL.value
Definition

Value in ordered enumeration of values. Any integer value can be used.

ShortValue in ordered enumeration of values.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. DV_ORDINAL
Definition

A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) integer values only.

Note that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values:

  • -3, -2, -1, 0, 1, 2, 3 -- reflex response values
  • 0, 1, 2 -- Apgar values

This class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. {neg, trace, +, ++, +++} are used for leucocytes, protein, nitrites etc; for non-haemolysed blood {neg, trace, moderate}; for haemolysed blood {small, moderate, large}.

For scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use DV_SCALE. DV_SCALE may also be used in future for representing purely Integer-based scales, however, the DV_ORDINAL type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.

ShortA data type that represents integral score values, e.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsLimits_valid: Limits valid (null # TODO: manual translation needed)
Reference_range_valid: Reference range valid (null # TODO: manual translation needed)
2. DV_ORDINAL.symbol
Definition

Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as mild, moderate, severe, or even the same number series as the values, e.g. 1, 2, 3.

ShortCoded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
4. DV_ORDINAL.value
Definition

Value in ordered enumeration of values. Any integer value can be used.

ShortValue in ordered enumeration of values.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. DV_ORDINAL
Definition

A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) integer values only.

Note that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values:

  • -3, -2, -1, 0, 1, 2, 3 -- reflex response values
  • 0, 1, 2 -- Apgar values

This class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. {neg, trace, +, ++, +++} are used for leucocytes, protein, nitrites etc; for non-haemolysed blood {neg, trace, moderate}; for haemolysed blood {small, moderate, large}.

For scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use DV_SCALE. DV_SCALE may also be used in future for representing purely Integer-based scales, however, the DV_ORDINAL type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.

ShortA data type that represents integral score values, e.
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)))
Limits_valid: Limits valid (null # TODO: manual translation needed)
Reference_range_valid: Reference range valid (null # TODO: manual translation needed)
2. DV_ORDINAL.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_ORDINAL.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_ORDINAL.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_ORDINAL.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_ORDINAL.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL
Is Modifierfalse
12. DV_ORDINAL.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
14. DV_ORDINAL.symbol
Definition

Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as mild, moderate, severe, or even the same number series as the values, e.g. 1, 2, 3.

ShortCoded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. DV_ORDINAL.value
Definition

Value in ordered enumeration of values. Any integer value can be used.

ShortValue in ordered enumeration of values.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension