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

Logical Model: DV_PROPORTION - Detailed Descriptions

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


A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

ShortModels a ratio of values, i.Primitive Type code
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Type_validity: Type validity (null # TODO: 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 (null # TODO: manual translation needed)
Percent_validity: Percent validity must satisfy conditional constraints (null # TODO: manual translation needed)
Valid_denominator: Valid denominator (null # TODO: manual translation needed)
2. DV_PROPORTION.id
Definition

unique id for the element within a resource (for internal references)


Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. DV_PROPORTION.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. DV_PROPORTION.value
Definition

Primitive value for code


The actual value

ShortPrimitive value for codePrimitive value for string
Control0..1
Typecodestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Max Length:1048576
8. DV_PROPORTION.numerator
Definition

Numerator of ratio

ShortNumerator of ratio
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_PROPORTION.denominator
Definition

Denominator of ratio.

ShortDenominator of ratio.
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_PROPORTION.type
Definition

Indicates semantic type of proportion, including percent, unitary etc.

ShortIndicates semantic type of proportion, including percent, unitary etc.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DV_PROPORTION.precision
Definition

Precision to which the _numerator_ and _denominator_ values of the proportion are 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.

ShortPrecision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DV_PROPORTION.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
18. DV_PROPORTION.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-PROPORTION>
Is Modifierfalse

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

ShortModels a ratio of values, i.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsType_validity: Type validity (null # TODO: 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 (null # TODO: manual translation needed)
Percent_validity: Percent validity must satisfy conditional constraints (null # TODO: manual translation needed)
Valid_denominator: Valid denominator (null # TODO: manual translation needed)
2. DV_PROPORTION.numerator
Definition

Numerator of ratio

ShortNumerator of ratio
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DV_PROPORTION.denominator
Definition

Denominator of ratio.

ShortDenominator of ratio.
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis 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.

ShortIndicates semantic type of proportion, including percent, unitary etc.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DV_PROPORTION.precision
Definition

Precision to which the _numerator_ and _denominator_ values of the proportion are 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.

ShortPrecision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_PROPORTION.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
12. DV_PROPORTION.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-PROPORTION>
Is Modifierfalse

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

ShortModels a ratio of values, i.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Type_validity: Type validity (null # TODO: 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 (null # TODO: manual translation needed)
Percent_validity: Percent validity must satisfy conditional constraints (null # TODO: manual translation needed)
Valid_denominator: Valid denominator (null # TODO: manual translation needed)
2. DV_PROPORTION.id
Definition

unique id for the element within a resource (for internal references)

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. DV_PROPORTION.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. DV_PROPORTION.value
Definition

Primitive value for code

ShortPrimitive value for code
Control0..1
Typecode
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. DV_PROPORTION.numerator
Definition

Numerator of ratio

ShortNumerator of ratio
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DV_PROPORTION.denominator
Definition

Denominator of ratio.

ShortDenominator of ratio.
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DV_PROPORTION.type
Definition

Indicates semantic type of proportion, including percent, unitary etc.

ShortIndicates semantic type of proportion, including percent, unitary etc.
Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DV_PROPORTION.precision
Definition

Precision to which the _numerator_ and _denominator_ values of the proportion are 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.

ShortPrecision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.
Control0..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DV_PROPORTION.normal-range
Definition

Optional normal range.

ShortOptional normal range.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-INTERVAL<http://openehr.org/fhir/StructureDefinition/DV-PROPORTION>
Is Modifierfalse
18. DV_PROPORTION.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-PROPORTION>
Is Modifierfalse