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-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. 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 |
Short | Models a ratio of values, i.Primitive Type code |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Summary | false |
Invariants | ele-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. |
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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 |
Short | Primitive value for codePrimitive value for string |
Control | 0..1 |
Type | codestring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length: | 1048576 |
8. 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 |
10. 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 |
12. 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 |
14. 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 |
16. 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 |
18. 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, i. |
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 (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 |
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, i. |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Summary | false |
Invariants | ele-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) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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 |
Short | Primitive value for code |
Control | 0..1 |
Type | code |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
8. 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 |
10. 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 |
12. 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 |
14. 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 |
16. 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 |
18. 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 |