Guide d'implémentation du GT Standards et Interopérabilité pour les EDS
0.1.0 - ci-build France flag

Guide d'implémentation du GT Standards et Interopérabilité pour les EDS - 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 2024-10-08

Definitions for the FrRatioUcum data type profile.

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

0. Ratio
2. Ratio.numerator
Definition

unit of measure SHALL be UCUM encoded

ShortNumerator with UCUM unit
TypeQuantity(SimpleQuantity with UCUM quantity unit)
4. Ratio.denominator
Definition

unit of measure SHALL be UCUM encoded

ShortDenominator with UCUM unit
TypeQuantity(SimpleQuantity with UCUM quantity unit)

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

0. Ratio
Definition

A relationship of two Quantity values - expressed as a numerator and a denominator.

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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-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
Definition

unit of measure SHALL be UCUM encoded


The value of the numerator.

ShortNumerator with UCUM unitNumerator value
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity "comparator" element.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(SimpleQuantity with UCUM quantity unit)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
4. Ratio.denominator
Definition

unit of measure SHALL be UCUM encoded


The value of the denominator.

ShortDenominator with UCUM unitDenominator value
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity "comparator" element.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(SimpleQuantity with UCUM quantity unit)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())

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

0. Ratio
Definition

A relationship of two Quantity values - expressed as a numerator and a denominator.

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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

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())
SlicingThis 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
    Definition

    unit of measure SHALL be UCUM encoded

    ShortNumerator with UCUM unit
    Comments

    The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity "comparator" element.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeQuantity(SimpleQuantity with UCUM quantity unit)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
    sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
    8. Ratio.denominator
    Definition

    unit of measure SHALL be UCUM encoded

    ShortDenominator with UCUM unit
    Comments

    The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity "comparator" element.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeQuantity(SimpleQuantity with UCUM quantity unit)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
    sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())