OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package
0.1.0 - First Draft
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
| Official URL: http://openehr.org/fhir/StructureDefinition/DV_PROPORTION | Version: 0.1.0 | ||||
| Standards status: Informative | Maturity Level: 3 | Computable Name: DV_PROPORTION | |||
Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The _valid_proportion_kind_ property of the PROPORTION_KIND class is used to control the type attribute to be one of a defined set.
Used for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW).
Misuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) "6/24" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations.
Original Source: specifications.openehr.org
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DV_PROPORTION |
C | 0..* | DV_AMOUNT | Models a ratio of values Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy Instances of this logical model are not marked to be the target of a Reference Constraints: type-validity, precision-validity, is-integral-validity, fraction-validity, unitary-validity, percent-validity, valid-denominator |
  numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
 normal_range |
0..1 | DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional normal range. | |
 other_reference_ranges |
0..* | REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| fraction-validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| is-integral-validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| percent-validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
{} // : manual translation needed
|
| precision-validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| type-validity | error | DV_PROPORTION | Type validity |
{} // : manual translation needed
|
| unitary-validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
{} // : manual translation needed
|
| valid-denominator | error | DV_PROPORTION | Valid denominator |
{} // : manual translation needed
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | DV_AMOUNT | Models a ratio of values Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy Instances of this logical model are not marked to be the target of a Reference Constraints: other-reference-ranges-validity, is-simple-validity, normal-range-and-status-consistency, magnitude-status-valid, accuracy-is-percent-validity, accuracy-validity, type-validity, precision-validity, is-integral-validity, fraction-validity, unitary-validity, percent-validity, valid-denominator |
| CR |
1..1 | string | Carriage return character. | |
| LF |
1..1 | string | Line feed character. | |
| Local_terminology_id |
1..1 | string | Predefined terminology identifier | |
| normal_status |
0..1 | CODE_PHRASE | Optional normal status indicator of value with respect to normal range for this value. | |
| normal_range |
0..1 | DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | 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. | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| accuracy-is-percent-validity | error | DV_PROPORTION | Accuracy is percent validity must satisfy conditional constraints |
accuracy = 0 implies accuracy_is_percent.not()
|
| accuracy-validity | error | DV_PROPORTION | Accuracy validity must satisfy conditional constraints |
accuracy_is_percent implies valid_percentage()
|
| fraction-validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| is-integral-validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| is-simple-validity | error | DV_PROPORTION | Is simple validity must satisfy conditional constraints |
(normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
|
| magnitude-status-valid | error | DV_PROPORTION | Magnitude status valid must be present |
magnitude_status.exists() implies valid_magnitude_status()
|
| normal-range-and-status-consistency | error | DV_PROPORTION | 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_PROPORTION | Other reference ranges validity must be present |
other_reference_ranges.exists() implies other_reference_ranges.empty().not()
|
| percent-validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
{} // : manual translation needed
|
| precision-validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| type-validity | error | DV_PROPORTION | Type validity |
{} // : manual translation needed
|
| unitary-validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
{} // : manual translation needed
|
| valid-denominator | error | DV_PROPORTION | Valid denominator |
{} // : manual translation needed
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | DV_AMOUNT | Models a ratio of values Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy Instances of this logical model are not marked to be the target of a Reference Constraints: type-validity, precision-validity, is-integral-validity, fraction-validity, unitary-validity, percent-validity, valid-denominator |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| fraction-validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| is-integral-validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| percent-validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
{} // : manual translation needed
|
| precision-validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| type-validity | error | DV_PROPORTION | Type validity |
{} // : manual translation needed
|
| unitary-validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
{} // : manual translation needed
|
| valid-denominator | error | DV_PROPORTION | Valid denominator |
{} // : manual translation needed
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | DV_AMOUNT | Models a ratio of values Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy Instances of this logical model are not marked to be the target of a Reference Constraints: other-reference-ranges-validity, is-simple-validity, normal-range-and-status-consistency, magnitude-status-valid, accuracy-is-percent-validity, accuracy-validity, type-validity, precision-validity, is-integral-validity, fraction-validity, unitary-validity, percent-validity, valid-denominator |
| CR |
1..1 | string | Carriage return character. | |
| LF |
1..1 | string | Line feed character. | |
| Local_terminology_id |
1..1 | string | Predefined terminology identifier | |
| normal_status |
0..1 | CODE_PHRASE | Optional normal status indicator of value with respect to normal range for this value. | |
| normal_range |
0..1 | DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> | 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. | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| accuracy-is-percent-validity | error | DV_PROPORTION | Accuracy is percent validity must satisfy conditional constraints |
accuracy = 0 implies accuracy_is_percent.not()
|
| accuracy-validity | error | DV_PROPORTION | Accuracy validity must satisfy conditional constraints |
accuracy_is_percent implies valid_percentage()
|
| fraction-validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| is-integral-validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| is-simple-validity | error | DV_PROPORTION | Is simple validity must satisfy conditional constraints |
(normal_range .empty() and other_reference_ranges .empty()) implies is_simple()
|
| magnitude-status-valid | error | DV_PROPORTION | Magnitude status valid must be present |
magnitude_status.exists() implies valid_magnitude_status()
|
| normal-range-and-status-consistency | error | DV_PROPORTION | 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_PROPORTION | Other reference ranges validity must be present |
other_reference_ranges.exists() implies other_reference_ranges.empty().not()
|
| percent-validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
{} // : manual translation needed
|
| precision-validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| type-validity | error | DV_PROPORTION | Type validity |
{} // : manual translation needed
|
| unitary-validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
{} // : manual translation needed
|
| valid-denominator | error | DV_PROPORTION | Valid denominator |
{} // : manual translation needed
|
Other representations of profile: CSV, Excel