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/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions
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 (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 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, Base definition for all types defined in FHIR type system. |
Short | Quantitified type representing scientific quantities, i.Base 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() (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() (accuracy) ) |
2. DV_QUANTITY.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_QUANTITY.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_QUANTITY.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_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 |
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_QUANTITY.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-QUANTITY> |
Is Modifier | false |
12. DV_QUANTITY.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-QUANTITY> |
Is Modifier | false |
14. DV_QUANTITY.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_QUANTITY.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_QUANTITY.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_QUANTITY.magnitude | |
Definition | Numeric magnitude of the quantity. |
Short | Numeric magnitude of the quantity. |
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_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. |
Short | Precision to which the value of the quantity is 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 |
24. DV_QUANTITY.units | |
Definition | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in 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 Example values from UCUM: "kg/m^2", “mm[Hg]", "ms-1", "km/h". |
Short | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set. |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. DV_QUANTITY.units-system | |
Definition | Optional field used to specify a units system from which codes in If not set, the UCUM standard (case-sensitive codes) is assumed as the units system. |
Short | Optional field used to specify a units system from which codes in `_units_` are defined. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. DV_QUANTITY.units-display-name | |
Definition | Optional field containing the displayable form of the If not set, the application environment needs to determine the displayable form. NOTE: 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). |
Short | Optional field containing the displayable form of the `_units_` field, e. |
Control | 0..1 |
Type | string |
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_QUANTITY | |
Definition | 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 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, |
Short | Quantitified type representing scientific quantities, i. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. DV_QUANTITY.magnitude | |
Definition | Numeric magnitude of the quantity. |
Short | Numeric magnitude of the quantity. |
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_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. |
Short | Precision to which the value of the quantity is 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 |
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 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 Example values from UCUM: "kg/m^2", “mm[Hg]", "ms-1", "km/h". |
Short | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set. |
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_QUANTITY.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-QUANTITY> |
Is Modifier | false |
10. DV_QUANTITY.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-QUANTITY> |
Is Modifier | false |
12. DV_QUANTITY.units-system | |
Definition | Optional field used to specify a units system from which codes in If not set, the UCUM standard (case-sensitive codes) is assumed as the units system. |
Short | Optional field used to specify a units system from which codes in `_units_` are defined. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. DV_QUANTITY.units-display-name | |
Definition | Optional field containing the displayable form of the If not set, the application environment needs to determine the displayable form. NOTE: 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). |
Short | Optional field containing the displayable form of the `_units_` field, e. |
Control | 0..1 |
Type | string |
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_QUANTITY | |
Definition | 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 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, |
Short | Quantitified type representing scientific quantities, i. |
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() (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() (accuracy) ) |
2. DV_QUANTITY.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_QUANTITY.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_QUANTITY.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_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 |
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_QUANTITY.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-QUANTITY> |
Is Modifier | false |
12. DV_QUANTITY.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-QUANTITY> |
Is Modifier | false |
14. DV_QUANTITY.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_QUANTITY.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_QUANTITY.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_QUANTITY.magnitude | |
Definition | Numeric magnitude of the quantity. |
Short | Numeric magnitude of the quantity. |
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_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. |
Short | Precision to which the value of the quantity is 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 |
24. DV_QUANTITY.units | |
Definition | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in 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 Example values from UCUM: "kg/m^2", “mm[Hg]", "ms-1", "km/h". |
Short | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in `_units_system_`, when set. |
Control | 1..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. DV_QUANTITY.units-system | |
Definition | Optional field used to specify a units system from which codes in If not set, the UCUM standard (case-sensitive codes) is assumed as the units system. |
Short | Optional field used to specify a units system from which codes in `_units_` are defined. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. DV_QUANTITY.units-display-name | |
Definition | Optional field containing the displayable form of the If not set, the application environment needs to determine the displayable form. NOTE: 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). |
Short | Optional field containing the displayable form of the `_units_` field, e. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |