International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Type Profile: Quantity (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: QuantityIPS

Data type Quantity constrained to use UCUM as the code system for units

This profile of the Quantity data type imposes the usage of the UCUM as the code system for units

Usage:

Formal Views of Profile Content

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

This structure is derived from Quantity

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity 0..*QuantityA measured amount using UCUM
... system S1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code S1..1codeCoded form of the unit

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C0..*QuantityA measured amount using UCUM
... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

... system SΣC1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ1..1codeCoded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Quantity.comparatorrequiredQuantityComparator

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qty-3errorQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C0..*QuantityA measured amount using UCUM
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... value Σ0..1decimalNumerical value (with implicit precision)
... unit Σ0..1stringUnit representation
... system SΣC1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ1..1codeCoded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Quantity.comparatorrequiredQuantityComparator

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

This structure is derived from Quantity

Summary

Mandatory: 2 elements
Must-Support: 2 elements
Fixed Value: 1 element

Maturity: 2

Differential View

This structure is derived from Quantity

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity 0..*QuantityA measured amount using UCUM
... system S1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code S1..1codeCoded form of the unit

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C0..*QuantityA measured amount using UCUM
... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

... system SΣC1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ1..1codeCoded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Quantity.comparatorrequiredQuantityComparator

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qty-3errorQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C0..*QuantityA measured amount using UCUM
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... value Σ0..1decimalNumerical value (with implicit precision)
... unit Σ0..1stringUnit representation
... system SΣC1..1uriUCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ1..1codeCoded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Quantity.comparatorrequiredQuantityComparator

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

This structure is derived from Quantity

Summary

Mandatory: 2 elements
Must-Support: 2 elements
Fixed Value: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron