HL7 Europe Laboratory Report
0.1.0-ballot - ballot 150

This page is part of the HL7 Europe Laboratory Report (v0.1.0-ballot: STU 1 Ballot 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

Data Type Profile: Ratio (Eu) for lab observations

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Ratio-eu-lab Version: 0.1.0-ballot
Draft as of 2023-10-22 Computable Name: RatioEuLab

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

Data type Ratio constrained 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

Usage:

Formal Views of Profile Content

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

This structure is derived from RatioIPS

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..*RatioIPSA measured ratio using UCUM
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... uncertaintyType 0..1codeProbability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required): Codes specifying the type of probability distribution.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C0..*RatioIPSA measured ratio using UCUM
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... uncertaintyType 0..1codeProbability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required): Codes specifying the type of probability distribution.


... numerator SC0..1QuantityIPSA measured amount using UCUM

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator 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())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C0..*RatioIPSA measured ratio using UCUM
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... numerator SC0..1QuantityIPSA measured amount using UCUM
... denominator SC0..1QuantityIPSA measured amount using UCUM

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator 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 RatioIPS

Differential View

This structure is derived from RatioIPS

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..*RatioIPSA measured ratio using UCUM
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... uncertaintyType 0..1codeProbability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required): Codes specifying the type of probability distribution.


doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C0..*RatioIPSA measured ratio using UCUM
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... uncertaintyType 0..1codeProbability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required): Codes specifying the type of probability distribution.


... numerator SC0..1QuantityIPSA measured amount using UCUM

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator 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())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C0..*RatioIPSA measured ratio using UCUM
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... Uncertainty 0..1decimalStandard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
... numerator SC0..1QuantityIPSA measured amount using UCUM
... denominator SC0..1QuantityIPSA measured amount using UCUM

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator 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 RatioIPS

 

Other representations of profile: CSV, Excel, Schematron