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_DURATION - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the DV-DURATION logical model.

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

0. DV_DURATION
Definition

A data type that represents scale values, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed.

Example:

  Borg CR 10 Scale
  
  0    No Breathlessness at all
  0.5  Very Very Slight (Just Noticeable)
  1    Very Slight
  2    Slight Breathlessness
  3    Moderate
  ... etc

Base definition for all types defined in FHIR type system.

ShortA data type that represents scale values, where there is: a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowedBase for all types and resources
Comments

For scores that include only Integers, DV_DURATION 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_DURATION.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_DURATION.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_DURATION.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_DURATION.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_DURATION.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_DURATION.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
14. DV_DURATION.value
Definition

Represents a period of time with respect to a notional point in time, which is not specified. A sign may be used to indicate the duration is backwards in time rather than forwards. Used for recording the duration of something in the real world, particularly when there is a need a) to represent the duration in customary format, i.e. days, hours, minutes etc, and b) if it will be used in computational operations with date/time quantities, i.e. additions, subtractions etc. Misuse: Durations cannot be used to represent points in time, or intervals of time.

ShortISO8601 duration string, including described deviations to support negative values and weeks
Comments

Two deviations from ISO 8601 are supported, the first, to allow a negative sign, and the second allowing the 'W' designator to be mixed with other designators. See time types section in the Foundation Types model.

Control0..1
Typestring
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_DURATION
Definition

A data type that represents scale values, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed.

Example:

  Borg CR 10 Scale
  
  0    No Breathlessness at all
  0.5  Very Very Slight (Just Noticeable)
  1    Very Slight
  2    Slight Breathlessness
  3    Moderate
  ... etc
ShortA data type that represents scale values, where there is: a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed
Comments

For scores that include only Integers, DV_DURATION 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_DURATION.value
Definition

Represents a period of time with respect to a notional point in time, which is not specified. A sign may be used to indicate the duration is backwards in time rather than forwards. Used for recording the duration of something in the real world, particularly when there is a need a) to represent the duration in customary format, i.e. days, hours, minutes etc, and b) if it will be used in computational operations with date/time quantities, i.e. additions, subtractions etc. Misuse: Durations cannot be used to represent points in time, or intervals of time.

ShortISO8601 duration string, including described deviations to support negative values and weeks
Comments

Two deviations from ISO 8601 are supported, the first, to allow a negative sign, and the second allowing the 'W' designator to be mixed with other designators. See time types section in the Foundation Types model.

Control0..1
Typestring
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_DURATION
Definition

A data type that represents scale values, where there is:

a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed.

Example:

  Borg CR 10 Scale
  
  0    No Breathlessness at all
  0.5  Very Very Slight (Just Noticeable)
  1    Very Slight
  2    Slight Breathlessness
  3    Moderate
  ... etc
ShortA data type that represents scale values, where there is: a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) non-integer values are allowed
Comments

For scores that include only Integers, DV_DURATION 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_DURATION.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_DURATION.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_DURATION.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_DURATION.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_DURATION.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_DURATION.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
14. DV_DURATION.value
Definition

Represents a period of time with respect to a notional point in time, which is not specified. A sign may be used to indicate the duration is backwards in time rather than forwards. Used for recording the duration of something in the real world, particularly when there is a need a) to represent the duration in customary format, i.e. days, hours, minutes etc, and b) if it will be used in computational operations with date/time quantities, i.e. additions, subtractions etc. Misuse: Durations cannot be used to represent points in time, or intervals of time.

ShortISO8601 duration string, including described deviations to support negative values and weeks
Comments

Two deviations from ISO 8601 are supported, the first, to allow a negative sign, and the second allowing the 'W' designator to be mixed with other designators. See time types section in the Foundation Types model.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension