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

Page standards status: Informative Maturity Level: 3

Definitions for the DV-QUANTITY logical model.

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

0. DV_QUANTITY
Definition

Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.

Can also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).


Base definition for all types defined in FHIR type system.

ShortQuantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and unitsBase for all types and resources
Comments

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

Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_QUANTITY.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
BindingThe codes SHALL be taken from Normal statuses
(required to https://specifications.openehr.org/fhir/valueset-normal_statuses)
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. DV_QUANTITY.normal-range
Definition

Optional normal range.

ShortOptional normal range
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
6. DV_QUANTITY.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-PROPORTION>
Is Modifierfalse
8. DV_QUANTITY.magnitude-status
Definition

Optional status of magnitude with values:

  • '=' : magnitude is a point value
  • '<' : value is < magnitude
  • '>' : value is > magnitude
  • '<=' : value is <= magnitude
  • '>=' : value is >= magnitude
  • '~' : value is approximately magnitude

If not present, assumed meaning is '=' .

ShortOptional status of magnitude: =, <, >, <=, >=, ~
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_QUANTITY.accuracy
Definition

Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.

A value of unknown_accuracy_value means that accuracy was not recorded.

ShortAccuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_QUANTITY.accuracy-is-percent
Definition

If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.

ShortIf True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DV_QUANTITY.magnitude
Definition

Numeric magnitude of the quantity.

ShortNumeric magnitude of the quantity
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DV_QUANTITY.precision
Definition

Precision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places

ShortPrecision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DV_QUANTITY.units
Definition

Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set.

In either case, the value is the code or syntax - normally formed of standard ASCII - which is in principal not the same as the display string, although in simple cases such as 'm' (for meters) it will be.

If the units_display_name field is set, this may be used for display. If not, the implementations must effect the resolution of the units value to a display form locally, e.g. by lookup of reference tables, request to a terminology service etc.

Example values from UCUM: 'kg/m^2', 'mm[Hg]', 'ms-1', 'km/h'

ShortQuantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DV_QUANTITY.units-system
Definition

Optional field used to specify a units system from which codes in units are defined. Value is a URI identifying a terminology containing units concepts from the (HL7 FHIR terminologies list).

If not set, the UCUM standard (case-sensitive codes) is assumed as the units system.

ShortURI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DV_QUANTITY.units-display-name
Definition

Optional field containing the displayable form of the units field, e.g. '°C'.

If not set, the application environment needs to determine the displayable form.

ShortOptional field containing the displayable form of the units field, e.g. '°C'
Comments

The display name may be language-dependent for various older and non-systematic units. For this reason, it is not recommended to add unit display names to archetypes, only to templates (for localisation purposes).

Control0..1
Typestring
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_QUANTITY
Definition

Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.

Can also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).

ShortQuantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_QUANTITY.magnitude
Definition

Numeric magnitude of the quantity.

ShortNumeric magnitude of the quantity
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DV_QUANTITY.precision
Definition

Precision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places

ShortPrecision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DV_QUANTITY.units
Definition

Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set.

In either case, the value is the code or syntax - normally formed of standard ASCII - which is in principal not the same as the display string, although in simple cases such as 'm' (for meters) it will be.

If the units_display_name field is set, this may be used for display. If not, the implementations must effect the resolution of the units value to a display form locally, e.g. by lookup of reference tables, request to a terminology service etc.

Example values from UCUM: 'kg/m^2', 'mm[Hg]', 'ms-1', 'km/h'

ShortQuantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DV_QUANTITY.units-system
Definition

Optional field used to specify a units system from which codes in units are defined. Value is a URI identifying a terminology containing units concepts from the (HL7 FHIR terminologies list).

If not set, the UCUM standard (case-sensitive codes) is assumed as the units system.

ShortURI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_QUANTITY.units-display-name
Definition

Optional field containing the displayable form of the units field, e.g. '°C'.

If not set, the application environment needs to determine the displayable form.

ShortOptional field containing the displayable form of the units field, e.g. '°C'
Comments

The display name may be language-dependent for various older and non-systematic units. For this reason, it is not recommended to add unit display names to archetypes, only to templates (for localisation purposes).

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_QUANTITY.normal-range
Definition

Optional normal range.

ShortOptional normal range
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
14. DV_QUANTITY.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-PROPORTION>
Is Modifierfalse

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

0. DV_QUANTITY
Definition

Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.

Can also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).

ShortQuantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units
Comments

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

Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_QUANTITY.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
BindingThe codes SHALL be taken from Normal statuses
(required to https://specifications.openehr.org/fhir/valueset-normal_statuses)
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. DV_QUANTITY.normal-range
Definition

Optional normal range.

ShortOptional normal range
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
6. DV_QUANTITY.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-PROPORTION>
Is Modifierfalse
8. DV_QUANTITY.magnitude-status
Definition

Optional status of magnitude with values:

  • '=' : magnitude is a point value
  • '<' : value is < magnitude
  • '>' : value is > magnitude
  • '<=' : value is <= magnitude
  • '>=' : value is >= magnitude
  • '~' : value is approximately magnitude

If not present, assumed meaning is '=' .

ShortOptional status of magnitude: =, <, >, <=, >=, ~
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_QUANTITY.accuracy
Definition

Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.

A value of unknown_accuracy_value means that accuracy was not recorded.

ShortAccuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_QUANTITY.accuracy-is-percent
Definition

If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.

ShortIf True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DV_QUANTITY.magnitude
Definition

Numeric magnitude of the quantity.

ShortNumeric magnitude of the quantity
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DV_QUANTITY.precision
Definition

Precision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places

ShortPrecision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DV_QUANTITY.units
Definition

Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set.

In either case, the value is the code or syntax - normally formed of standard ASCII - which is in principal not the same as the display string, although in simple cases such as 'm' (for meters) it will be.

If the units_display_name field is set, this may be used for display. If not, the implementations must effect the resolution of the units value to a display form locally, e.g. by lookup of reference tables, request to a terminology service etc.

Example values from UCUM: 'kg/m^2', 'mm[Hg]', 'ms-1', 'km/h'

ShortQuantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DV_QUANTITY.units-system
Definition

Optional field used to specify a units system from which codes in units are defined. Value is a URI identifying a terminology containing units concepts from the (HL7 FHIR terminologies list).

If not set, the UCUM standard (case-sensitive codes) is assumed as the units system.

ShortURI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DV_QUANTITY.units-display-name
Definition

Optional field containing the displayable form of the units field, e.g. '°C'.

If not set, the application environment needs to determine the displayable form.

ShortOptional field containing the displayable form of the units field, e.g. '°C'
Comments

The display name may be language-dependent for various older and non-systematic units. For this reason, it is not recommended to add unit display names to archetypes, only to templates (for localisation purposes).

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension