ch-elm-quantity-arbu
type: StructureDefinition
node role: treeRoot
id:
  v: ch-elm-quantity-arbu
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ch-elm-quantity-arbu Name Flags Card. Type Description & Constraints Quantity <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( ch-elm-value-ge-zero )">C 0..* QuantityEuLab A measured amount using UCUM Constraints: ch-elm-value-ge-zero #xD; value 1..1 decimal Numerical value (with implicit precision) #xD; unit 0..1 string Unit representation Required Pattern: [arb'U] #xD; code 1..1 code Coded form of the unit Required Pattern: [arb'U] #xD; Documentation for this format
url:
  v: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-quantity-arbu
  l: ch-elm-quantity-arbu
version:
  v: 1.13.1
name:
  v: ChElmQuantityArbU
title:
  v: CH ELM Quantity arb'U
status:
  v: active
date:
  v: 2026-01-21T11:05:32+00:00
publisher:
  v: Federal Office of Public Health FOPH
contact:
  name:
    v: Federal Office of Public Health FOPH
  telecom:
    system:
      v: url
    value:
      v: https://www.bag.admin.ch/bag/en/home/das-bag/kontakt-standort.html
description:
  v: Quantity with unit arb'U and system http://unitsofmeasure.org
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: CH
copyright:
  v: CC0-1.0
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Quantity
  l: Quantity
base definition:
  v: http://hl7.eu/fhir/laboratory/StructureDefinition/Quantity-eu-lab
  l: Quantity-eu-lab
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 0.1.1
  element:
    id:
      v: Quantity
    path:
      v: Quantity
    short:
      v: A measured amount using UCUM
    definition:
      v: A measured amount (or an amount that can potentially be measured) and uncertainty of the measurement. Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.
    comment:
      v: The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Quantity
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    constraint:
      key:
        v: qty-3
      severity:
        v: error
      human:
        v: If a code for the unit is present, the system SHALL also be present
      expression:
        v: code.empty() or system.exists()
      xpath:
        v: not(exists(f:code)) or exists(f:system)
      source:
        v: http://hl7.org/fhir/StructureDefinition/Quantity
        l: Quantity
    constraint:
      key:
        v: ch-elm-value-ge-zero
      severity:
        v: error
      human:
        v: value must be greater than or equal zero
      expression:
        v: value >= 0
      source:
        v: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-quantity-arbu
        l: ch-elm-quantity-arbu
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: SN (see also Range) or CQ
    mapping:
      identity:
        v: rim
      map:
        v: PQ, IVL<PQ>, MO, CO, depending on the values
  element:
    id:
      v: Quantity.id
    path:
      v: Quantity.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: Url
      code:
        v: http://hl7.org/fhirpath/System.String
        l: System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Quantity.extension
    path:
      v: Quantity.extension

Url
v: string
l: string

discriminator:
  type:
    v: value
  path:
    v: url
description:
  v: Extensions are always sliced by (at least) url
rules:
  v: open

v: Additional content defined by implementations

v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

v: extensions

v: user content

v: 0

v: *

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension
  l: Extension

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() or (children().count() > id.count())
xpath:
  v: @value|f:*|h:div
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  l: Element

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  l: Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: Quantity.extension:uncertainty
path:
  v: Quantity.extension
slice name:
  v: uncertainty
short:
  v: Standard Deviation (same units as the quantity)
definition:
  v: The primary measure of variance/uncertainty of the value (the square root of the sum of the squares of the differences between all data points and the mean).
comment:
  v: standardDeviation has the same units as the quantity. It is used to normalize the data for computing the distribution function. Applications that cannot deal with probability distributions can still get an idea about the confidence level by looking at standardDeviation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
    l: iso21090-uncertainty
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: PPD.standardDeviation

id:
  v: Quantity.extension:uncertaintyType
path:
  v: Quantity.extension
slice name:
  v: uncertaintyType
short:
  v: Probability Distribution Type for uncertainty
definition:
  v: A code specifying the type of probability distribution for the uncertainty.
comment:
  v: This is only meaningful if there is also an uncertainty extension. If there is an uncertainty extension with no type, this means that the probability distribution type is unknown. In that case, the uncertainty has the meaning of an informal guess.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
    l: iso21090-uncertaintyType
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: PPD.distributionType

id:
  v: Quantity.value
path:
  v: Quantity.value
short:
  v: Numerical value (with implicit precision)
definition:
  v: The value of the measured amount. The value includes an implicit precision in the presentation of the value.
comment:
  v: The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
requirements:
  v: Precision is handled implicitly in almost all cases of measurement.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Quantity.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: decimal
    l: decimal
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: SN.2 / CQ - N/A
mapping:
  identity:
    v: rim
  map:
    v: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

id:
  v: Quantity.comparator
path:
  v: Quantity.comparator
short:
  v: < | <= | >= | > - how to understand the value
definition:
  v: How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
requirements:
  v: Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Quantity.comparator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
meaning when missing:
  v: If there is no comparator, then there is no modification of the value
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: QuantityComparator
  strength:
    v: required
  description:
    v: How the Quantity should be understood and represented.
  value set:
    v: http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
    l: http://hl7.org/fhir/ValueSet/quantity-comparator
mapping:
  identity:
    v: v2
  map:
    v: SN.1 / CQ.1
mapping:
  identity:
    v: rim
  map:
    v: IVL properties

id:
  v: Quantity.unit
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Quantity.unit
short:
  v: Unit representation
definition:
  v: A human-readable form of the unit.
requirements:
  v: There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Quantity.unit
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
pattern: String
  v: [arb'U]
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: (see OBX.6 etc.) / CQ.2
mapping:
  identity:
    v: rim
  map:
    v: PQ.unit

id:
  v: Quantity.system
path:
  v: Quantity.system
short:
  v: UCUM system for units
definition:
  v: The identification of the system that provides the coded form of the unit.
requirements:
  v: Need to know the system that defines the coded form of the unit.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Quantity.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://unitsofmeasure.org
  l: unitsofmeasure.org
condition:
  v: qty-3
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: (see OBX.6 etc.) / CQ.2
mapping:
  identity:
    v: rim
  map:
    v: CO.codeSystem, PQ.translation.codeSystem

id:
  v: Quantity.code
path:
  v: Quantity.code
short:
  v: Coded form of the unit
definition:
  v: A computer processable form of the unit in some unit representation system.
comment:
  v: The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
requirements:
  v: Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Quantity.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
pattern: Code
  v: [arb'U]
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: (see OBX.6 etc.) / CQ.2
mapping:
  identity:
    v: rim
  map:
    v: PQ.code, MO.currency, PQ.translation.code

element:
  id:
    v: Quantity
  path:
    v: Quantity
  constraint:
    key:
      v: ch-elm-value-ge-zero
    severity:
      v: error
    human:
      v: value must be greater than or equal zero
    expression:
      v: value >= 0
    source:
      v: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-quantity-arbu
      l: ch-elm-quantity-arbu
element:
  id:
    v: Quantity.value
  path:
    v: Quantity.value
  min:
    v: 1
element:
  id:
    v: Quantity.unit
  path:
    v: Quantity.unit
  pattern: String
    v: [arb'U]
element:
  id:
    v: Quantity.code
  path:
    v: Quantity.code
  pattern: Code
    v: [arb'U]