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

Page standards status: Informative Maturity Level: 3

Definitions for the DV-SCALE logical model.

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

0. DV_SCALE
Definition

A data type that represents scale values, 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) non-integer values are allowed.

Example:


Borg CR 10 Scale

0 No Breathlessness at all 0.5 Very Very Slight (Just Noticeable) 1 Very Slight 2 Slight Breathlessness 3 Moderate ... etc

For scores that include only Integers, DV_SCALE may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.


Base definition for all types defined in FHIR type system.

ShortA data type that represents scale values, 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) non-integer values are allowed.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_SCALE.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_SCALE.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_SCALE.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_SCALE.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_SCALE.normal-range
Definition

Optional normal range.

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

Coded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as no breathlessness, very very slight, slight breathlessness. Codes come from archetypes.

In some cases, a scale may include values that have no code/symbol. In this case, the symbol will be a DV-CODED_TEXT including the _terminology_id_ and a blank String value for _code_string_.

ShortCoded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as `no breathlessness`, `very very slight`, `slight breathlessness`.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. DV_SCALE.value
Definition

Real number value of Scale item.

ShortReal number value of Scale item.
Control1..1
Typedecimal
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_SCALE
Definition

A data type that represents scale values, 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) non-integer values are allowed.

Example:


Borg CR 10 Scale

0 No Breathlessness at all 0.5 Very Very Slight (Just Noticeable) 1 Very Slight 2 Slight Breathlessness 3 Moderate ... etc

For scores that include only Integers, DV_SCALE may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.

ShortA data type that represents scale values, 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) non-integer values are allowed.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_SCALE.symbol
Definition

Coded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as no breathlessness, very very slight, slight breathlessness. Codes come from archetypes.

In some cases, a scale may include values that have no code/symbol. In this case, the symbol will be a DV-CODED_TEXT including the _terminology_id_ and a blank String value for _code_string_.

ShortCoded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as `no breathlessness`, `very very slight`, `slight breathlessness`.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
4. DV_SCALE.value
Definition

Real number value of Scale item.

ShortReal number value of Scale item.
Control1..1
Typedecimal
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_SCALE
Definition

A data type that represents scale values, 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) non-integer values are allowed.

Example:


Borg CR 10 Scale

0 No Breathlessness at all 0.5 Very Very Slight (Just Noticeable) 1 Very Slight 2 Slight Breathlessness 3 Moderate ... etc

For scores that include only Integers, DV_SCALE may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.

ShortA data type that represents scale values, 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) non-integer values are allowed.
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_SCALE.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_SCALE.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_SCALE.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_SCALE.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_SCALE.normal-range
Definition

Optional normal range.

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

Coded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as no breathlessness, very very slight, slight breathlessness. Codes come from archetypes.

In some cases, a scale may include values that have no code/symbol. In this case, the symbol will be a DV-CODED_TEXT including the _terminology_id_ and a blank String value for _code_string_.

ShortCoded textual representation of this value in the scale range, which may be strings made from symbols or other enumerations of terms such as `no breathlessness`, `very very slight`, `slight breathlessness`.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
16. DV_SCALE.value
Definition

Real number value of Scale item.

ShortReal number value of Scale item.
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension