@medplum/core 2.0.20 → 2.0.22

package/dist/esm/fhirpath/functions.mjs

@@ -6,6 +6,7 @@ import { booleanToTypedValue, toJsBoolean, removeDuplicates, isQuantity, fhirPat
 
 /**
  * Temporary placholder for unimplemented methods.
+ * @returns Empty array.
  */
 const stub = () => [];
 const functions = {
@@ -17,7 +18,6 @@ const functions = {
      * Returns true if the input collection is empty ({ }) and false otherwise.
      *
      * See: https://hl7.org/fhirpath/#empty-boolean
-     *
      * @param input The input collection.
      * @returns True if the input collection is empty ({ }) and false otherwise.
      */
@@ -34,9 +34,8 @@ const functions = {
      * for where(criteria).exists().
      *
      * See: https://hl7.org/fhirpath/#existscriteria-expression-boolean
-     *
-     * @param input
-     * @param criteria
+     * @param input The input collection.
+     * @param criteria Optional criteria applied to the collection.
      * @returns True if the collection has unknown elements, and false otherwise.
      */
     exists: (input, criteria) => {
@@ -54,7 +53,6 @@ const functions = {
      * If the input collection is empty ({ }), the result is true.
      *
      * See: https://hl7.org/fhirpath/#allcriteria-expression-boolean
-     *
      * @param input The input collection.
      * @param criteria The evaluation criteria.
      * @returns True if for every element in the input collection, criteria evaluates to true.
@@ -68,9 +66,7 @@ const functions = {
      * If the input is empty ({ }), the result is true.
      *
      * See: https://hl7.org/fhirpath/#alltrue-boolean
-     *
      * @param input The input collection.
-     * @param criteria The evaluation criteria.
      * @returns True if all the items are true.
      */
     allTrue: (input) => {
@@ -86,9 +82,7 @@ const functions = {
      * If all the items are false, or if the input is empty ({ }), the result is false.
      *
      * See: https://hl7.org/fhirpath/#anytrue-boolean
-     *
      * @param input The input collection.
-     * @param criteria The evaluation criteria.
      * @returns True if unknown of the items are true.
      */
     anyTrue: (input) => {
@@ -105,9 +99,7 @@ const functions = {
      * If the input is empty ({ }), the result is true.
      *
      * See: https://hl7.org/fhirpath/#allfalse-boolean
-     *
      * @param input The input collection.
-     * @param criteria The evaluation criteria.
      * @returns True if all the items are false.
      */
     allFalse: (input) => {
@@ -123,9 +115,7 @@ const functions = {
      * If all the items are true, or if the input is empty ({ }), the result is false.
      *
      * See: https://hl7.org/fhirpath/#anyfalse-boolean
-     *
      * @param input The input collection.
-     * @param criteria The evaluation criteria.
      * @returns True if for every element in the input collection, criteria evaluates to true.
      */
     anyFalse: (input) => {
@@ -165,7 +155,6 @@ const functions = {
      * Returns 0 when the input collection is empty.
      *
      * See: https://hl7.org/fhirpath/#count-integer
-     *
      * @param input The input collection.
      * @returns The integer count of the number of items in the input collection.
      */
@@ -183,7 +172,6 @@ const functions = {
      * preserved in the result.
      *
      * See: https://hl7.org/fhirpath/#distinct-collection
-     *
      * @param input The input collection.
      * @returns The integer count of the number of items in the input collection.
      */
@@ -202,7 +190,6 @@ const functions = {
      * as defined below.
      *
      * See: https://hl7.org/fhirpath/#isdistinct-boolean
-     *
      * @param input The input collection.
      * @returns The integer count of the number of items in the input collection.
      */
@@ -225,9 +212,8 @@ const functions = {
      * consistent with singleton evaluation of collections behavior.
      *
      * See: https://hl7.org/fhirpath/#wherecriteria-expression-collection
-     *
      * @param input The input collection.
-     * @param condition The condition atom.
+     * @param criteria The condition atom.
      * @returns A collection containing only those elements in the input collection for which the stated criteria expression evaluates to true.
      */
     where: (input, criteria) => {
@@ -243,6 +229,9 @@ const functions = {
      * the input collection is empty ({ }), the result is empty as well.
      *
      * See: http://hl7.org/fhirpath/#selectprojection-expression-collection
+     * @param input The input collection.
+     * @param criteria The condition atom.
+     * @returns A collection containing only those elements in the input collection for which the stated criteria expression evaluates to true.
      */
     select: (input, criteria) => {
         return input.map((e) => criteria.eval([e])).flat();
@@ -262,6 +251,9 @@ const functions = {
      * must resolve to the name of a type in a model
      *
      * See: http://hl7.org/fhirpath/#oftypetype-type-specifier-collection
+     * @param input The input collection.
+     * @param criteria The condition atom.
+     * @returns A collection containing only those elements in the input collection that are of the given type or a subclass thereof.
      */
     ofType: (input, criteria) => {
         return input.filter((e) => e.type === criteria.name);
@@ -277,7 +269,6 @@ const functions = {
      * about cardinality is violated at run-time.
      *
      * See: https://hl7.org/fhirpath/#single-collection
-     *
      * @param input The input collection.
      * @returns The single item in the input if there is just one item.
      */
@@ -292,7 +283,6 @@ const functions = {
      * This function is equivalent to item[0], so it will return an empty collection if the input collection has no items.
      *
      * See: https://hl7.org/fhirpath/#first-collection
-     *
      * @param input The input collection.
      * @returns A collection containing only the first item in the input collection.
      */
@@ -304,7 +294,6 @@ const functions = {
      * Will return an empty collection if the input collection has no items.
      *
      * See: https://hl7.org/fhirpath/#last-collection
-     *
      * @param input The input collection.
      * @returns A collection containing only the last item in the input collection.
      */
@@ -316,7 +305,6 @@ const functions = {
      * Will return an empty collection if the input collection has no items, or only one item.
      *
      * See: https://hl7.org/fhirpath/#tail-collection
-     *
      * @param input The input collection.
      * @returns A collection containing all but the first item in the input collection.
      */
@@ -330,8 +318,8 @@ const functions = {
      * If num is less than or equal to zero, the input collection is simply returned.
      *
      * See: https://hl7.org/fhirpath/#skipnum-integer-collection
-     *
      * @param input The input collection.
+     * @param num The atom representing the number of elements to skip.
      * @returns A collection containing all but the first item in the input collection.
      */
     skip: (input, num) => {
@@ -354,8 +342,8 @@ const functions = {
      * take returns an empty collection.
      *
      * See: https://hl7.org/fhirpath/#takenum-integer-collection
-     *
      * @param input The input collection.
+     * @param num The atom representing the number of elements to take.
      * @returns A collection containing the first num items in the input collection.
      */
     take: (input, num) => {
@@ -377,6 +365,9 @@ const functions = {
      * Order of items is not guaranteed to be preserved in the result of this function.
      *
      * See: http://hl7.org/fhirpath/#intersectother-collection-collection
+     * @param input The input collection.
+     * @param other The atom representing the collection of elements to intersect.
+     * @returns A collection containing the elements that are in both collections.
      */
     intersect: (input, other) => {
         if (!other) {
@@ -398,6 +389,9 @@ const functions = {
      * e.g. (1 | 2 | 3).exclude(2) returns (1 | 3).
      *
      * See: http://hl7.org/fhirpath/#excludeother-collection-collection
+     * @param input The input collection.
+     * @param other The atom representing the collection of elements to exclude.
+     * @returns A collection containing the elements that are in the input collection but not the other collection.
      */
     exclude: (input, other) => {
         if (!other) {
@@ -425,6 +419,9 @@ const functions = {
      * In other words, this function returns the distinct list of elements from both inputs.
      *
      * See: http://hl7.org/fhirpath/#unionother-collection
+     * @param input The input collection.
+     * @param other The atom representing the collection of elements to merge.
+     * @returns A collection containing the elements that represent the union of both collections.
      */
     union: (input, other) => {
         if (!other) {
@@ -441,6 +438,9 @@ const functions = {
      * There is no expectation of order in the resulting collection.
      *
      * See: http://hl7.org/fhirpath/#combineother-collection-collection
+     * @param input The input collection.
+     * @param other The atom representing the collection of elements to merge.
+     * @returns A collection containing the elements that represent the combination of both collections including duplicates.
      */
     combine: (input, other) => {
         if (!other) {
@@ -469,12 +469,11 @@ const functions = {
      * true-result should only be evaluated if the criterion evaluates to true,
      * and otherwise-result should only be evaluated otherwise. For implementations,
      * this means delaying evaluation of the arguments.
-     *
-     * @param input
-     * @param criterion
-     * @param trueResult
-     * @param otherwiseResult
-     * @returns
+     * @param input The input collection.
+     * @param criterion The atom representing the conditional.
+     * @param trueResult The atom to be used if the conditional evaluates to true.
+     * @param otherwiseResult Optional atom to be used if the conditional evaluates to false.
+     * @returns The result of the iif function.
      */
     iif: (input, criterion, trueResult, otherwiseResult) => {
         const evalResult = criterion.eval(input);
@@ -501,9 +500,8 @@ const functions = {
      * If the item is not one the above types, or the item is a String, Integer, or Decimal, but is not equal to one of the possible values convertible to a Boolean, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#toboolean-boolean
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns The input converted to boolean value.
      */
     toBoolean: (input) => {
         if (input.length === 0) {
@@ -545,9 +543,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: http://hl7.org/fhirpath/#convertstoboolean-boolean
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns True if the input can be converted to boolean.
      */
     convertsToBoolean: (input) => {
         if (input.length === 0) {
@@ -572,7 +569,6 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#tointeger-integer
-     *
      * @param input The input collection.
      * @returns The string representation of the input.
      */
@@ -606,9 +602,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#convertstointeger-boolean
-     *
      * @param input The input collection.
-     * @returns
+     * @returns True if the input can be converted to an integer.
      */
     convertsToInteger: (input) => {
         if (input.length === 0) {
@@ -631,6 +626,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#todate-date
+     * @param input The input collection.
+     * @returns The value converted to a date if possible; otherwise empty array.
      */
     toDate: (input) => {
         if (input.length === 0) {
@@ -657,6 +654,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#convertstodate-boolean
+     * @param input The input collection.
+     * @returns True if the item can be converted to a date.
      */
     convertsToDate: (input) => {
         if (input.length === 0) {
@@ -665,26 +664,25 @@ const functions = {
         return booleanToTypedValue(functions.toDate(input).length === 1);
     },
     /**
-   * If the input collection contains a single item, this function will return a single datetime if:
-   *   1) the item is a DateTime
-   *   2) the item is a Date, in which case the result is a DateTime with the year, month, and day of the Date, and the time components empty (not set to zero)
-   *   3) the item is a String and is convertible to a DateTime
-   *
-   * If the item is not one of the above types, the result is empty.
-   *
-   * If the item is a String, but the string is not convertible to a DateTime (using the format YYYY-MM-DDThh:mm:ss.fff(+|-)hh:mm), the result is empty.
-   *
-   * If the item contains a partial datetime (e.g. '2012-01-01T10:00'), the result is a partial datetime.
-   *
-   * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
-   *
-   * If the input collection is empty, the result is empty.
-  
-   * See: https://hl7.org/fhirpath/#todatetime-datetime
-   *
-   * @param input
-   * @returns
-   */
+     * If the input collection contains a single item, this function will return a single datetime if:
+     *   1) the item is a DateTime
+     *   2) the item is a Date, in which case the result is a DateTime with the year, month, and day of the Date, and the time components empty (not set to zero)
+     *   3) the item is a String and is convertible to a DateTime
+     *
+     * If the item is not one of the above types, the result is empty.
+     *
+     * If the item is a String, but the string is not convertible to a DateTime (using the format YYYY-MM-DDThh:mm:ss.fff(+|-)hh:mm), the result is empty.
+     *
+     * If the item contains a partial datetime (e.g. '2012-01-01T10:00'), the result is a partial datetime.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * See: https://hl7.org/fhirpath/#todatetime-datetime
+     * @param input The input collection.
+     * @returns The value converted to a dateTime if possible; otherwise empty array.
+     */
     toDateTime: (input) => {
         if (input.length === 0) {
             return [];
@@ -708,9 +706,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#convertstodatetime-boolean
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns True if the item can be converted to a dateTime.
      */
     convertsToDateTime: (input) => {
         if (input.length === 0) {
@@ -732,9 +729,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#decimal-conversion-functions
-     *
      * @param input The input collection.
-     * @returns
+     * @returns The value converted to a decimal if possible; otherwise empty array.
      */
     toDecimal: (input) => {
         if (input.length === 0) {
@@ -753,22 +749,21 @@ const functions = {
         return [];
     },
     /**
-   * If the input collection contains a single item, this function will true if:
-   *   1) the item is an Integer or Decimal
-   *   2) the item is a String and is convertible to a Decimal
-   *   3) the item is a Boolean
-   *
-   * If the item is not one of the above types, or is not convertible to a Decimal (using the regex format (\\+|-)?\d+(\.\d+)?), the result is false.
-   *
-   * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
-   *
-   * If the input collection is empty, the result is empty.
-  
-   * See: https://hl7.org/fhirpath/#convertstodecimal-boolean
-   *
-   * @param input The input collection.
-   * @returns
-   */
+     * If the input collection contains a single item, this function will true if:
+     *   1) the item is an Integer or Decimal
+     *   2) the item is a String and is convertible to a Decimal
+     *   3) the item is a Boolean
+     *
+     * If the item is not one of the above types, or is not convertible to a Decimal (using the regex format (\\+|-)?\d+(\.\d+)?), the result is false.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * See: https://hl7.org/fhirpath/#convertstodecimal-boolean
+     * @param input The input collection.
+     * @returns True if the item can be converted to a decimal.
+     */
     convertsToDecimal: (input) => {
         if (input.length === 0) {
             return [];
@@ -785,9 +780,8 @@ const functions = {
      * If the item is not one of the above types, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#quantity-conversion-functions
-     *
      * @param input The input collection.
-     * @returns
+     * @returns The value converted to a quantity if possible; otherwise empty array.
      */
     toQuantity: (input) => {
         if (input.length === 0) {
@@ -827,9 +821,8 @@ const functions = {
      * If the unit argument is provided, it must be the string representation of a UCUM code (or a FHIRPath calendar duration keyword), and is used to determine whether the input quantity can be converted to the given unit, according to the unit conversion rules specified by UCUM. If the input quantity can be converted, the result is true, otherwise, the result is false.
      *
      * See: https://hl7.org/fhirpath/#convertstoquantityunit-string-boolean
-     *
      * @param input The input collection.
-     * @returns
+     * @returns True if the item can be converted to a quantity.
      */
     convertsToQuantity: (input) => {
         if (input.length === 0) {
@@ -849,7 +842,6 @@ const functions = {
      * If the item is not one of the above types, the result is false.
      *
      * See: https://hl7.org/fhirpath/#tostring-string
-     *
      * @param input The input collection.
      * @returns The string representation of the input.
      */
@@ -882,9 +874,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#tostring-string
-     *
      * @param input The input collection.
-     * @returns
+     * @returns True if the item can be converted to a string
      */
     convertsToString: (input) => {
         if (input.length === 0) {
@@ -908,9 +899,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#totime-time
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns The value converted to a time if possible; otherwise empty array.
      */
     toTime: (input) => {
         if (input.length === 0) {
@@ -937,9 +927,8 @@ const functions = {
      * If the input collection is empty, the result is empty.
      *
      * See: https://hl7.org/fhirpath/#convertstotime-boolean
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns True if the item can be converted to a time.
      */
     convertsToTime: (input) => {
         if (input.length === 0) {
@@ -962,12 +951,12 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#indexofsubstring-string-integer
-     *
      * @param input The input collection.
+     * @param searchStringAtom The substring to search for.
      * @returns The index of the substring.
      */
-    indexOf: (input, substringAtom) => {
-        return applyStringFunc((str, substring) => str.indexOf(substring), input, substringAtom);
+    indexOf: (input, searchStringAtom) => {
+        return applyStringFunc((str, substring) => str.indexOf(substring), input, searchStringAtom);
     },
     /**
      * Returns the part of the string starting at position start (zero-based). If length is given, will return at most length number of characters from the input string.
@@ -979,9 +968,10 @@ const functions = {
      * If an empty length is provided, the behavior is the same as if length had not been provided.
      *
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
-     *
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param startAtom The start index atom.
+     * @param lengthAtom Optional length atom.
+     * @returns The substring.
      */
     substring: (input, startAtom, lengthAtom) => {
         return applyStringFunc((str, start, length) => {
@@ -991,71 +981,134 @@ const functions = {
         }, input, startAtom, lengthAtom);
     },
     /**
+     * Returns true when the input string starts with the given prefix.
      *
+     * If prefix is the empty string (''), the result is true.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * See: https://hl7.org/fhirpath/#startswithprefix-string-boolean
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param prefixAtom The prefix substring to test.
+     * @returns True if the input string starts with the given prefix string.
      */
     startsWith: (input, prefixAtom) => {
         return applyStringFunc((str, prefix) => str.startsWith(prefix), input, prefixAtom);
     },
     /**
+     * Returns true when the input string ends with the given suffix.
+     *
+     * If suffix is the empty string (''), the result is true.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
+     * See: https://hl7.org/fhirpath/#endswithsuffix-string-boolean
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param suffixAtom The suffix substring to test.
+     * @returns True if the input string ends with the given suffix string.
      */
     endsWith: (input, suffixAtom) => {
         return applyStringFunc((str, suffix) => str.endsWith(suffix), input, suffixAtom);
     },
     /**
+     * Returns true when the given substring is a substring of the input string.
+     *
+     * If substring is the empty string (''), the result is true.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
+     * See: https://hl7.org/fhirpath/#containssubstring-string-boolean
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param substringAtom The substring to test.
+     * @returns True if the input string contains the given substring.
      */
     contains: (input, substringAtom) => {
         return applyStringFunc((str, substring) => str.includes(substring), input, substringAtom);
     },
     /**
+     * Returns the input string with all characters converted to upper case.
+     *
+     * If the input collection is empty, the result is empty.
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
+     * See: https://hl7.org/fhirpath/#upper-string
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @returns The string converted to upper case.
      */
     upper: (input) => {
         return applyStringFunc((str) => str.toUpperCase(), input);
     },
     /**
+     * Returns the input string with all characters converted to lower case.
+     *
+     * If the input collection is empty, the result is empty.
      *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * See: https://hl7.org/fhirpath/#lower-string
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @returns The string converted to lower case.
      */
     lower: (input) => {
         return applyStringFunc((str) => str.toLowerCase(), input);
     },
     /**
+     * Returns the input string with all instances of pattern replaced with substitution. If the substitution is the empty string (''),
+     * instances of pattern are removed from the result. If pattern is the empty string (''), every character in the input string is
+     * surrounded by the substitution, e.g. 'abc'.replace('','x') becomes 'xaxbxcx'.
      *
+     * If the input collection, pattern, or substitution are empty, the result is empty ({ }).
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * See: https://hl7.org/fhirpath/#replacepattern-string-substitution-string-string
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param patternAtom The pattern to search for.
+     * @param substitionAtom The substition to replace with.
+     * @returns The string with all instances of the search pattern replaced with the substitution string.
      */
     replace: (input, patternAtom, substitionAtom) => {
         return applyStringFunc((str, pattern, substition) => str.replaceAll(pattern, substition), input, patternAtom, substitionAtom);
     },
     /**
+     * Returns true when the value matches the given regular expression. Regular expressions should function consistently, regardless of any culture- and locale-specific settings in the environment, should be case-sensitive, use 'single line' mode and allow Unicode characters.
      *
+     * If the input collection or regex are empty, the result is empty ({ }).
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
+     *
+     * See: https://hl7.org/fhirpath/#matchesregex-string-boolean
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param regexAtom The regular expression atom.
+     * @returns True if the input string matches the given regular expression.
      */
     matches: (input, regexAtom) => {
         return applyStringFunc((str, regex) => !!str.match(regex), input, regexAtom);
     },
     /**
+     * Matches the input using the regular expression in regex and replaces each match with the substitution string. The substitution may refer to identified match groups in the regular expression.
+     *
+     * If the input collection, regex, or substitution are empty, the result is empty ({ }).
+     *
+     * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
+     * See: https://hl7.org/fhirpath/#replacematchesregex-string-substitution-string-string
      * @param input The input collection.
-     * @returns The index of the substring.
+     * @param regexAtom The regular expression atom.
+     * @param substitionAtom The substition to replace with.
+     * @returns The string with all instances of the search pattern replaced with the substitution string.
      */
     replaceMatches: (input, regexAtom, substitionAtom) => {
         return applyStringFunc((str, pattern, substition) => str.replaceAll(pattern, substition), input, regexAtom, substitionAtom);
     },
     /**
-     *
      * @param input The input collection.
      * @returns The index of the substring.
      */
@@ -1066,8 +1119,8 @@ const functions = {
      * Returns the list of characters in the input string. If the input collection is empty ({ }), the result is empty.
      *
      * See: https://hl7.org/fhirpath/#tochars-collection
-     *
      * @param input The input collection.
+     * @returns Array of characters.
      */
     toChars: (input) => {
         return applyStringFunc((str) => (str ? str.split('') : undefined), input);
@@ -1083,7 +1136,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#abs-integer-decimal-quantity
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1098,7 +1150,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#ceiling-integer
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1115,7 +1166,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#exp-decimal
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1130,7 +1180,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#floor-integer
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1147,7 +1196,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#ln-decimal
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1166,8 +1214,8 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#logbase-decimal-decimal
-     *
      * @param input The input collection.
+     * @param baseAtom The logarithm base.
      * @returns A collection containing the result.
      */
     log: (input, baseAtom) => {
@@ -1183,8 +1231,8 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#powerexponent-integer-decimal-integer-decimal
-     *
      * @param input The input collection.
+     * @param expAtom The exponent power.
      * @returns A collection containing the result.
      */
     power: (input, expAtom) => {
@@ -1202,7 +1250,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#roundprecision-integer-decimal
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1221,7 +1268,6 @@ const functions = {
      * Note that this function is equivalent to raising a number of the power of 0.5 using the power() function.
      *
      * See: https://hl7.org/fhirpath/#sqrt-decimal
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1236,7 +1282,6 @@ const functions = {
      * If the input collection contains multiple items, the evaluation of the expression will end and signal an error to the calling environment.
      *
      * See: https://hl7.org/fhirpath/#truncate-integer
-     *
      * @param input The input collection.
      * @returns A collection containing the result.
      */
@@ -1262,9 +1307,9 @@ const functions = {
      * function unchanged.
      *
      * See: https://hl7.org/fhirpath/#tracename-string-projection-expression-collection
-     *
      * @param input The input collection.
      * @param nameAtom The log name.
+     * @returns The input collection.
      */
     trace: (input, nameAtom) => {
         console.log('trace', input, nameAtom);
@@ -1274,6 +1319,7 @@ const functions = {
      * Returns the current date and time, including timezone offset.
      *
      * See: https://hl7.org/fhirpath/#now-datetime
+     * @returns The current dateTime.
      */
     now: () => {
         return [{ type: PropertyType.dateTime, value: new Date().toISOString() }];
@@ -1282,6 +1328,7 @@ const functions = {
      * Returns the current time.
      *
      * See: https://hl7.org/fhirpath/#timeofday-time
+     * @returns The current time string.
      */
     timeOfDay: () => {
         return [{ type: PropertyType.time, value: new Date().toISOString().substring(11) }];
@@ -1290,6 +1337,7 @@ const functions = {
      * Returns the current date.
      *
      * See: https://hl7.org/fhirpath/#today-date
+     * @returns The current date string.
      */
     today: () => {
         return [{ type: PropertyType.date, value: new Date().toISOString().substring(0, 10) }];
@@ -1301,6 +1349,11 @@ const functions = {
      *
      * IBM FHIR issue: https://github.com/IBM/FHIR/issues/1014
      * IBM FHIR PR: https://github.com/IBM/FHIR/pull/1023
+     * @param input The input collection.
+     * @param startAtom The start date/time.
+     * @param endAtom The end date/time.
+     * @param unitsAtom Which units to return ("years", "months", or "days").
+     * @returns The Quantity of time between the two dates.
      */
     between: (input, startAtom, endAtom, unitsAtom) => {
         const startDate = functions.toDateTime(startAtom.eval(input));
@@ -1329,10 +1382,9 @@ const functions = {
      * For implementations with compile-time typing, this requires special-case
      * handling when processing the argument to treat it as a type specifier rather
      * than an identifier expression:
-     *
-     * @param input
-     * @param typeAtom
-     * @returns
+     * @param input The input collection.
+     * @param typeAtom The desired type.
+     * @returns True if the input element is of the desired type.
      */
     is: (input, typeAtom) => {
         let typeName = '';
@@ -1354,9 +1406,8 @@ const functions = {
      * 6.5.3. not() : Boolean
      *
      * Returns true if the input collection evaluates to false, and false if it evaluates to true. Otherwise, the result is empty ({ }):
-     *
-     * @param input
-     * @returns
+     * @param input The input collection.
+     * @returns True if the input evaluates to false.
      */
     not: (input) => {
         return functions.toBoolean(input).map((value) => ({ type: PropertyType.boolean, value: !value.value }));
@@ -1369,7 +1420,7 @@ const functions = {
      * For each item in the collection, if it is a string that is a uri (or canonical or url), locate the target of the reference, and add it to the resulting collection. If the item does not resolve to a resource, the item is ignored and nothing is added to the output collection.
      * The items in the collection may also represent a Reference, in which case the Reference.reference is resolved.
      * @param input The input collection.
-     * @returns
+     * @returns The resolved resource.
      */
     resolve: (input) => {
         return input
@@ -1424,9 +1475,8 @@ const functions = {
      * https://hl7.org/fhirpath/modelinfo.xsd
      *
      * See: https://hl7.org/fhirpath/#model-information
-     *
      * @param input The input collection.
-     * @returns
+     * @returns The type of the input value.
      */
     type: (input) => {
         return input.map(({ value }) => {