Data Management with FHIR
0.1.0 - ci-build

Data Management with FHIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Data Type Profile: FrRatioUcum - Detailed Descriptions

Draft as of 2025-10-23

Definitions for the FrRatioUcum data type profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Ratio
Définition | A relationship of two Quantity values - expressed as a numerator and a denominator.
Short | A ratio of two Quantity values - a numerator and a denominator
Commentaires | 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.numerator
Définition | unit of measure SHALL be UCUM encoded The value of the numerator.
Short | Numerator with UCUM unitNumerator value
Control | 0..1
Type | Quantity(SimpleQuantity with UCUM quantity unit)
Is Modifier | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Ratio.denominator
Définition | unit of measure SHALL be UCUM encoded The value of the denominator.
Short | Denominator with UCUM unitDenominator value
Control | 0..1
Type | Quantity(SimpleQuantity with UCUM quantity unit)
Is Modifier | false
Résumé | 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 foundhere

0. Ratio
2. Ratio.numerator
Définition | unit of measure SHALL be UCUM encoded
Short | Numerator with UCUM unit
Type | Quantity(SimpleQuantity with UCUM quantity unit)
4. Ratio.denominator
Définition | unit of measure SHALL be UCUM encoded
Short | Denominator with UCUM unit
Type | Quantity(SimpleQuantity with UCUM quantity unit)

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

0. Ratio
Définition | A relationship of two Quantity values - expressed as a numerator and a denominator.
Short | A ratio of two Quantity values - a numerator and a denominator
Commentaires | 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
Définition | 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.
Résumé | false
4. Ratio.extension
Définition | 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
Commentaires | 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
Résumé | 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.numerator
Définition | unit of measure SHALL be UCUM encoded
Short | Numerator with UCUM unit
Control | 0..1
Type | Quantity(SimpleQuantity with UCUM quantity unit)
Is Modifier | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Ratio.denominator
Définition | unit of measure SHALL be UCUM encoded
Short | Denominator with UCUM unit
Control | 0..1
Type | Quantity(SimpleQuantity with UCUM quantity unit)
Is Modifier | false
Résumé | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)