ch-core-quantity-with-emed-units
type: StructureDefinition
node role: treeRoot
id:
  v: ch-core-quantity-with-emed-units
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition ch-core-quantity-with-emed-units Name Flags Card. Type Description & Constraints Quantity SimpleQuantity value 1..1 decimal Numerical value (with implicit precision) unit 1..1 string Unit representation system 1..1 uri System that defines coded unit form code 1..1 code Coded form of the unit Binding: UnitCode (preferred) Documentation for this format
url:
  v: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-quantity-with-emed-units
version:
  v: 6.0.0-ballot
name:
  v: CHCoreQuantityWithEmedUnits
title:
  v: CH Core Quantity with EMED Units
status:
  v: active
date:
  v: 2025-05-22T05:56:20+00:00
publisher:
  v: HL7 Switzerland
contact:
  name:
    v: HL7 Switzerland
  telecom:
    system:
      v: url
    value:
      v: https://www.hl7.ch/
contact:
  name:
    v: HL7 Switzerland
  telecom:
    system:
      v: url
    value:
      v: https://www.hl7.ch/
    use:
      v: work
description:
  v: A quantity with defined units
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso: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
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Quantity
base definition:
  v: http://hl7.org/fhir/StructureDefinition/SimpleQuantity
  link: http://hl7.org/fhir/StructureDefinition/SimpleQuantity
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 4.0.1
  element:
    id:
      v: Quantity
    path:
      v: Quantity
    short:
      v: A fixed quantity (no comparator)
    definition:
      v: The comparator is not used on a SimpleQuantity
    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
        link: http://hl7.org/fhir/StructureDefinition/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
        link: http://hl7.org/fhir/StructureDefinition/Quantity
    constraint:
      key:
        v: sqty-1
      severity:
        v: error
      human:
        v: The comparator is not used on a SimpleQuantity
      expression:
        v: comparator.empty()
      xpath:
        v: not(exists(f:comparator))
      source:
        v: http://hl7.org/fhir/StructureDefinition/SimpleQuantity
        link: http://hl7.org/fhir/StructureDefinition/SimpleQuantity
    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
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a

url
v: string

id:
  v: Quantity.extension
path:
  v: Quantity.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  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.
comment:
  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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
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
    link: http://hl7.org/fhir/StructureDefinition/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
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

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
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
    link: http://hl7.org/fhir/StructureDefinition/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: Not allowed to be used in this context
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: 0
base:
  path:
    v: Quantity.comparator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: 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
    link: http://hl7.org/fhir/StructureDefinition/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
    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
    link: 4.0
    link: .1
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
  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: 1
max:
  v: 1
base:
  path:
    v: Quantity.unit
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
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
    link: http://hl7.org/fhir/StructureDefinition/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: System that defines coded unit form
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
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
    link: http://hl7.org/fhir/StructureDefinition/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: 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
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
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: preferred
  value set:
    v: http://fhir.ch/ig/ch-term/ValueSet/UnitCode
    link: http://fhir.ch/ig/ch-term/ValueSet/UnitCode
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.value
  path:
    v: Quantity.value
  min:
    v: 1
element:
  id:
    v: Quantity.unit
  path:
    v: Quantity.unit
  min:
    v: 1
element:
  id:
    v: Quantity.system
  path:
    v: Quantity.system
  min:
    v: 1
element:
  id:
    v: Quantity.code
  path:
    v: Quantity.code
  min:
    v: 1
  binding:
    strength:
      v: preferred
    value set:
      v: http://fhir.ch/ig/ch-term/ValueSet/UnitCode
      link: http://fhir.ch/ig/ch-term/ValueSet/UnitCode