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
Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Quantity-eu-lab | Version: 0.1.0-ballot | |||
Draft as of 2023-10-22 | Computable Name: QuantityEuLab | |||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
Data type Quantity constrained 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 | |
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): Codes specifying the type of probability distribution. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Quantity | C | 0..* | QuantityIPS | A measured amount using UCUM |
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): Codes specifying the type of probability distribution. | |
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 |
Quantity.comparator | required | QuantityComparator |
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 |
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): Codes specifying the type of probability distribution. | |
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 |
Quantity.comparator | required | QuantityComparator |
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 | |
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): Codes specifying the type of probability distribution. | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Quantity | C | 0..* | QuantityIPS | A measured amount using UCUM |
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): Codes specifying the type of probability distribution. | |
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 |
Quantity.comparator | required | QuantityComparator |
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 |
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): Codes specifying the type of probability distribution. | |
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 |
Quantity.comparator | required | QuantityComparator |
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