This page is part of the HL7 Europe Laboratory Report (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Ratio (Eu Lab)

This profile constrains the Ratio data type to use UCUM as the code system for units and optionally share measurement uncertainty

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

Usages:

• Use this DataType Profile: Observation Results: laboratory

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio	C	0..*	Ratio	A measured ratio using UCUM Constraints: rat-1
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
rat-1	error	Ratio	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())

This structure is derived from Ratio

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio		0..*	Ratio	A measured ratio using UCUM
Ratio.numerator
Ratio.numerator.Slices for extension				Content/Rules for all slices
Ratio.numerator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.numerator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.numerator.system		0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.numerator.code		1..1	code	Coded form of the unit
Ratio.denominator
Ratio.denominator.Slices for extension				Content/Rules for all slices
Ratio.denominator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.denominator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.denominator.system		0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.denominator.code		1..1	code	Coded form of the unit
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio	C	0..*	Ratio	A measured ratio using UCUM Constraints: rat-1
Ratio.id		0..1	string	Unique id for inter-element referencing
Ratio.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.numerator	Σ This element is included in summaries.	0..1	Quantity	Numerator value
Ratio.numerator.id		0..1	string	Unique id for inter-element referencing
Ratio.numerator.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.numerator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.numerator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.numerator.value	Σ This element is included in summaries.	0..1	decimal	Numerical value (with implicit precision)
Ratio.numerator.comparator	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Ratio.numerator.unit	Σ This element is included in summaries.	0..1	string	Unit representation
Ratio.numerator.system	Σ This element is included in summaries. C	0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.numerator.code	Σ This element is included in summaries.	1..1	code	Coded form of the unit
Ratio.denominator	Σ This element is included in summaries.	0..1	Quantity	Denominator value
Ratio.denominator.id		0..1	string	Unique id for inter-element referencing
Ratio.denominator.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.denominator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.denominator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.denominator.value	Σ This element is included in summaries.	0..1	decimal	Numerical value (with implicit precision)
Ratio.denominator.comparator	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Ratio.denominator.unit	Σ This element is included in summaries.	0..1	string	Unit representation
Ratio.denominator.system	Σ This element is included in summaries. C	0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.denominator.code	Σ This element is included in summaries.	1..1	code	Coded form of the unit
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Ratio.numerator.comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.
Ratio.denominator.comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
rat-1	error	Ratio	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())

This structure is derived from Ratio

Summary

Mandatory: 0 element(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty|5.3.0
• http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType|5.3.0

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio	C	0..*	Ratio	A measured ratio using UCUM Constraints: rat-1
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
rat-1	error	Ratio	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())

Differential View

This structure is derived from Ratio

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio		0..*	Ratio	A measured ratio using UCUM
Ratio.numerator
Ratio.numerator.Slices for extension				Content/Rules for all slices
Ratio.numerator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.numerator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.numerator.system		0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.numerator.code		1..1	code	Coded form of the unit
Ratio.denominator
Ratio.denominator.Slices for extension				Content/Rules for all slices
Ratio.denominator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.denominator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.denominator.system		0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.denominator.code		1..1	code	Coded form of the unit
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Ratio	C	0..*	Ratio	A measured ratio using UCUM Constraints: rat-1
Ratio.id		0..1	string	Unique id for inter-element referencing
Ratio.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.numerator	Σ This element is included in summaries.	0..1	Quantity	Numerator value
Ratio.numerator.id		0..1	string	Unique id for inter-element referencing
Ratio.numerator.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.numerator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.numerator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.numerator.value	Σ This element is included in summaries.	0..1	decimal	Numerical value (with implicit precision)
Ratio.numerator.comparator	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Ratio.numerator.unit	Σ This element is included in summaries.	0..1	string	Unit representation
Ratio.numerator.system	Σ This element is included in summaries. C	0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.numerator.code	Σ This element is included in summaries.	1..1	code	Coded form of the unit
Ratio.denominator	Σ This element is included in summaries.	0..1	Quantity	Denominator value
Ratio.denominator.id		0..1	string	Unique id for inter-element referencing
Ratio.denominator.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Ratio.denominator.Slices for extension.extension:uncertainty		0..1	decimal	Standard Deviation (same units as the quantity) URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Ratio.denominator.Slices for extension.extension:uncertaintyType		0..1	code	Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required)
Ratio.denominator.value	Σ This element is included in summaries.	0..1	decimal	Numerical value (with implicit precision)
Ratio.denominator.comparator	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Ratio.denominator.unit	Σ This element is included in summaries.	0..1	string	Unit representation
Ratio.denominator.system	Σ This element is included in summaries. C	0..1	uri	System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed)
Ratio.denominator.code	Σ This element is included in summaries.	1..1	code	Coded form of the unit
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Ratio.numerator.comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.
Ratio.denominator.comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
rat-1	error	Ratio	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())

This structure is derived from Ratio

Summary

Mandatory: 0 element(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty|5.3.0
• http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType|5.3.0

Maturity: 2

Other representations of profile: CSV, Excel, Schematron