FHIRPath Function: highBoundary

{:.stu}

The greatest possible value of the input to the specified precision. {:.stu}

The function can only be used with Decimal, Date, DateTime, and Time values, and returns the same type as the value in the input collection. {:.stu}

If no precision is specified, the greatest precision of the type of the input value is used (i.e. at least 8 for Decimal, 4 for Date, at least 17 for DateTime, and at least 9 for Time). {:.stu}

If the precision is greater than the maximum possible precision of the implementation, the result is empty (CQL returns null). {:.stu}

If the input collection is empty, the result is empty. {:.stu}

If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment. {:.stu}

1.587.highBoundary() // 1.58750000
1.587.highBoundary(6) // 1.587500
1.587.highBoundary(2) // 1.59
1.587.highBoundary(0) // 2
(-1.587).highBoundary() // -1.58650000
(-1.587).highBoundary(6) // -1.586500
(-1.587).highBoundary(2) // -1.58
(-1.587).highBoundary(0) // 1
@2014.highBoundary(6) // @2014-12
@2014-01-01T08.highBoundary(17) // @2014-01-01T08:59:59.999
@T10:30.highBoundary(9) // @T10:30:59.999

{:.stu}

Summary

• Category: Utility functions
• Section: 5.10.6
• Return Type: Decimal | Date | DateTime | Time
• Empty Input Result: empty
• Errors on Multiple Input: true

Description

The greatest possible value of the input to the specified precision. The function can only be used with Decimal, Date, DateTime, and Time values, and returns the same type as the value in the input collection.

Arguments

• precision (optional): Integer - Optional precision specification

Type Mapping

• Decimal-Decimal
• Date-Date
• DateTime-DateTime
• Time-Time

Example

1.587.highBoundary(8) // 1.58799999
@2014.highBoundary(6) // @2014-12
@2014-01-01T08.highBoundary(17) // @2014-01-01T08:59:59.999
@T10:30.highBoundary(9) // @T10:30:59.999