HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
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
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Ratio |
C | 0..* | RatioIPS | A measured ratio using UCUM ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 uncertaintyType |
0..1 | code | Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  numerator |
SC | 0..1 | QuantityIPS | A measured amount using UCUM ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| qty-3 | error | Ratio.numerator, Ratio.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.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 RatioIPS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| qty-3 | error | Ratio.numerator, Ratio.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.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 RatioIPS
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Ratio |
C | 0..* | RatioIPS | A measured ratio using UCUM ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| uncertaintyType |
0..1 | code | Probability Distribution Type for uncertainty URL: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType Binding: ProbabilityDistributionType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| numerator |
SC | 0..1 | QuantityIPS | A measured amount using UCUM ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| qty-3 | error | Ratio.numerator, Ratio.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.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()) |
Differential View
This structure is derived from RatioIPS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| 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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| qty-3 | error | Ratio.numerator, Ratio.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.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 RatioIPS
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Orders and Observations. Package hl7.fhir.uv.lab-report#1.0.0-ballot based on FHIR 4.0.1. Generated 2025-01-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change