Ratio (Eu Lab) - Definitions - HL7 Europe Laboratory Report v0.2.0-ci

HL7 Europe Laboratory Report
0.2.0-ci - ci-build 150

HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions

Data Type Profile: RatioEuLab - Detailed Descriptions

Draft as of 2025-04-01

Definitions for the Ratio-eu-lab data type profile.

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

0. Ratio
Definition	A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM. A relationship of two Quantity values - expressed as a numerator and a denominator.
Short	A measured ratio using UCUMA ratio of two Quantity values - a numerator and a denominator
Comments	The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (`(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())`) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ((numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()))
2. Ratio.extension:uncertainty
Slice Name	uncertainty
Definition	The primary measure of variance/uncertainty of the value (the square root of the sum of the squares of the differences between all data points and the mean).
Short	Standard Deviation (same units as the quantity)
Comments	standardDeviation has the same units as the quantity. It is used to normalize the data for computing the distribution function. Applications that cannot deal with probability distributions can still get an idea about the confidence level by looking at standardDeviation.
Control	0..1
Type	Extension(Uncertainty) (Extension Type: decimal)
Is Modifier	false
Summary	false
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())
4. Ratio.extension:uncertaintyType
Slice Name	uncertaintyType
Definition	A code specifying the type of probability distribution for the uncertainty.
Short	Probability Distribution Type for uncertainty
Comments	This is only meaningful if there is also an uncertainty extension. If there is an uncertainty extension with no type, this means that the probability distribution type is unknown. In that case, the uncertainty has the meaning of an informal guess.
Control	0..1
Type	Extension(Uncertainty type) (Extension Type: code)
Is Modifier	false
Summary	false
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. Ratio.numerator
Definition	The value of the numerator.
Short	Numerator value
Control	0..1
Type	Quantity(Quantity (IPS))
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Ratio.denominator
Definition	The value of the denominator.
Short	Denominator value
Control	0..1
Type	Quantity(Quantity (IPS))
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Ratio
Definition	A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.
Short	A measured ratio using UCUM
2. Ratio.extension:uncertainty
Slice Name	uncertainty
Control	0..1
Type	Extension(Uncertainty) (Extension Type: decimal)
4. Ratio.extension:uncertaintyType
Slice Name	uncertaintyType
Control	0..1
Type	Extension(Uncertainty type) (Extension Type: code)

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

0. Ratio
Definition	A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM.
Short	A measured ratio using UCUM
Comments	The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present (`(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())`)
2. Ratio.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Ratio.extension
Definition	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 manageable, 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()`)
Slicing	This element introduces a set of slices on `Ratio.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Ratio.extension:uncertainty
Slice Name	uncertainty
Definition	The primary measure of variance/uncertainty of the value (the square root of the sum of the squares of the differences between all data points and the mean).
Short	Standard Deviation (same units as the quantity)
Comments	standardDeviation has the same units as the quantity. It is used to normalize the data for computing the distribution function. Applications that cannot deal with probability distributions can still get an idea about the confidence level by looking at standardDeviation.
Control	0..1
Type	Extension(Uncertainty) (Extension Type: decimal)
Is Modifier	false
Summary	false
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()`)
8. Ratio.extension:uncertaintyType
Slice Name	uncertaintyType
Definition	A code specifying the type of probability distribution for the uncertainty.
Short	Probability Distribution Type for uncertainty
Comments	This is only meaningful if there is also an uncertainty extension. If there is an uncertainty extension with no type, this means that the probability distribution type is unknown. In that case, the uncertainty has the meaning of an informal guess.
Control	0..1
Type	Extension(Uncertainty type) (Extension Type: code)
Is Modifier	false
Summary	false
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()`)
10. Ratio.numerator
Definition	The value of the numerator.
Short	Numerator value
Control	0..1
Type	Quantity(Quantity (IPS))
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Ratio.denominator
Definition	The value of the denominator.
Short	Denominator value
Control	0..1
Type	Quantity(Quantity (IPS))
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

Links: Table of Contents | QA Report

Propose a change external