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_QUANTITY

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

Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (http://unitsofmeasure.org/ucum.html[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).

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_QUANTITY C 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Magnitude_status_valid, Accuracy_is_percent_validity, Accuracy_validity
... 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<DV_QUANTITY> Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... magnitude_status 0..1 string 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 `"="` .
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.
... accuracy_is_percent 0..1 boolean If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_QUANTITY Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_QUANTITY Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)
Is_simple_validity error DV_QUANTITY Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Magnitude_status_valid error DV_QUANTITY Magnitude status valid must be present magnitude_status.exists() implies valid_magnitude_status() (magnitude_status)
Normal_range_and_status_consistency error DV_QUANTITY 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_QUANTITY Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()

This structure is derived from DV_AMOUNT

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_QUANTITY 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_QUANTITY C 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Magnitude_status_valid, Accuracy_is_percent_validity, Accuracy_validity
... 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<DV_QUANTITY> Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... magnitude_status 0..1 string 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 `"="` .
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.
... accuracy_is_percent 0..1 boolean If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_QUANTITY Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_QUANTITY Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)
Is_simple_validity error DV_QUANTITY Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Magnitude_status_valid error DV_QUANTITY Magnitude status valid must be present magnitude_status.exists() implies valid_magnitude_status() (magnitude_status)
Normal_range_and_status_consistency error DV_QUANTITY 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_QUANTITY Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()

This structure is derived from DV_AMOUNT

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_QUANTITY C 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Magnitude_status_valid, Accuracy_is_percent_validity, Accuracy_validity
... 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<DV_QUANTITY> Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... magnitude_status 0..1 string 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 `"="` .
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.
... accuracy_is_percent 0..1 boolean If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_QUANTITY Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_QUANTITY Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)
Is_simple_validity error DV_QUANTITY Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Magnitude_status_valid error DV_QUANTITY Magnitude status valid must be present magnitude_status.exists() implies valid_magnitude_status() (magnitude_status)
Normal_range_and_status_consistency error DV_QUANTITY 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_QUANTITY Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()

Differential View

This structure is derived from DV_AMOUNT

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_QUANTITY 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_QUANTITY C 0..* DV_AMOUNT Quantitified type representing scientific quantities, i.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy
Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency, Magnitude_status_valid, Accuracy_is_percent_validity, Accuracy_validity
... 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<DV_QUANTITY> Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_QUANTITY> Optional tagged other reference ranges for this value in its particular measurement context.
... magnitude_status 0..1 string 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 `"="` .
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.
... accuracy_is_percent 0..1 boolean If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value.
... magnitude 1..1 decimal Numeric magnitude of the quantity.
... precision 0..1 integer Precision to which the value of the quantity is expressed, in terms of number of decimal places.
... units 1..1 string Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set.
... units_system 0..1 string Optional field used to specify a units system from which codes in `_units_` are defined.
... units_display_name 0..1 string Optional field containing the displayable form of the `_units_` field, e.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_QUANTITY Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_QUANTITY Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)
Is_simple_validity error DV_QUANTITY Is simple validity must satisfy conditional constraints (normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
Magnitude_status_valid error DV_QUANTITY Magnitude status valid must be present magnitude_status.exists() implies valid_magnitude_status() (magnitude_status)
Normal_range_and_status_consistency error DV_QUANTITY 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_QUANTITY Other reference ranges validity must be present other_reference_ranges.exists() implies other_reference_ranges.empty().not()

This structure is derived from DV_AMOUNT

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 3

 

Other representations of profile: CSV, Excel

Contained resources