OpenEHR Base package
0.1.0 - First Draft
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
| Official URL: http://openehr.org/fhir/StructureDefinition/DV-PROPORTION | Version: 0.1.0 | |||
| Standards status: Informative | Maturity Level: 3 | Computable Name: DV_PROPORTION | ||
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.
Original Source: specifications.openehr.org
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
  @id |
0..1 | string | xml:id (or equivalent in JSON) | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
0..1 | code | Primitive value for code | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
 normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
 other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PROPORTION_KIND
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
0..1 | code | Primitive value for code | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PROPORTION_KIND
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
0..1 | code | Primitive value for code | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from PROPORTION_KIND
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DV_PROPORTION |
C | 0..* | PROPORTION_KIND | Models a ratio of values, i. Elements defined in Ancestors:@id, extension, @value, @value Instances of this logical model are not marked to be the target of a Reference Constraints: Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| @value |
0..1 | code | Primitive value for code | |
| numerator |
1..1 | decimal | Numerator of ratio | |
| denominator |
1..1 | decimal | Denominator of ratio. | |
| type |
1..1 | integer | Indicates semantic type of proportion, including percent, unitary etc. | |
| precision |
0..1 | integer | Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places. | |
| normal_range |
0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range. | |
| other_reference_ranges |
0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Fraction_validity | error | DV_PROPORTION | Fraction validity must satisfy conditional constraints |
(type = pk_fraction or type = pk_integer_fraction) implies is_integral()
|
| Is_integral_validity | error | DV_PROPORTION | Is integral validity must satisfy conditional constraints |
is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)
|
| Percent_validity | error | DV_PROPORTION | Percent validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Precision_validity | error | DV_PROPORTION | Precision validity must satisfy conditional constraints |
precision = 0 implies is_integral()
|
| Type_validity | error | DV_PROPORTION | Type validity |
null # TODO: manual translation needed
|
| Unitary_validity | error | DV_PROPORTION | Unitary validity must satisfy conditional constraints |
null # TODO: manual translation needed
|
| Valid_denominator | error | DV_PROPORTION | Valid denominator |
null # TODO: manual translation needed
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PROPORTION_KIND
Other representations of profile: CSV, Excel