International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
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 2.0.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
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips | Version: 2.0.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
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Quantity |
C | 0..* | Quantity | A measured amount using UCUM Constraints: qty-3 | |||||||||||
  value |
SOΣ | 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. | |||||||||||
| system |
SOΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| |||||||||||
 code |
SOΣ | 1..1 | code | Coded form of the unit
| |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard |
| 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() |
This structure is derived from Quantity
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quantity |
0..* | Quantity | A measured amount using UCUM | |||||||||
| value |
SO | 0..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| system |
SO | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SO | 1..1 | code | Coded form of the unit
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quantity |
C | 0..* | Quantity | A measured amount using UCUM Constraints: qty-3 | |||||||||||
| 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 |
SOΣ | 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 |
SOΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| |||||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit
| |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard |
| 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quantity |
C | 0..* | Quantity | A measured amount using UCUM Constraints: qty-3 | |||||||||||
| value |
SOΣ | 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. | |||||||||||
| system |
SOΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| |||||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit
| |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard |
| 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() |
Differential View
This structure is derived from Quantity
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quantity |
0..* | Quantity | A measured amount using UCUM | |||||||||
| value |
SO | 0..1 | decimal | Numerical value (with implicit precision)
| ||||||||
| system |
SO | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| ||||||||
| code |
SO | 1..1 | code | Coded form of the unit
| ||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quantity |
C | 0..* | Quantity | A measured amount using UCUM Constraints: qty-3 | |||||||||||
| 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 |
SOΣ | 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 |
SOΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org
| |||||||||||
| code |
SOΣ | 1..1 | code | Coded form of the unit
| |||||||||||
| Documentation for this format | |||||||||||||||
| Path | Conformance | ValueSet | URI |
| Quantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard |
| 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-06-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change