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_AMOUNT ( Abstract )

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

Abstract class defining the concept of relative quantified 'amounts'. For relative quantities, the + and - operators are defined (unlike descendants of DV_ABSOLUTE_QUANTITY, such as the date/time types).

Original Source: specifications.openehr.org

Usages:

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_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, 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 Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> 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.

doco Documentation for this format

Constraints

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

This structure is derived from DV_QUANTIFIED

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy
Constraints: Accuracy_is_percent_validity, Accuracy_validity
... 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.
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_AMOUNT Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_AMOUNT Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, 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 Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> 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.

doco Documentation for this format

Constraints

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

This structure is derived from DV_QUANTIFIED

Summary

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, 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 Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> 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.

doco Documentation for this format

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy
Constraints: Accuracy_is_percent_validity, Accuracy_validity
... 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.
... accuracy 0..1 decimal Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
Accuracy_is_percent_validity error DV_AMOUNT Accuracy is percent validity must satisfy conditional constraints accuracy = 0 implies accuracy_is_percent.not()
Accuracy_validity error DV_AMOUNT Accuracy validity must satisfy conditional constraints accuracy_is_percent implies valid_percentage() (accuracy)

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DV_AMOUNT C 0..* DV_QUANTIFIED This is an abstract type. Child types: DV_COUNT, DV_DURATION, DV_QUANTITY
Abstract class defining the concept of relative quantified 'amounts'.

Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, 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 Optional normal range.
... other_reference_ranges 0..* REFERENCE_RANGE<DV_ORDERED> 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.

doco Documentation for this format

Constraints

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

This structure is derived from DV_QUANTIFIED

Summary

Maturity: 3

 

Other representations of profile: CSV, Excel

Contained resources