International Patient Summary Implementation Guide
2.0.0-ballot - STU 2 Ballot 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-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ritikarawlani/fhir-ips/ and changes regularly. See the Directory of published versions

Data Type Profile: RangeIPS - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the Range-uv-ips data type profile.

Guidance on how to interpret the contents of this table can be found here

0. Range
2. Range.low
TypeQuantity(SimpleQuantity (IPS))
Must Supporttrue
4. Range.high
TypeQuantity(SimpleQuantity (IPS))
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here

0. Range
Definition

A set of ordered Quantities defined by a low and high limit.

ShortSet of values bounded by low and high
Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
rng-2: If present, low SHALL have a lower value than high (low.empty() or high.empty() or (low <= high))
rng-2: If present, low SHALL have a lower value than high (low.empty() or high.empty() or (low <= high))
2. Range.low
Definition

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.


The low limit. The boundary is inclusive.

ShortA measured amount using UCUMLow limit
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.


If the low element is missing, the low boundary is not known.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(SimpleQuantity (IPS), SimpleQuantity)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
4. Range.high
Definition

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.


The high limit. The boundary is inclusive.

ShortA measured amount using UCUMHigh limit
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.


If the high element is missing, the high boundary is not known.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(SimpleQuantity (IPS), SimpleQuantity)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())

Guidance on how to interpret the contents of this table can be found here

0. Range
Definition

A set of ordered Quantities defined by a low and high limit.

ShortSet of values bounded by low and high
Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
rng-2: If present, low SHALL have a lower value than high (low.empty() or high.empty() or (low <= high))
2. Range.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Range.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Range.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Range.low
    Definition

    A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.

    ShortA measured amount using UCUM
    Comments

    The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeQuantity(SimpleQuantity (IPS))
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
    sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
    8. Range.high
    Definition

    A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM.

    ShortA measured amount using UCUM
    Comments

    The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeQuantity(SimpleQuantity (IPS))
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
    sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())