This log documents significant changes for each release. This project follows Semantic Versioning.
- Removed the need to run
(cd demo && npm ci). - Excluded unnecessary files from the npm package.
- Return data type for
evaluateandcompilein TypeScript type declarations. The return data type now depends on theasyncoption.
- option
async, which allows us to get the result of an expression evaluation asynchronously. - Support for asynchronous functions: if any function in an expression returns
a Promise and option
async=true, then the result of evaluating the expression is a Promise. - async function
memberOf.
- impossibility to use attribute name that starts with a capital letter.
- supplementary function
weight()with alternative nameordinal().
- a bug that could cause the context input parameter containing environment variables to change.
- Added separate TypeScript type definition files for the main file and each supported model.
- an issue with evaluating an expression for a resource passed through an environment variable.
- an issue with "statusShift" during performance tests.
- Added flag 'u' for regular expressions in the specification's
matchesandreplaceMatchesfunctions to support the use of unicode character class escapes.
- Function
defineVariable(name: String [, expr: expression]).
- Updated Cypress to version 13.
- Storing the FHIR data type along with the path in internal ResourceNode objects to improve the accuracy of determining a resource node data type.
- Missing entries to mapping paths to data types.
- Handling of empty values that came from nulls.
- hasValue() function previously only checked the data type of an input single-element collection, but not the existence of a value.
- Functions
as(<type specifier>),is(<type specifier>),ofType(<type specifier>)and operatorsas <type specifier>,is <type specifier>now throw an exception if<type specifier>is invalid. - Resource object properties that are not defined in the model now have System.* data types.
- All tests in
fhir-r4.yamlare executed using theR4model.
- children() and descendants() were returning resource nodes with the incorrect data types.
- Improved performance comparison task: added command line options and enabled Ctrl+C for stopping the tests.
- Support for comparison and math operations with Quantity values.
It also became possible to use Quantity values with
aggregate(),min(),max(),sum(),avg(), andabs(). - Unary
-for a Quantity value.
- Fixed exception in the "hashObject" internal function when an object has a property with the "null" value. This may affect functions that compare objects: intersect(), subsetOf(), repeat(), union(), distinct(), isDistinct().
- Null values are excluded from the expression evaluation result.
- Fixed an issue when evaluating an expression for a resource object with missed values at the end of the array in a property.
- Fixed an issue when evaluating an expression for a resource object when there are no values at all for a property, but there is a list of associated data (ids/extensions).
- support for user-defined functions.
- Use
deepEqualinstead ofhashObjectto optimize the comparison of items of small collections in these functions: intersect(), union(), exclude(), subsetOf(), distinct().
- support FHIR.instant in expressions.
- crash in
exists()when running in strict mode.
- exclude() function.
- trace() affected the context of the following subexpressions.
- hasValue() function.
- Add
splitandjoinfunctions - Add
encodeanddecodefunctions - Added a callback (traceFn) to the options object for the
tracefunction
- Update the typescript definition to mark context and model as optional
- Correct the
tracefunction's name parameter is required
- support for FHIR R5 publication.
- toQuantity() now works with subclasses of Quantity.
- Aggregate init parameter can be any type, not just an integer.
- An API method
typeswhich returns the type of each element in FHIRPath result array which was obtained fromevaluate()with optionresolveInternalTypes=false.
- The hidden (non-enumerable) property
__path__has been moved from the entire array of result values to each element of the array, because the result array may contain items of different types. - The type of
today()was defined asSystem.DateTime. Now it is defined asSystem.Date.
- Functions: toDate(), convertsToDate().
- Date/Time arithmetic to make this expression work:
Patient.birthDate + 1 day - Removed implicit string to date/time conversion during comparison.
- function "as(type)".
- operator "as".
- Support for data type hierarchy from FHIR specification for:
- functions "is(type)", "as(type)", and "ofType(type)",
- operators "is" and "as".
- Option
resolveInternalTypesto control whether any instances of internal data types (e.g. FP_DateTime, FP_Time, FP_Quantity) in a result of FHIRPath expression should be converted to standard JavaScript types. - Method
resolveInternalTypeswhich converts any instances of internal data types (e.g. FP_DateTime, FP_Time, FP_Quantity) in a result of FHIRPath expression evaluation to standard JavaScript types.
- By default, any instances of internal data types (e.g. FP_DateTime, FP_Time, FP_Quantity) in a result of FHIRPath expression are converted to strings.
- Fixed directly (without member invocation) accessing the value of a variable in the context if this value was fetched from a resource using fhirpath.js.
- FHIR Quantities are now only converted to System Quantities when necessary, so that FHIR Quantities can be returned from an expression, and so that the fields from a FHIR Quantity can be accessed.
- Version number to fhirpath.js demo page.
- "extension()" for primitive types did not work properly without a value.
- Suite of performance tests.
- Updated to NodeJS 16.
- Updated the antlr4 dependency to 4.9.3.
- Corrected scope of function parameter of
collectiontype forunion,subsetOf,supersetOf,combine, andintersect. For example,Patient.name.select(use.union(given))should be the same asPatient.name.select(use|given).
- Added a "version" field with the release version to the object exported by fhirpath.js.
- Previously, the
repeatfunction changed the contents of the%someVarvalue when used in a%someVar.repeat(...)expression. - Previously,
a.repeat('b')went into an infinite loop. - The
repeatfunction should no longer return duplicates. - Optimized functions:
distinct,union,subsetOf,intersect, andrepeatby changing complexity of the algorithm from O(n**2) to O(n).
- Function to get the intersection of two collections: intersect().
- The
distinct,union,subsetOf, andintersectfunctions now use the "6.1.1. = (Equals)" function to compare collection items instead of using a map with JSON keys, which can affect their performance because the complexity of the algorithm has changed from O(n) to O(n**2).
- Current time function: timeOfDay().
- FHIRPath extension functions: sum(), min(), max(), and avg().
- Division by 0 for
/,div, andmodoperators.
- Storing the path for the data extracted from the resource in a hidden
(non-enumerable) property
__path__. This allows the FHIR model to be applied to data extracted from the resource and used as a context variable. For example, you can use%thisItem.answerOption.value.where(code='LA19952-3')instead of%thisItem.answerOption.valueCoding.where(code='LA19952-3')
- Date/Time arithmetic: "@2016 + 365 days" should equal "@2017".
- toDecimal() function should return an empty collection for non-convertible string
- convertsToDecimal() function should return false for non-convertible string
- Some type definitions for TypeScript users.
- Function matches() didn't use "single line" mode ("." should match newlines)
- Additional function: extension()
- Support for "id" and "extension" properties for primitive types.
- String manipulation functions: upper(), lower(), toChars().
- String manipulation functions did not properly return an empty collection when the input collection is empty.
- Evaluation of singleton collections.
- Removed ignoring the unknown part of the expression.
- $this wasn't set correctly if it is not used in an operator expression
- It was unable to use $index in expressions for functions: all, where, select.
- Prevented the antlr4 dependency from moving beyond 4.8, because 4.9 has breaking changes. Also, per antlr/antlr4#2970, it seems that antlr 4.9 requires Node.js 14, so we do not plan to update the antlr dependency while Node.js 10 and 12 are still being maintained.
- Now, attempting to access an undefined environment variable will result in an error
- Evaluating expression for a part of a resource
- Comparison of dates indicated with different level of precision
- Module not found errors with TypeScript when importing json files inside module declaration (in an Angular project)
Limited support for types (see README.md for details):
- Function is(type) and operator "is"
- Function ofType(type)
- Function union(other: collection)
- Support for DSTU2 model
- Functions: toBoolean(), convertsToBoolean(), convertsToInteger(), convertsToDecimal(), convertsToString(), convertsToDateTime(), convertsToTime(), convertsToQuantity()
- toInteger() function should return an empty collection for non-convertible string
- toQuantity() function should work with the entire input string, not part of it (RegExp expression surrounded with ^...$)
- toQuantity() function should support boolean values
- toQuantity() function should not accept a string where UCUM unit code is not surrounded with single quotes
- The third parameter of iif function should be optional
- Updated FHIRPath test cases
- Issue with substring function without a second parameter
- Function aggregate(aggregator, init)
- Fixed issue with comparing dates (without time) in various time zones
- Added execution of tests for various time zones
- Using "Number.parseFloat" replaced with "parseFloat" for IE11
- Removed the need to exclude package "fs" when building
- ucum-lhc package updated to 4.1.3
- added polyfills required to run in IE
- Browser build fixed to work in IE 11
- Non-browser build removed
- Function toQuantity(unit)
- Operators =(equality) and ~(equivalence) for Quantity
- Implicit conversion from FHIR Quantity to FHIRPath System.Quantity
- FHIRPath grammar updated to version 2.0.0 (N1)
- ucum-lhc package updated to 4.1.1, which saves about 200k (uncompressed).
- Issues with the new choice type support raised in #34.
- Support for FHIR "choice types" (e.g. Observation.value). The support is currently limited to being able to specify paths like Observation.value (when the resource might actually contain Observation.valueString).
- Remove the deprecated "context" parameter from the "compile" function. The context should be passed into the function that "compile" returns. This breaking change is the reason for the major version number increment.
- Although one could add a Quantity to a date, subtracting the quantity resulted in an error.
- Fixed functions toDateTime() and toTime(), for the minified versions of the code.
- Fixed the compile API, so that the returned function now takes the "context" hash of environment variables as a second argument (after the resource data). Previously this context hash was passed into the compile function, not the returned function, which meant that the parsed expression could only be reused if the context variable hash was the same object.
- Removed Linux-specific commands from the build process.
- Updated packages for the demo to get patches for vulnerabilities.
- Set the charset of the test pages to UTF-8, because fhirpath.min.js is UTF-8, and added a note to the README about the need to set the character encoding.
- Support for adding time-based Quantities to DateTimes and Times. These changes included adding the ucum-lhc unit-conversion library, which has a large data file, but the data file compresses down to about 1/10th of its expanded size, so users are encouraged to gzip their JavaScript builds.
- The ucum-lhc instance is exported for convenience, as ucumUtils. See https://lhncbc.github.io/ucum-lhc/ for instructions if you want to use it.
- IE 10 compatibility issues were fixed (by "bpacJoseph")
- Updated packages for the demo to get patches for vulnerabilities.
- Quantity types can now be parsed, though arithmetic is not yet supported.
- Support for unary - and +.
- Math functions defined in paragraphs 5.7.1 - 5.7.4 and 5.7.7 - 5.7.10 of the FHIRPath specification.
- Functions ln() and log() in 5.7 (Math) of the FHIRPath specification.
- Corrected output in the demo website for results containing dates and times.
- Cleaned up the error message output for parsing errors.
- Updated links to the repository to point to the new location.
- Added support for string escape sequences (which was also needed for regex escapes).
- Support for DateTime and Time literals, along with equality, equivalence, and comparison operators.
- If a string is compared against a DateTime or Time, a check will be made to see whether the string is convertible to a DateTime or Time, and if that is possible the comparison will be made based on the result of that conversion.
- bin/fhirpath now works after npm install.
- Corrected the behavior of xor with an empty set.
- Variables referenced in expressions are now only wrapped in arrays if they are not already in an array.
- bin/fhirpath can now take a resource as a JSON string instead of a filename for the resource.
- Removed the postinstall script from package.json. It was added for development, but is also run when this package is installed by another, and was causing the installation to error out.
- The browser-ready build file (available on the "releases" tab of the GitHub repository) now exposes a "fhirpath" global variable, whereas previously it was trying to put that on a LForms object.
- Support for environment variables
- Issues with decimals and the ~ operator.
- Floating point arithemetic errors are now corrected prior to comparison.
- Support for "contains" and "in" operators
- Support for parentheses and null literals
- An option to the demo app for working with JSON rather than YAML.
- logical operations
- tree navigation
- string functions
- part of ofType (explicit one)
- Corrected the (outdated) main file entry in package.json.
- combine()
- union operator ("|")
- A problem with subsetOf (and supersetOf) that prevented objects with keys added in different orders from being considered the same.
- Tests for functions in 5.2 (except ofType), which is not yet implemented.
- Remaining functions in 5.1 (Existence) of the FHIRPath specification.
- Support for $this
- all/any True/False.
- Support for !~ and =~
- Reorgnanized math functions into a separate file.
- Revised internal routines so everything is handled as a collection.
- An unexpected (math) operator error that happened when the code was minimized.
- Handles all math operations defined in 6.6 of the FHIRPath specification.
- take, last, tail
- iif
- skip
- GitHub repository to package.json.
- Added beginning of a FHIRPath engine. There is name a script bin/fhirpath which will take a FHIRPath expression and a filename containing a JSON FHIR resource, and prints the result of the expression (for many basic expressions). Without the filename, it prints the parsed expression tree, which is what bin/parseAndDisplay.js used to do, so that has been removed.
- There is a now a parser and a small script (bin/parseAndDisplay.js) which prints out the parse tree of a FHIRPath expression.