Merge branch 'feature/LF-2667/implement-getValue' into 'master'

Implement getValue

See merge request lfor/fhirpath.js!27

Author: yuriy-sedinkin

CHANGELOG.md

@@ -3,6 +3,10 @@
 This log documents significant changes for each release.  This project follows
 [Semantic Versioning](http://semver.org/).
 
+## [3.17.0] - 2025-02-03
+### Added
+- getValue() function.
+
 ## [3.16.4] - 2025-01-24
 ### Fixed
 - Bug where single-quoted variable names were not supported.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "fhirpath",
-  "version": "3.16.4",
+  "version": "3.17.0",
   "description": "A FHIRPath engine",
   "main": "src/fhirpath.js",
   "types": "src/fhirpath.d.ts",

package.json

@@ -115,8 +115,8 @@ engine.invocationTable = {
   toTime:       {fn: misc.toTime},
   toBoolean:    {fn: misc.toBoolean},
   toQuantity:   {fn: misc.toQuantity, arity: {0: [], 1: ["String"]}},
-  // TODO: The hasValue function should be taken into account in a separate request
   hasValue:     {fn: misc.hasValueFn},
+  getValue:     {fn: misc.getValueFn},
   convertsToBoolean:    {fn: misc.createConvertsToFn(misc.toBoolean, 'boolean')},
   convertsToInteger:    {fn: misc.createConvertsToFn(misc.toInteger, 'number')},
   convertsToDecimal:    {fn: misc.createConvertsToFn(misc.toDecimal, 'number')},

src/fhirpath.js

@@ -340,4 +340,24 @@ engine.hasValueFn = function(coll) {
     && TypeInfo.isPrimitive(TypeInfo.fromValue(coll[0]));
 };
 
+/**
+ * Returns the underlying system value for the FHIR primitive if the input
+ * collection contains a single value which is a FHIR primitive, and it has a
+ * primitive value. Otherwise, the return value is empty (i.e. []).
+ *
+ * See: https://hl7.org/fhir/fhirpath.html#functions
+ * @param {Array<*>} coll - input collection
+ * @returns {*|[]}
+ */
+engine.getValueFn = function(coll) {
+  if (coll.length === 1) {
+    const node = coll[0];
+    const v = util.valData(node);
+    if (v != null && TypeInfo.isPrimitive(TypeInfo.fromValue(node))) {
+      return v;
+    }
+  }
+  return [];
+};
+
 module.exports = engine;

src/misc.js

@@ -0,0 +1,89 @@
+tests:
+  - 'group: no model specified':
+    - desc: 'collection only contains one string'
+      inputfile: patient-example.json
+      expression: Patient.name.given[0].getValue()
+      result: ['Peter']
+
+    - desc: 'collection contains array of strings'
+      inputfile: patient-example.json
+      expression: Patient.name.given.getValue()
+      result: []
+
+    - desc: 'collection contains object'
+      inputfile: patient-example.json
+      expression: Patient.name.getValue()
+      result: []
+
+    - desc: 'collection only contains an element without a value but with an extension'
+      inputfile: patient-example-3.json
+      expression: Patient.birthDate.getValue()
+      result: []
+
+    - desc: 'collection only contains an element of a non-FHIR primitive type'
+      expression: >-
+        '5'.getValue()
+      result: ['5']
+
+  - 'group: model specified':
+      - desc: 'collection only contains one non-primitive'
+        inputfile: patient-example.json
+        expression: Patient.identifier.getValue()
+        model: r4
+        result: []
+
+      - desc: 'collection only contains one string'
+        inputfile: patient-example.json
+        expression: Patient.name.given[0].getValue()
+        model: 'r5'
+        result: ['Peter']
+      - desc: 'collection contains array of strings'
+        inputfile: patient-example.json
+        expression: Patient.name.given.getValue()
+        model: 'r5'
+        result: []
+
+      - desc: 'collection only contains one string'
+        inputfile: patient-example.json
+        expression: Patient.name.given[0].getValue()
+        model: 'r4'
+        result: ['Peter']
+      - desc: 'collection contains array of strings'
+        inputfile: patient-example.json
+        expression: Patient.name.given.getValue()
+        model: 'r4'
+        result: []
+
+      - desc: 'collection only contains one string'
+        inputfile: patient-example.json
+        expression: Patient.name.given[0].getValue()
+        model: 'stu3'
+        result: ['Peter']
+      - desc: 'collection contains array of strings'
+        inputfile: patient-example.json
+        expression: Patient.name.given.getValue()
+        model: 'stu3'
+        result: []
+
+      - desc: 'collection only contains one string'
+        inputfile: patient-example.json
+        expression: Patient.name.given[0].getValue()
+        model: 'dstu2'
+        result: ['Peter']
+      - desc: 'collection contains array of strings'
+        inputfile: patient-example.json
+        expression: Patient.name.given.getValue()
+        model: 'dstu2'
+        result: []
+
+      - desc: 'collection only contains an element without a value but with an extension'
+        inputfile: patient-example-3.json
+        expression: Patient.birthDate.getValue()
+        model: 'r4'
+        result: []
+
+      - desc: 'collection only contains an element of a non-FHIR primitive type'
+        expression: >-
+          '5'.getValue()
+        model: 'r4'
+        result: ['5']

test/cases/getValue.yaml

@@ -5,12 +5,6 @@ tests:
       expression: Patient.name.given[0].hasValue()
       result: [true]
 
-    - desc: 'collection only contains one non-primitive'
-      inputfile: patient-example.json
-      expression: Patient.identifier.hasValue()
-      model: r4
-      result: [false]
-
     - desc: 'collection contains array of strings'
       inputfile: patient-example.json
       expression: Patient.name.given.hasValue()
@@ -32,6 +26,12 @@ tests:
       result: [true]
 
   - 'group: model specified':
+    - desc: 'collection only contains one non-primitive'
+      inputfile: patient-example.json
+      expression: Patient.identifier.hasValue()
+      model: r4
+      result: [false]
+
     - desc: 'collection only contains one string'
       inputfile: patient-example.json
       expression: Patient.name.given[0].hasValue()