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
| Page standards status: Informative | Maturity Level: 3 |
Definitions for the DV-PROPORTION logical model
Guidance on how to interpret the contents of this table can be foundhere
| 0. DV_PROPORTION | |
| Definition | Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The 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. Base definition for all types defined in FHIR type system. |
| Short | Models a ratio of valuesBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | other-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)))magnitude-status-valid: Magnitude status valid must be present ( magnitude_status.exists() implies valid_magnitude_status())accuracy-is-percent-validity: Accuracy is percent validity must satisfy conditional constraints ( accuracy = 0 implies accuracy_is_percent.not())accuracy-validity: Accuracy validity must satisfy conditional constraints ( accuracy_is_percent implies valid_percentage())type-validity: Type validity ( {} // : manual translation needed)precision-validity: Precision validity must satisfy conditional constraints ( precision = 0 implies is_integral())is-integral-validity: Is integral validity must satisfy conditional constraints ( is_integral() implies (numerator.floor = numerator and denominator.floor = denominator))fraction-validity: Fraction validity must satisfy conditional constraints ( (type = pk_fraction or type = pk_integer_fraction) implies is_integral())unitary-validity: Unitary validity must satisfy conditional constraints ( {} // : manual translation needed)percent-validity: Percent validity must satisfy conditional constraints ( {} // : manual translation needed)valid-denominator: Valid denominator ( {} // : manual translation needed) |
| 2. DV_PROPORTION.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_PROPORTION.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DV_PROPORTION.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_PROPORTION.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 |
| Short | Optional normal status indicator of value with respect to normal range for this value. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE_PHRASE |
| Is Modifier | false |
| 10. DV_PROPORTION.normal-range | |
| Definition | Optional normal range. |
| Short | Optional normal range. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
| 12. DV_PROPORTION.other-reference-ranges | |
| Definition | Optional tagged other reference ranges for this value in its particular measurement context. |
| Short | Optional tagged other reference ranges for this value in its particular measurement context. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
| 14. DV_PROPORTION.magnitude-status | |
| Definition | Optional status of magnitude with values:
If not present, assumed meaning is |
| Short | 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 `"="`. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. DV_PROPORTION.accuracy | |
| Definition | Accuracy of measurement, expressed either as a half-range percent value ( A value of |
| Short | Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity. |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. DV_PROPORTION.accuracy-is-percent | |
| Definition | If |
| Short | If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. DV_PROPORTION.numerator | |
| Definition | Numerator of ratio |
| Short | Numerator of ratio |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DV_PROPORTION.denominator | |
| Definition | Denominator of ratio. |
| Short | Denominator of ratio. |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DV_PROPORTION.type | |
| Definition | Indicates semantic type of proportion, including percent, unitary etc. |
| Short | Indicates semantic type of proportion, including percent, unitary etc. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. DV_PROPORTION.precision | |
| Definition | Precision to which the |
| Short | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. |
| Control | 0..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This 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_PROPORTION | |
| Definition | Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The 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. |
| Short | Models a ratio of values |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | type-validity: Type validity ({} // : manual translation needed)precision-validity: Precision validity must satisfy conditional constraints ( precision = 0 implies is_integral())is-integral-validity: Is integral validity must satisfy conditional constraints ( is_integral() implies (numerator.floor = numerator and denominator.floor = denominator))fraction-validity: Fraction validity must satisfy conditional constraints ( (type = pk_fraction or type = pk_integer_fraction) implies is_integral())unitary-validity: Unitary validity must satisfy conditional constraints ( {} // : manual translation needed)percent-validity: Percent validity must satisfy conditional constraints ( {} // : manual translation needed)valid-denominator: Valid denominator ( {} // : manual translation needed) |
| 2. DV_PROPORTION.numerator | |
| Definition | Numerator of ratio |
| Short | Numerator of ratio |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_PROPORTION.denominator | |
| Definition | Denominator of ratio. |
| Short | Denominator of ratio. |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DV_PROPORTION.type | |
| Definition | Indicates semantic type of proportion, including percent, unitary etc. |
| Short | Indicates semantic type of proportion, including percent, unitary etc. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_PROPORTION.precision | |
| Definition | Precision to which the |
| Short | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. |
| Control | 0..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DV_PROPORTION.normal-range | |
| Definition | Optional normal range. |
| Short | Optional normal range. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
| 12. DV_PROPORTION.other-reference-ranges | |
| Definition | Optional tagged other reference ranges for this value in its particular measurement context. |
| Short | Optional tagged other reference ranges for this value in its particular measurement context. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DV_PROPORTION | |
| Definition | Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The 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. |
| Short | Models a ratio of values |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | other-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)))magnitude-status-valid: Magnitude status valid must be present ( magnitude_status.exists() implies valid_magnitude_status())accuracy-is-percent-validity: Accuracy is percent validity must satisfy conditional constraints ( accuracy = 0 implies accuracy_is_percent.not())accuracy-validity: Accuracy validity must satisfy conditional constraints ( accuracy_is_percent implies valid_percentage())type-validity: Type validity ( {} // : manual translation needed)precision-validity: Precision validity must satisfy conditional constraints ( precision = 0 implies is_integral())is-integral-validity: Is integral validity must satisfy conditional constraints ( is_integral() implies (numerator.floor = numerator and denominator.floor = denominator))fraction-validity: Fraction validity must satisfy conditional constraints ( (type = pk_fraction or type = pk_integer_fraction) implies is_integral())unitary-validity: Unitary validity must satisfy conditional constraints ( {} // : manual translation needed)percent-validity: Percent validity must satisfy conditional constraints ( {} // : manual translation needed)valid-denominator: Valid denominator ( {} // : manual translation needed) |
| 2. DV_PROPORTION.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_PROPORTION.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DV_PROPORTION.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_PROPORTION.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 |
| Short | Optional normal status indicator of value with respect to normal range for this value. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE_PHRASE |
| Is Modifier | false |
| 10. DV_PROPORTION.normal-range | |
| Definition | Optional normal range. |
| Short | Optional normal range. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV_INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
| 12. DV_PROPORTION.other-reference-ranges | |
| Definition | Optional tagged other reference ranges for this value in its particular measurement context. |
| Short | Optional tagged other reference ranges for this value in its particular measurement context. |
| Control | 0..* |
| Type | http://openehr.org/fhir/StructureDefinition/REFERENCE_RANGE<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION> |
| Is Modifier | false |
| 14. DV_PROPORTION.magnitude-status | |
| Definition | Optional status of magnitude with values:
If not present, assumed meaning is |
| Short | 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 `"="`. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. DV_PROPORTION.accuracy | |
| Definition | Accuracy of measurement, expressed either as a half-range percent value ( A value of |
| Short | Accuracy of measurement, expressed either as a half-range percent value (`_accuracy_is_percent_` = `True`) or a half-range quantity. |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. DV_PROPORTION.accuracy-is-percent | |
| Definition | If |
| Short | If `True`, indicates that when this object was created, `_accuracy_` was recorded as a percent value; if `False`, as an absolute quantity value. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. DV_PROPORTION.numerator | |
| Definition | Numerator of ratio |
| Short | Numerator of ratio |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DV_PROPORTION.denominator | |
| Definition | Denominator of ratio. |
| Short | Denominator of ratio. |
| Control | 1..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DV_PROPORTION.type | |
| Definition | Indicates semantic type of proportion, including percent, unitary etc. |
| Short | Indicates semantic type of proportion, including percent, unitary etc. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. DV_PROPORTION.precision | |
| Definition | Precision to which the |
| Short | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. |
| Control | 0..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |