FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Quantity Confidence Interval (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/quantity-confidenceInterval Version: 5.3.0-ballot-tc1
Standards status: Draft Maturity Level: 0 Responsible: HL7 International / Orders and Observations Computable Name: QuantityConfidenceInterval

The range within which, at the given level of confidence, the actual value resides. For example, a nominal value (from the context Observation.value) of 4.3 may be reported, but this extension may be used to indicate that the reporting device is only 95% confident that the actual value is in the range of 3.1 to 5.5.

The reported value, if present, should be precise enough to reflect the confidence interval. For example, a nominal quantity of 3.2 kg with a confidence interval of [3.21, 3.27] kg would be nonsensical. On the other hand, a reported value of 3.24 kg with a 95% confidence interval of [3.21, 3.27] kg would indicate a 95% confidence that the actual value is in that range.

The reported value need not be at the center of the confidence interval; for example, if the values don't follow a normal distribution. The context Observation.value SHOULD be present when this extension is used, due to the risk that systems unfamiliar with (or ignoring) this extension may be unable to process a valueless quantity.

The interval range low and high units are usually the same as the reported value's units. Confidence interval range low and high units SHOULD be provided for clarity; if omitted, they are implied to be the same as the reported value's units.

This is an experimental extension definition; the definition is intended for testing purposes, education or evaluation, and the definition is not anticipated to be matured to a point where it is intended for genuine usage.

Context of Use

This extension may be used on the following element(s)

In addition, the extension can only be used when this FHIRPath expression is true:

$this is Quantity

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • New Content

    • Formal Views of Extension Content

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

    This structure is derived from Extension

    Summary

    Simple Extension with the type base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta: The range within which, at the given level of confidence, the actual value resides. For example, a nominal value (from the context Observation.value) of 4.3 may be reported, but this extension may be used to indicate that the reporting device is only 95% confident that the actual value is in the range of 3.1 to 5.5.

    The reported value, if present, should be precise enough to reflect the confidence interval. For example, a nominal quantity of 3.2 kg with a confidence interval of [3.21, 3.27] kg would be nonsensical. On the other hand, a reported value of 3.24 kg with a 95% confidence interval of [3.21, 3.27] kg would indicate a 95% confidence that the actual value is in that range.

    The reported value need not be at the center of the confidence interval; for example, if the values don't follow a normal distribution. The context Observation.value SHOULD be present when this extension is used, due to the risk that systems unfamiliar with (or ignoring) this extension may be unable to process a valueless quantity.

    The interval range low and high units are usually the same as the reported value's units. Confidence interval range low and high units SHOULD be provided for clarity; if omitted, they are implied to be the same as the reported value's units.

    Maturity: 0

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Confidence interval for the quantity
    ... Slices for extension 2..* Extension Extension
    Slice: Unordered, Closed by value:url
    .... extension:confidence 1..1 Extension The confidence level in percent (0..100)
    ..... value[x] 1..1 decimal Value of extension
    .... extension:interval 1..1 Extension Range in which actual value is expected to reside
    ..... value[x] 0..1 Range Value of extension
    ..... valueRange
    ...... low 1..1 SimpleQuantity The lower bound of the confidence interval
    ...... high 1..1 SimpleQuantity The upper bound of the confidence interval
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/quantity-confidenceInterval"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Confidence interval for the quantity
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Extension
    Slice: Unordered, Closed by value:url
    .... extension:confidence 1..1 Extension The confidence level in percent (0..100)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri identifies the meaning of the extension
    ..... value[x] 1..1 decimal Value of extension
    .... extension:interval 1..1 Extension Range in which actual value is expected to reside
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri identifies the meaning of the extension
    ..... value[x] 0..1 Range Value of extension
    ...... id 0..1 id Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... low ΣC 1..1 SimpleQuantity The lower bound of the confidence interval
    ...... high ΣC 1..1 SimpleQuantity The upper bound of the confidence interval
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/quantity-confidenceInterval"
    .... valueBase64Binary base64Binary
    .... valueBoolean boolean
    .... valueCanonical canonical(Any)
    .... valueCode code
    .... valueDate date
    .... valueDateTime dateTime
    .... valueDecimal decimal
    .... valueId id
    .... valueInstant instant
    .... valueInteger integer
    .... valueInteger64 integer64
    .... valueMarkdown markdown
    .... valueOid oid
    .... valuePositiveInt positiveInt
    .... valueString string
    .... valueTime time
    .... valueUnsignedInt unsignedInt
    .... valueUri uri
    .... valueUrl url
    .... valueUuid uuid
    .... valueAddress Address
    .... valueAge Age
    .... valueAnnotation Annotation
    .... valueAttachment Attachment
    .... valueCodeableConcept CodeableConcept
    .... valueCodeableReference CodeableReference
    .... valueCoding Coding
    .... valueContactPoint ContactPoint
    .... valueCount Count
    .... valueDistance Distance
    .... valueDuration Duration
    .... valueHumanName HumanName
    .... valueIdentifier Identifier
    .... valueMoney Money
    .... valuePeriod Period
    .... valueQuantity Quantity
    .... valueRange Range
    .... valueRatio Ratio
    .... valueRatioRange RatioRange
    .... valueReference Reference(Any)
    .... valueSampledData SampledData
    .... valueSignature Signature
    .... valueTiming Timing
    .... valueContactDetail ContactDetail
    .... valueDataRequirement DataRequirement
    .... valueExpression Expression
    .... valueParameterDefinition ParameterDefinition
    .... valueRelatedArtifact RelatedArtifact
    .... valueTriggerDefinition TriggerDefinition
    .... valueUsageContext UsageContext
    .... valueAvailability Availability
    .... valueExtendedContactDetail ExtendedContactDetail
    .... valueDosage Dosage
    .... valueMeta Meta

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta: The range within which, at the given level of confidence, the actual value resides. For example, a nominal value (from the context Observation.value) of 4.3 may be reported, but this extension may be used to indicate that the reporting device is only 95% confident that the actual value is in the range of 3.1 to 5.5.

    The reported value, if present, should be precise enough to reflect the confidence interval. For example, a nominal quantity of 3.2 kg with a confidence interval of [3.21, 3.27] kg would be nonsensical. On the other hand, a reported value of 3.24 kg with a 95% confidence interval of [3.21, 3.27] kg would indicate a 95% confidence that the actual value is in that range.

    The reported value need not be at the center of the confidence interval; for example, if the values don't follow a normal distribution. The context Observation.value SHOULD be present when this extension is used, due to the risk that systems unfamiliar with (or ignoring) this extension may be unable to process a valueless quantity.

    The interval range low and high units are usually the same as the reported value's units. Confidence interval range low and high units SHOULD be provided for clarity; if omitted, they are implied to be the same as the reported value's units.

    Maturity: 0

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Confidence interval for the quantity
    ... Slices for extension 2..* Extension Extension
    Slice: Unordered, Closed by value:url
    .... extension:confidence 1..1 Extension The confidence level in percent (0..100)
    ..... value[x] 1..1 decimal Value of extension
    .... extension:interval 1..1 Extension Range in which actual value is expected to reside
    ..... value[x] 0..1 Range Value of extension
    ..... valueRange
    ...... low 1..1 SimpleQuantity The lower bound of the confidence interval
    ...... high 1..1 SimpleQuantity The upper bound of the confidence interval
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/quantity-confidenceInterval"

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Confidence interval for the quantity
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Extension
    Slice: Unordered, Closed by value:url
    .... extension:confidence 1..1 Extension The confidence level in percent (0..100)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri identifies the meaning of the extension
    ..... value[x] 1..1 decimal Value of extension
    .... extension:interval 1..1 Extension Range in which actual value is expected to reside
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri identifies the meaning of the extension
    ..... value[x] 0..1 Range Value of extension
    ...... id 0..1 id Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ...... low ΣC 1..1 SimpleQuantity The lower bound of the confidence interval
    ...... high ΣC 1..1 SimpleQuantity The upper bound of the confidence interval
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/quantity-confidenceInterval"
    .... valueBase64Binary base64Binary
    .... valueBoolean boolean
    .... valueCanonical canonical(Any)
    .... valueCode code
    .... valueDate date
    .... valueDateTime dateTime
    .... valueDecimal decimal
    .... valueId id
    .... valueInstant instant
    .... valueInteger integer
    .... valueInteger64 integer64
    .... valueMarkdown markdown
    .... valueOid oid
    .... valuePositiveInt positiveInt
    .... valueString string
    .... valueTime time
    .... valueUnsignedInt unsignedInt
    .... valueUri uri
    .... valueUrl url
    .... valueUuid uuid
    .... valueAddress Address
    .... valueAge Age
    .... valueAnnotation Annotation
    .... valueAttachment Attachment
    .... valueCodeableConcept CodeableConcept
    .... valueCodeableReference CodeableReference
    .... valueCoding Coding
    .... valueContactPoint ContactPoint
    .... valueCount Count
    .... valueDistance Distance
    .... valueDuration Duration
    .... valueHumanName HumanName
    .... valueIdentifier Identifier
    .... valueMoney Money
    .... valuePeriod Period
    .... valueQuantity Quantity
    .... valueRange Range
    .... valueRatio Ratio
    .... valueRatioRange RatioRange
    .... valueReference Reference(Any)
    .... valueSampledData SampledData
    .... valueSignature Signature
    .... valueTiming Timing
    .... valueContactDetail ContactDetail
    .... valueDataRequirement DataRequirement
    .... valueExpression Expression
    .... valueParameterDefinition ParameterDefinition
    .... valueRelatedArtifact RelatedArtifact
    .... valueTriggerDefinition TriggerDefinition
    .... valueUsageContext UsageContext
    .... valueAvailability Availability
    .... valueExtendedContactDetail ExtendedContactDetail
    .... valueDosage Dosage
    .... valueMeta Meta

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    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()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)