International Patient Summary Implementation Guide
2.0.0 - STU 2 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 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

Data Type Profile: Quantity (IPS)

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:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Quantity C 0..* Quantity A measured amount using UCUM
Constraints: qty-3
... value SOΣ 0..1 decimal Numerical value (with implicit precision)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)

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

This structure is derived from Quantity

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Quantity 0..* Quantity A measured amount using UCUM
... value SO 0..1 decimal Numerical value (with implicit precision)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... system SO 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
... code SO 1..1 code Coded form of the unit
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... unit Σ 0..1 string Unit representation
... system SOΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
... code SOΣ 1..1 code Coded form of the unit
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

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: 3 elements
Fixed: 1 element

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Quantity C 0..* Quantity A measured amount using UCUM
Constraints: qty-3
... value SOΣ 0..1 decimal Numerical value (with implicit precision)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)

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

Differential View

This structure is derived from Quantity

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Quantity 0..* Quantity A measured amount using UCUM
... value SO 0..1 decimal Numerical value (with implicit precision)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... system SO 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
... code SO 1..1 code Coded form of the unit
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... unit Σ 0..1 string Unit representation
... system SOΣC 1..1 uri UCUM system for units
Fixed Value: http://unitsofmeasure.org
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
... code SOΣ 1..1 code Coded form of the unit
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

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: 3 elements
Fixed: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron