This page is part of the International Patient Summary Implementation Guide (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Quantity (IPS)

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:

• Use this DataType Constraint: Observation - SH: alcohol use, Observation Results: radiology (IPS) and Ratio (IPS)

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Quantity

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Quantity.comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
qty-3	error	Quantity	If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()

Name	Flags	Card.	Type	Description & Constraints
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)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Quantity.comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
qty-3	error	Quantity	If 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

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Quantity.comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
qty-3	error	Quantity	If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Quantity.comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
qty-3	error	Quantity	If 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