This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the Ratio-uv-ips data type profile.
1. Ratio | |
2. Ratio.numerator | |
Type | Quantity(QuantityIPS) |
Must Support | true |
3. Ratio.denominator | |
Type | Quantity(QuantityIPS) |
Must Support | true |
1. Ratio | |
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. |
Control | 0..* 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. |
Invariants | Defined 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 | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. The value of the numerator. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(QuantityIPS) |
Must Support | true |
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. |
Invariants | Defined 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()) |
3. Ratio.denominator | |
Definition | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. The value of the denominator. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(QuantityIPS) |
Must Support | true |
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. |
Invariants | Defined 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()) |
1. Ratio | |
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. |
Control | 0..* 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensionsuser 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on Ratio.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Ratio.numerator | |
Definition | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(QuantityIPS) |
Must Support | true |
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. |
Invariants | Defined 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()) |
5. Ratio.denominator | |
Definition | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(QuantityIPS) |
Must Support | true |
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. |
Invariants | Defined 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()) |