HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot International flag

HL7 Laboratory Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-lab-rep-ig/ and changes regularly. See the Directory of published versions

Data Type Profile: Ratio (Uv Lab)

Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/Ratio-uv-lab Version: 1.0.0-ballot
Standards status: Trial-use Computable Name: RatioUvLab

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

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..* RatioIPS A measured ratio using UCUM
... Slices for extension Content/Rules for all slices
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* RatioIPS A measured ratio using UCUM
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... Slices for extension Content/Rules for all slices
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... denominator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

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 C 0..* RatioIPS A measured ratio using UCUM
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

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..* RatioIPS A measured ratio using UCUM
... Slices for extension Content/Rules for all slices
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* RatioIPS A measured ratio using UCUM
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... Slices for extension Content/Rules for all slices
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... denominator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

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 C 0..* RatioIPS A measured ratio using UCUM
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... uncertainty 0..1 decimal Standard Deviation (same units as the quantity)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
.... uncertaintyType 0..1 code Probability Distribution Type for uncertainty
URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Binding: ProbabilityDistributionType (required)
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

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