International Patient Summary Implementation Guide
1.1.0 - CI Build International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. 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..* Quantity A measured amount using UCUM
... system S 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code S 1..1 code Coded form of the unit

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C 0..* Quantity A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

... system SΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard

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 C 0..* Quantity A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... value Σ 0..1 decimal Numerical value (with implicit precision)
... unit Σ 0..1 string Unit representation
... system SΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard

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()
qty-3errorQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

This structure is derived from Quantity

Summary

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

Maturity: 2

Differential View

This structure is derived from Quantity

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity 0..* Quantity A measured amount using UCUM
... system S 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code S 1..1 code Coded form of the unit

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Quantity C 0..* Quantity A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

... system SΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard

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 C 0..* Quantity A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... value Σ 0..1 decimal Numerical value (with implicit precision)
... unit Σ 0..1 string Unit representation
... system SΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
... code SΣ 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard

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()
qty-3errorQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

This structure is derived from Quantity

Summary

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

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron