Visit the HL7 website
Visit the FHIR website

Primary Care

current   Canada flag
  • Index
  • Home
  • Business Context
    • Architectural Considerations
    • Use Cases
    • Future Enhancements
    • Consolidation Methodology
  • Technical Context
    • Conformance Guidance
    • Mappings
  • FHIR Artifacts
    • FHIR Artifacts
    • Actors
    • Profiles
    • Extensions
    • Search
    • Data Types
    • Capability Statement
    • Terminology
    • Examples
    • Packages
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Data Types
    4. Quantity

dft-preBallot - This is the first draft of the P-Care IG. For a full list of available versions, see the Directory of published versions

Quantity

Links

Profile

quantity

Derived from

http://hl7.org/fhir/StructureDefinition/Quantity

Examples

Description

A measured amount using UCUM.

References to this resource

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
PCareQuantity (Quantity)CQuantity
There are no (further) constraints on this element
Element id
Quantity
Short description

A measured or measurable amount

Definition

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Comments

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.

Data type

Quantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
id0..1string
There are no (further) constraints on this element
Element id
Quantity.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Quantity.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
valueΣ0..1decimal
There are no (further) constraints on this element
Element id
Quantity.value
Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

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

Data type

decimal

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
comparatorΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Quantity.comparator
Short description

< | <= | >= | > - how to understand the value

Definition

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

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

code

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.1 / CQ.1
  • rim: IVL properties
unitΣ0..1string
There are no (further) constraints on this element
Element id
Quantity.unit
Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
systemO Σ C1..1uriFixed ValueElement id
Quantity.system
Short description

UCUM system for units

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
http://unitsofmeasure.org
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
codeO Σ1..1codeElement id
Quantity.code
Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

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.

Comments

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.

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
PCareQuantity (Quantity)CQuantity
There are no (further) constraints on this element
Element id
Quantity
Short description

A measured or measurable amount

Definition

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Comments

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.

Data type

Quantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
id0..1string
There are no (further) constraints on this element
Element id
Quantity.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Quantity.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
valueΣ0..1decimal
There are no (further) constraints on this element
Element id
Quantity.value
Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

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

Data type

decimal

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
comparatorΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Quantity.comparator
Short description

< | <= | >= | > - how to understand the value

Definition

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

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

code

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: SN.1 / CQ.1
  • rim: IVL properties
unitΣ0..1string
There are no (further) constraints on this element
Element id
Quantity.unit
Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
systemO Σ C1..1uriFixed Value
There are no (further) constraints on this element
Element id
Quantity.system
Short description

UCUM system for units

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: qty-3

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
http://unitsofmeasure.org
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0
codeO Σ1..1code
There are no (further) constraints on this element
Element id
Quantity.code
Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

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.

Comments

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.

Data type

code

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHOULD:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="quantity" />
<text>
<status value="extensions" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity" />
<version value="0.1.0" />
<name value="PCareQuantity" />
<title value="P-Care Quantity" />
<status value="draft" />
<date value="2026-10-19T22:14:59+00:00" />
<publisher value="Infoway" />
<description value="A measured amount using UCUM." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="v2" />
<uri value="http://hl7.org/v2" />
<name value="HL7 v2 Mapping" />
</mapping>
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<type value="Quantity" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Quantity" />
<derivation value="constraint" />
<snapshot>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="4.0.1" />
</extension>
<element id="Quantity">
<path value="Quantity" />
<short value="A measured or measurable amount" />
<definition value="A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies." />
<comment value="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 value="0" />
<max value="*" />
<base>
<path value="Quantity" />
<min value="0" />
<max value="*" />
</base>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="qty-3" />
<severity value="error" />
<human value="If a code for the unit is present, the system SHALL also be present" />
<expression value="code.empty() or system.exists()" />
<xpath value="not(exists(f:code)) or exists(f:system)" />
<source value="http://hl7.org/fhir/StructureDefinition/Quantity" />
</constraint>
<isModifier value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="SN (see also Range) or CQ" />
</mapping>
<mapping>
<identity value="rim" />
<map value="PQ, IVL<PQ>, MO, CO, depending on the values" />
</mapping>
</element>
<element id="Quantity.id">
<path value="Quantity.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Quantity.extension">
<path value="Quantity.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="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 value="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 value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Quantity.value">
<path value="Quantity.value" />
<short value="Numerical value (with implicit precision)" />
<definition value="The value of the measured amount. The value includes an implicit precision in the presentation of the value." />
<comment value="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 value="Precision is handled implicitly in almost all cases of measurement." />
<min value="0" />
<max value="1" />
<base>
<path value="Quantity.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="decimal" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="SN.2 / CQ - N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" />
</mapping>
</element>
<element id="Quantity.comparator">
<path value="Quantity.comparator" />
<short value="< | <= | >= | > - how to understand the value" />
<definition value="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 value="Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology." />
<min value="0" />
<max value="1" />
<base>
<path value="Quantity.comparator" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<meaningWhenMissing value="If there is no comparator, then there is no modification of the value" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="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" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="QuantityComparator" />
</extension>
<strength value="required" />
<description value="How the Quantity should be understood and represented." />
<valueSet value="http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="SN.1 / CQ.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="IVL properties" />
</mapping>
</element>
<element id="Quantity.unit">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="Quantity.unit" />
<short value="Unit representation" />
<definition value="A human-readable form of the unit." />
<requirements value="There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms." />
<min value="0" />
<max value="1" />
<base>
<path value="Quantity.unit" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="(see OBX.6 etc.) / CQ.2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="PQ.unit" />
</mapping>
</element>
<element id="Quantity.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0" />
</extension>
</extension>
<path value="Quantity.system" />
<short value="UCUM system for units" />
<definition value="The identification of the system that provides the coded form of the unit." />
<requirements value="Need to know the system that defines the coded form of the unit." />
<min value="1" />
<max value="1" />
<base>
<path value="Quantity.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<fixedUri value="http://unitsofmeasure.org" />
<condition value="qty-3" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="(see OBX.6 etc.) / CQ.2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CO.codeSystem, PQ.translation.codeSystem" />
</mapping>
</element>
<element id="Quantity.code">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0" />
</extension>
</extension>
<path value="Quantity.code" />
<short value="Coded form of the unit" />
<definition value="A computer processable form of the unit in some unit representation system." />
<comment value="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 value="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 value="1" />
<max value="1" />
<base>
<path value="Quantity.code" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="(see OBX.6 etc.) / CQ.2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="PQ.code, MO.currency, PQ.translation.code" />
</mapping>
</element>
</snapshot>
<differential>
<element id="Quantity.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="Quantity.system" />
<short value="UCUM system for units" />
<min value="1" />
<fixedUri value="http://unitsofmeasure.org" />
</element>
<element id="Quantity.code">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHOULD:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="Quantity.code" />
<min value="1" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "quantity",
"text": {
"status": "extensions",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity",
"version": "0.1.0",
"name": "PCareQuantity",
"title": "P-Care Quantity",
"status": "draft",
"date": "2026-10-19T22:14:59+00:00",
"publisher": "Infoway",
"description": "A measured amount using UCUM.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "Quantity",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Quantity",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Quantity",
"path": "Quantity",
"short": "A measured or measurable amount",
"definition": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.",
"comment": "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": 0,
"max": "*",
"base": {
"path": "Quantity",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "qty-3",
"severity": "error",
"human": "If a code for the unit is present, the system SHALL also be present",
"expression": "code.empty() or system.exists()",
"xpath": "not(exists(f:code)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "SN (see also Range) or CQ"
},
{
"identity": "rim",
"map": "PQ, IVL<PQ>, MO, CO, depending on the values"
}
]
},
{
"id": "Quantity.id",
"path": "Quantity.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Quantity.extension",
"path": "Quantity.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Quantity.value",
"path": "Quantity.value",
"short": "Numerical value (with implicit precision)",
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"comment": "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": "Precision is handled implicitly in almost all cases of measurement.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SN.2 / CQ - N/A"
},
{
"identity": "rim",
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}
]
},
{
"id": "Quantity.comparator",
"path": "Quantity.comparator",
"short": "< | <= | >= | > - how to understand the value",
"definition": "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": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.comparator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "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",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
}
],
"strength": "required",
"description": "How the Quantity should be understood and represented.",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "SN.1 / CQ.1"
},
{
"identity": "rim",
"map": "IVL properties"
}
]
},
{
"id": "Quantity.unit",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Quantity.unit",
"short": "Unit representation",
"definition": "A human-readable form of the unit.",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 0,
"max": "1",
"base": {
"path": "Quantity.unit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "PQ.unit"
}
]
},
{
"id": "Quantity.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Quantity.system",
"short": "UCUM system for units",
"definition": "The identification of the system that provides the coded form of the unit.",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 1,
"max": "1",
"base": {
"path": "Quantity.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://unitsofmeasure.org",
"condition": [
"qty-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "CO.codeSystem, PQ.translation.codeSystem"
}
]
},
{
"id": "Quantity.code",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/quantity|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Quantity.code",
"short": "Coded form of the unit",
"definition": "A computer processable form of the unit in some unit representation system.",
"comment": "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": "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": 1,
"max": "1",
"base": {
"path": "Quantity.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "(see OBX.6 etc.) / CQ.2"
},
{
"identity": "rim",
"map": "PQ.code, MO.currency, PQ.translation.code"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Quantity.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Quantity.system",
"short": "UCUM system for units",
"min": 1,
"fixedUri": "http://unitsofmeasure.org"
},
{
"id": "Quantity.code",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHOULD:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Quantity.code",
"min": 1
}
]
}
}

Constraints

Obligations

ElementActorCode
codehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHOULD:persist, SHALL:no-error
systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHOULD:persist, SHALL:no-error

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
Quantity.comparatorrequiredhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1

Additional Terminology Bindings Only

IG © based on FHIR R4 | template version 2.5.1 | Package project:p-care
Copyright © 2026 Canada Health Infoway. All rights reserved. Terms of Use & License Agreements. Privacy Policy.
HL7® and FHIR® are the registered trademarks of Health Level Seven International