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: Ratio (IPS)

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

Ratio data type, constrained to use UCUM as the code system for units.

Allow only 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 Ratio

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
... numerator S 0..1 QuantityIPS A measured amount using UCUM
... denominator S 0..1 QuantityIPS A measured amount using UCUM

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... denominator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension 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
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

doco Documentation for this format

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-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

This structure is derived from Ratio

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from Ratio

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
... numerator S 0..1 QuantityIPS A measured amount using UCUM
... denominator S 0..1 QuantityIPS A measured amount using UCUM

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present
... denominator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qty-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio C 0..* Ratio A ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension 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
... numerator SC 0..1 QuantityIPS A measured amount using UCUM
qty-3: If a code for the unit is present, the system SHALL also be present

doco Documentation for this format

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-3errorRatio.numerator, Ratio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

This structure is derived from Ratio

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron