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

Official URL: http://openehr.org/fhir/StructureDefinition/DV-ORDINAL Version: 0.1.0
Standards status: Informative Maturity Level: 3 Computable Name: DV_ORDINAL

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.

Original Source: specifications.openehr.org

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Limits_valid, Reference_range_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... normal_range 0..1 DV_INTERVAL Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> Optional tagged other reference ranges for this value in its particular measurement context.
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Is_simple_validity error DV_ORDINAL Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Normal_range_and_status_consistency error DV_ORDINAL 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))
Other_reference_ranges_validity error DV_ORDINAL Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed

This structure is derived from DV_ORDERED

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Limits_valid, Reference_range_valid
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Limits_valid, Reference_range_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... normal_range 0..1 DV_INTERVAL Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> Optional tagged other reference ranges for this value in its particular measurement context.
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Is_simple_validity error DV_ORDINAL Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Normal_range_and_status_consistency error DV_ORDINAL 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))
Other_reference_ranges_validity error DV_ORDINAL Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed

This structure is derived from DV_ORDERED

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Limits_valid, Reference_range_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... normal_range 0..1 DV_INTERVAL Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> Optional tagged other reference ranges for this value in its particular measurement context.
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Is_simple_validity error DV_ORDINAL Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Normal_range_and_status_consistency error DV_ORDINAL 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))
Other_reference_ranges_validity error DV_ORDINAL Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed

Differential View

This structure is derived from DV_ORDERED

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Limits_valid, Reference_range_valid
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_ORDINAL C 0..* DV_ORDERED A data type that represents integral score values, e.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Limits_valid, Reference_range_valid
... CR 1..1 string Carriage return character.
... LF 1..1 string Line feed character.
... Local_terminology_id 1..1 string Predefined terminology identifier
... normal_range 0..1 DV_INTERVAL Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> Optional tagged other reference ranges for this value in its particular measurement context.
... symbol 1..1 DV_CODED_TEXT 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.
... value 1..1 integer Value in ordered enumeration of values.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Is_simple_validity error DV_ORDINAL Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Limits_valid error DV_ORDINAL Limits valid null # TODO: manual translation needed
Normal_range_and_status_consistency error DV_ORDINAL 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))
Other_reference_ranges_validity error DV_ORDINAL Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()
Reference_range_valid error DV_ORDINAL Reference range valid null # TODO: manual translation needed

This structure is derived from DV_ORDERED

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 3

 

Other representations of profile: CSV, Excel

Contained resources