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/FHIR/openehr-base-ig/ and changes regularly. See the Directory of published versions

Logical Model: DV_AMOUNT - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the DV-AMOUNT logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. DV_AMOUNT
Definition

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).


Base definition for all types defined in FHIR type system.

ShortAbstract class defining the concept of relative quantified 'amounts'Base for all types and resources
Comments

For scores that include only Integers, DV_QUANTIFIED may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.

Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_AMOUNT.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 normal_status.

ShortOptional normal status indicator of value with respect to normal range for this value
Control0..1
BindingThe codes SHALL be taken from Normal statuses
(required to https://specifications.openehr.org/fhir/valueset-normal_statuses)
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. DV_AMOUNT.normal-range
Definition

Optional normal range.

ShortOptional normal range
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV_ORDERED>
Is Modifierfalse
6. DV_AMOUNT.other-reference-ranges
Definition

Optional tagged other reference ranges for this value in its particular measurement context.

ShortOptional tagged other reference ranges for this value in its particular measurement context
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE<http://openehr.org/fhir/StructureDefinition/DV_ORDERED>
Is Modifierfalse
8. DV_AMOUNT.magnitude-status
Definition

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 '=' .

ShortOptional status of magnitude: =, <, >, <=, >=, ~
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_AMOUNT.accuracy
Definition

Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.

A value of unknown_accuracy_value means that accuracy was not recorded.

ShortAccuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_AMOUNT.accuracy-is-percent
Definition

If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.

ShortIf True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis 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_AMOUNT
Definition

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).

ShortAbstract class defining the concept of relative quantified 'amounts'
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_AMOUNT.accuracy-is-percent
Definition

If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.

ShortIf True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DV_AMOUNT.accuracy
Definition

Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.

A value of unknown_accuracy_value means that accuracy was not recorded.

ShortAccuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis 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_AMOUNT
Definition

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).

ShortAbstract class defining the concept of relative quantified 'amounts'
Comments

For scores that include only Integers, DV_QUANTIFIED may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.

Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DV_AMOUNT.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 normal_status.

ShortOptional normal status indicator of value with respect to normal range for this value
Control0..1
BindingThe codes SHALL be taken from Normal statuses
(required to https://specifications.openehr.org/fhir/valueset-normal_statuses)
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse
4. DV_AMOUNT.normal-range
Definition

Optional normal range.

ShortOptional normal range
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV_ORDERED>
Is Modifierfalse
6. DV_AMOUNT.other-reference-ranges
Definition

Optional tagged other reference ranges for this value in its particular measurement context.

ShortOptional tagged other reference ranges for this value in its particular measurement context
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE<http://openehr.org/fhir/StructureDefinition/DV_ORDERED>
Is Modifierfalse
8. DV_AMOUNT.magnitude-status
Definition

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 '=' .

ShortOptional status of magnitude: =, <, >, <=, >=, ~
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_AMOUNT.accuracy
Definition

Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.

A value of unknown_accuracy_value means that accuracy was not recorded.

ShortAccuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_AMOUNT.accuracy-is-percent
Definition

If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.

ShortIf True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension