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/Quantity-uv-lab | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Computable Name: QuantityUvLab | |||
This profile constrains the Quantity data type to use UCUM as the code system for units and optionally share measurement uncertainty
This profile of the Quantity 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.
This structure is derived from QuantityIPS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Quantity |
0..* | QuantityIPS | A measured amount 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 |
|---|---|---|---|---|
| Quantity |
C | 0..* | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be 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) | |
  comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| system |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org |
 code |
SΣ | 1..1 | code | Coded form of the unit |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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 | Quantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Quantity |
C | 0..* | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be 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) | |
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org |
| code |
SΣ | 1..1 | code | Coded form of the unit |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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 | Quantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() |
This structure is derived from QuantityIPS
Differential View
This structure is derived from QuantityIPS
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Quantity |
0..* | QuantityIPS | A measured amount 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 | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Quantity |
C | 0..* | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be 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) | |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| system |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org |
| code |
SΣ | 1..1 | code | Coded form of the unit |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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 | Quantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Quantity |
C | 0..* | QuantityIPS | A measured amount using UCUM qty-3: If a code for the unit is present, the system SHALL also be 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) | |
| value |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| unit |
Σ | 0..1 | string | Unit representation |
| system |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org |
| code |
SΣ | 1..1 | code | Coded form of the unit |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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 | Quantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() |
This structure is derived from QuantityIPS
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 2024-10-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change