CH EMED (R4)
3.0.0 - STU3 Switzerland flag

This page is part of the CH EMED (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Data Type Profile: CHEMEDRatioWithEmedUnits - Detailed Descriptions

Active as of 2021-04-07

Definitions for the ch-emed-ratio data type profile.

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

1. Ratio
2. Ratio.numerator
Control10..1
TypeQuantity(CHEMEDQuantityWithEmedUnits)
3. Ratio.denominator
Control10..1
TypeQuantity(CHEMEDQuantityWithEmedUnits)

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

1. Ratio
Definition

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

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

InvariantsDefined on this element
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.numerator
Definition

The comparator is not used on a SimpleQuantity

The value of the numerator.

Control10..1 This element is affected by the following invariants: ele-1
TypeQuantity(CHEMEDQuantityWithEmedUnits)
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 may also restrict the values for the comparator.

InvariantsDefined on this element
ele-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())
3. Ratio.denominator
Definition

The comparator is not used on a SimpleQuantity

The value of the denominator.

Control10..1 This element is affected by the following invariants: ele-1
TypeQuantity(CHEMEDQuantityWithEmedUnits)
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 may also restrict the values for the comparator.

InvariantsDefined on this element
ele-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.

1. Ratio
Definition

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

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

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Ratio.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Ratio.numerator
Definition

The comparator is not used on a SimpleQuantity

Control1..1 This element is affected by the following invariants: ele-1
TypeQuantity(CHEMEDQuantityWithEmedUnits)
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 may also restrict the values for the comparator.

InvariantsDefined on this element
ele-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())
5. Ratio.denominator
Definition

The comparator is not used on a SimpleQuantity

Control1..1 This element is affected by the following invariants: ele-1
TypeQuantity(CHEMEDQuantityWithEmedUnits)
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 may also restrict the values for the comparator.

InvariantsDefined on this element
ele-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())