| Package | hl7.fhir.eu.laboratory |
| Type | StructureDefinition |
| Id | Ratio-eu-lab |
| FHIR Version | R4 |
| Source | http://hl7.eu/fhir/laboratory/https://build.fhir.org/ig/hl7-eu/laboratory/StructureDefinition-Ratio-eu-lab.html |
| URL | http://hl7.eu/fhir/laboratory/StructureDefinition/Ratio-eu-lab |
| Version | 0.2.0-ci |
| Status | draft |
| Date | 2025-07-02T14:40:12+00:00 |
| Name | RatioEuLab |
| Title | Ratio (Eu Lab) |
| Realm | eu |
| Authority | hl7 |
| Description | This profile constrains the Ratio data type to use UCUM as the code system for units and optionally share measurement uncertainty |
| Purpose | This profile of the Ratio data type imposes the usage of the UCUM as the code system for units and allows expressing uncertainty of measurement |
| Copyright | Used by permission of HL7 Europe, all rights reserved Creative Commons License |
| Type | Ratio |
| Kind | complex-type |
| StructureDefinition | |
| cz-observation-result-laboratory | Observation Laboratory (CZ) |
| ch-elm-observation-results-laboratory | CH ELM Observation Results: Laboratory |
| Observation-resultslab-eu-lab | Observation Results: laboratory |
| ChLab-observation-panel | CH LAB-Report Observation Results: Panel |
| ch-lab-observation-results-laboratory | CH LAB-Report Observation Results: Laboratory Report |
| Ratio-lab-myhealtheu | Ratio: Laboratory |
| observation-grouping-it-lab | Observation battery - Lab Report |
| StructureDefinition | |
| Ratio-uv-ips | Ratio (IPS) |
| Ratio-uv-ips | Ratio (IPS) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition Ratio-eu-lab
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Ratio | 0..* | RatioIPS | A measured ratio using UCUM | |
  Slices for extension | Content/Rules for all slices | |||
   extension:uncertainty | 0..1 | decimal | Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty | |
 extension:uncertaintyType | 0..1 | code | Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required) | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "Ratio-eu-lab",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.eu/fhir/laboratory/StructureDefinition/Ratio-eu-lab",
"version": "0.2.0-ci",
"name": "RatioEuLab",
"title": "Ratio (Eu Lab)",
"status": "draft",
"date": "2025-07-02T14:40:12+00:00",
"publisher": "HL7 Europe",
"contact": [
{
"name": "HL7 Europe",
"telecom": [
{
"system": "url",
"value": "http://hl7.eu"
}
]
}
],
"description": "This profile constrains the Ratio data type to use UCUM as the code system for units and optionally share measurement uncertainty",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "150",
"display": "Europe"
}
]
}
],
"purpose": "This profile of the Ratio data type imposes the usage of the UCUM as the code system for units and allows expressing uncertainty of measurement",
"copyright": "Used by permission of HL7 Europe, all rights reserved Creative Commons License",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "Ratio",
"baseDefinition": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.1.0"
}
],
"element": [
{
"id": "Ratio",
"path": "Ratio",
"short": "A measured ratio using UCUM",
"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.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "Ratio",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "rat-1",
"severity": "error",
"human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))",
"source": "http://hl7.org/fhir/StructureDefinition/Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "RTO"
}
]
},
{
"id": "Ratio.id",
"path": "Ratio.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Ratio.extension",
"path": "Ratio.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Ratio.extension:uncertainty",
"path": "Ratio.extension",
"sliceName": "uncertainty",
"short": "Standard Deviation (same units as the quantity)",
"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).",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "PPD.standardDeviation"
}
]
},
{
"id": "Ratio.extension:uncertaintyType",
"path": "Ratio.extension",
"sliceName": "uncertaintyType",
"short": "Probability Distribution Type for uncertainty",
"definition": "A code specifying the type of probability distribution for the uncertainty.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "PPD.distributionType"
}
]
},
{
"id": "Ratio.numerator",
"path": "Ratio.numerator",
"short": "A measured amount using UCUM",
"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.\r\nThis profile imposes that the code system for units be UCUM.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.numerator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "qty-3",
"severity": "error",
"human": "If a code for the unit is present, the system SHALL also be present",
"expression": "code.empty() or system.exists()",
"xpath": "not(exists(f:code)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}
],
"mustSupport": true,
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
},
{
"identity": "rim",
"map": "PQ, IVL<PQ>, MO, CO, depending on the values"
}
]
},
{
"id": "Ratio.denominator",
"path": "Ratio.denominator",
"short": "A measured amount using UCUM",
"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.\r\nThis profile imposes that the code system for units be UCUM.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.denominator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "qty-3",
"severity": "error",
"human": "If a code for the unit is present, the system SHALL also be present",
"expression": "code.empty() or system.exists()",
"xpath": "not(exists(f:code)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}
],
"mustSupport": true,
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
},
{
"identity": "rim",
"map": "PQ, IVL<PQ>, MO, CO, depending on the values"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Ratio",
"path": "Ratio",
"short": "A measured ratio using UCUM",
"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."
},
{
"id": "Ratio.extension:uncertainty",
"path": "Ratio.extension",
"sliceName": "uncertainty",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty"
]
}
]
},
{
"id": "Ratio.extension:uncertaintyType",
"path": "Ratio.extension",
"sliceName": "uncertaintyType",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType"
]
}
]
}
]
}
}