lforms 29.3.0 → 33.2.0

package/app/scripts/fhir/STU3/sdc-import.js

@@ -1,494 +0,0 @@
-/**
- * A package to handle conversion from FHIR SDC (STU2) Questionnaire to LForms
- * STU2 Ballot:
- * http://hl7.org/fhir/us/sdc/sdc-questionnaire.html
- * http://hl7.org/fhir/us/sdc/sdc-questionnaireresponse.html
- *
- * It provides the following functions:
- * convertQuestionnaireToLForms()
- * -- Convert FHIR SDC QuestionnaireResponse data into corresponding LForms data
- * mergeQuestionnaireResponseToLForms()  (defined in sdc-import-common.js)
- * -- Merge FHIR SDC QuestionnaireResponse data into corresponding LForms data
- */
-function addSDCImportFns(ns) {
-"use strict";
-
-  var self = ns;
-
-  self.fhirExtUrlOptionScore = "http://hl7.org/fhir/StructureDefinition/questionnaire-ordinalValue";
-  self.fhirExtUrlValueSetScore = "http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue";
-
-
-  /**
-   * Extract contained VS (if any) from the given questionnaire resource object.
-   * @param questionnaire the FHIR questionnaire resource object
-   * @return when there are contained value sets, returns a hash from "#<ValueSet.id>" (the character "#"
-   *         followed by the ValueSet id) to the answers options object, which, in turn, is a hash with 4 entries:
-   *         - "answers" is the list of LF answers converted from the value set.
-   *         - "systems" is the list of code systems for each answer item; and
-   *         returns undefined if no contained value set is present.
-   * @private
-   */
-  self._extractContainedVS = function (questionnaire) {
-    var answersVS;
-
-    if(questionnaire.contained && questionnaire.contained.length > 0) {
-      answersVS = {};
-      questionnaire.contained.forEach(function(vs) {
-        if(vs.resourceType === 'ValueSet' && vs.expansion && vs.expansion.contains && vs.expansion.contains.length > 0) {
-          var answers = self.answersFromVS(vs);
-          if (!answers)
-            answers = []; // continuing with previous default; not sure if needed
-
-          // support both id and url based lookup. STU3 reference is quite vague.
-          var lfVS = {answers: answers};
-          if(vs.id) {
-            answersVS['#' + vs.id] = lfVS;
-          }
-          if(vs.url) {
-            answersVS[vs.url] = lfVS;
-          }
-        }
-      });
-    }
-
-    return answersVS;
-  };
-
-  /**
-   * Process questionnaire item recursively
-   *
-   * @param qItem - item object as defined in FHIR Questionnaire.
-   * @param linkIdItemMap - Map of items from link ID to item from the imported resource.
-   * @param containedVS - contained ValueSet info, see _extractContainedVS() for data format details
-   * @returns {{}} - Converted 'item' field object as defined by LForms definition.
-   * @private
-   */
-  self._processQuestionnaireItem = function (qItem, containedVS, linkIdItemMap) {
-
-    var targetItem = {};
-    //A lot of parsing depends on data type. Extract it first.
-    self._processDataType(targetItem, qItem);
-    self._processTextAndPrefix(targetItem, qItem);
-    self._processCodeAndLinkId(targetItem, qItem);
-    _processDisplayItemCode(targetItem, qItem);
-    _processEditable(targetItem, qItem);
-    self._processFHIRQuestionAndAnswerCardinality(targetItem, qItem);
-    self._processDisplayControl(targetItem, qItem);
-    self._processDataControl(targetItem, qItem);
-    self._processRestrictions(targetItem, qItem);
-    self._processHiddenItem(targetItem, qItem);
-    self._processUnitList(targetItem, qItem);
-    _processAnswers(targetItem, qItem, containedVS);
-    self._processDefaultAnswer(targetItem, qItem);
-    _processExternallyDefined(targetItem, qItem);
-    self._processTerminologyServer(targetItem, qItem);
-    _processSkipLogic(targetItem, qItem, linkIdItemMap);
-    self._processExtensions(targetItem, qItem);
-    self._processChildItems(targetItem, qItem, containedVS, linkIdItemMap);
-
-    return targetItem;
-  };
-
-
-  /**
-   * Parse questionnaire object for answer cardinality
-   *
-   * @param lfItem {object} - LForms item object to assign answer cardinality
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   */
-  function _processAnswerCardinality(lfItem, qItem) {
-    if(qItem.required) {
-      lfItem.answerCardinality = {min: '1'};
-    }
-    else {
-      lfItem.answerCardinality = {min: '0'};
-    }
-
-    var answerRepeats = LForms.Util.findObjectInArray(qItem.extension, 'url', self.fhirExtUrlAnswerRepeats);
-    if(answerRepeats && answerRepeats.valueBoolean) {
-      lfItem.answerCardinality.max = '*';
-    }
-    else {
-      lfItem.answerCardinality.max = '1';
-    }
-  }
-
-
-  /**
-   * Parse questionnaire object for skip logic information
-   *
-   * @param lfItem {object} - LForms item object to assign the skip logic
-   * @param qItem {object} - Questionnaire item object
-   * @param sourceQuestionnaire - Questionnaire resource object. This is to provide top level
-   *                              item to navigate the tree for skip logic source items.
-   * @private
-   */
-  function _processSkipLogic(lfItem, qItem, linkIdItemMap) {
-    if(qItem.enableWhen) {
-      lfItem.skipLogic = {conditions: [], action: 'show'};
-      for(var i = 0; i < qItem.enableWhen.length; i++) {
-
-        var dataType = self._getDataType(linkIdItemMap[qItem.enableWhen[i].question]);
-        var condition = {source: qItem.enableWhen[i].question};
-        if(qItem.enableWhen[i].hasOwnProperty('hasAnswer')) {
-          condition.trigger = {exists: qItem.enableWhen[i].hasAnswer};
-        }
-        else {
-          var answer = self._getFHIRValueWithPrefixKey(qItem.enableWhen[i], /^answer/);
-          if(dataType === 'CWE' || dataType === 'CNE') {
-            condition.trigger = {value: self._copyTriggerCoding(answer, null, false)};
-          }
-          else if(dataType === 'QTY') {
-            condition.trigger = {value: answer.value};
-          }
-          else {
-            condition.trigger = {value: answer};
-          }
-        }
-        lfItem.skipLogic.conditions.push(condition);
-      }
-    }
-  }
-
-
-  /**
-   * Parse Questionnaire item for externallyDefined url
-   *
-   * @param lfItem - LForms item object to assign externallyDefined
-   * @param qItem - Questionnaire item object
-   * @private
-   */
-  function _processExternallyDefined(lfItem, qItem) {
-    var externallyDefined = LForms.Util.findObjectInArray(qItem.extension, 'url', self.fhirExtUrlExternallyDefined);
-    if (externallyDefined && externallyDefined.valueUri) {
-      lfItem.externallyDefined = externallyDefined.valueUri;
-    }
-  }
-
-
-  /**
-   * Parse questionnaire item for "hidden" extension
-   *
-   * @param lfItem {object} - LForms item object to be assigned the _isHiddenInDef flag if the item is to be hidden.
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   * @return true if the item is hidden or if its ancestor is hidden, false otherwise
-   */
-  self._processHiddenItem = function (lfItem, qItem) {
-    var ci = LForms.Util.findObjectInArray(qItem.extension, 'url', self.fhirExtUrlHidden);
-    if(ci) {
-      lfItem._isHiddenInDef = typeof ci.valueBoolean === 'boolean'? ci.valueBoolean: ci.valueBoolean === 'true';
-    }
-    return lfItem._isHiddenInDef;
-  };
-
-
-  /**
-   * Parse questionnaire item for answers list
-   *
-   * @param lfItem {object} - LForms item object to assign answer list
-   * @param qItem {object} - Questionnaire item object
-   * @param containedVS - contained ValueSet info, see _extractContainedVS() for data format details
-   * @private
-   */
-  function _processAnswers(lfItem, qItem, containedVS) {
-    if(qItem.option) {
-      lfItem.answers = [];
-      for(var i = 0; i < qItem.option.length; i++) {
-        var answer = {};
-        var option = qItem.option[i];
-        var label = LForms.Util.findObjectInArray(option.extension, 'url', self.fhirExtUrlOptionPrefix);
-        if(label) {
-          answer.label = label.valueString;
-        }
-        var score = LForms.Util.findObjectInArray(option.extension, 'url', self.fhirExtUrlOptionScore);
-        // Look for argonaut extension.
-        score = !score ? LForms.Util.findObjectInArray(option.extension, 'url', self.argonautExtUrlExtensionScore) : score;
-        if(score) {
-          answer.score = score.valueDecimal.toString();
-        }
-        var optionKey = Object.keys(option).filter(function(key) {return (key.indexOf('value') === 0);});
-        if(optionKey && optionKey.length > 0) {
-          if(optionKey[0] === 'valueCoding') { // Only one value[x] is expected
-            if(option[optionKey[0]].code    !== undefined) answer.code = option[optionKey[0]].code;
-            if(option[optionKey[0]].display !== undefined) answer.text = option[optionKey[0]].display;
-            // TBD- Lforms has answer code system at item level, expects all options to have one code system!
-            if(option[optionKey[0]].system  !== undefined) {
-              answer.system = option[optionKey[0]].system;
-            }
-          }
-          else {
-            answer.text = option[optionKey[0]].toString();
-          }
-        }
-
-        lfItem.answers.push(answer);
-      }
-    }
-    else if (qItem.options) {
-      if (containedVS)
-        var vs = containedVS[qItem.options.reference];
-      if(vs) {
-        lfItem.answers = vs.answers;
-      }
-      else
-        lfItem.answerValueSet = qItem.options.reference;
-    }
-  }
-
-
-
-  /**
-   * Parse questionnaire item for editable
-   *
-   * @param lfItem {object} - LForms item object to assign editable
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   */
-  function _processEditable(lfItem, qItem) {
-    if (qItem.readOnly) {
-      lfItem.editable = '0';
-    }
-  }
-
-
-  /**
-   * Parse questionnaire item for default answer
-   *
-   * @param lfItem {object} - LForms item object to assign default answer
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   */
-  self._processDefaultAnswer = function (lfItem, qItem) {
-
-    var val = LForms.Util.deepCopy(qItem.initialCoding);
-    if (val)
-      val._type = 'Coding';
-    else
-      val = self._getFHIRValueWithPrefixKey(qItem, /^initial/);
-    if (val) {
-      this._processFHIRValues(lfItem, [val], true);
-    }
-  };
-
-
-  /**
-   *  Returns the first initial quanitity for the given Questionnaire item, or
-   *  null if there isn't one.
-   */
-  self.getFirstInitialQuantity = function(qItem) {
-    return qItem.initialQuantity || null;
-  };
-
-
-  /**
-   * Parse 'linkId' for the LForms questionCode of a 'display' item, which does not have a 'code'
-   *
-   * @param lfItem {object} - LForms item object to assign questionCode
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   */
-  function _processDisplayItemCode(lfItem, qItem) {
-    if (qItem.type === "display" && qItem.linkId) {
-      var codes = qItem.linkId.split("/");
-      if (codes && codes[codes.length-1]) {
-        lfItem.questionCode = codes[codes.length-1];
-      }
-    }
-  }
-
-
-  /**
-   * Parse questionnaire item for data type
-   *
-   * @param lfItem {object} - LForms item object to assign data type
-   * @param qItem {object} - Questionnaire item object
-   * @private
-   */
-  self._processDataType = function (lfItem, qItem) {
-    var type = self._getDataType(qItem);
-    if(type === 'SECTION' || type === 'TITLE') {
-      lfItem.header = true;
-    }
-    lfItem.dataType = type;
-  };
-
-
-
-  // QuesitonnaireResponse Import
-  self._mergeQR = {
-
-    /**
-     * Get structure information of a QuestionnaireResponse instance
-     * @param qr a QuestionnaireResponse instance
-     * @returns {{}} a QuestionnaireResponse data structure object
-     * @private
-     */
-    _getQRStructure : function(qr) {
-      var qrInfo = {
-        qrItemsInfo: []
-      };
-      if (qr) {
-        this._checkQRItems(qrInfo, qr);
-      }
-      return qrInfo;
-    },
-
-
-    /**
-     * Get structural info of a QuestionnaireResponse by going though each level of items
-     * @param parentQRItemInfo the structural info of a parent item
-     * @param parentItem a parent item in a QuestionnaireResponse object
-     * @private
-     */
-    _checkQRItems : function(parentQRItemInfo, parentQRItem) {
-
-      var qrItemsInfo = [];
-      var repeatingItemProcessed = {};
-
-      if (parentQRItem && parentQRItem.item) {
-        for (var i=0, iLen=parentQRItem.item.length; i<iLen; i++) {
-          var item = parentQRItem.item[i];
-          var linkId = item.linkId; //code is not necessary included in linkId
-          // first item that has the same code, either repeating or non-repeating
-          if (!repeatingItemProcessed[linkId]) {
-            var repeatingInfo = this._findTotalRepeatingNum(linkId, parentQRItem);
-
-            // create structure info for the item
-            var repeatingItems = repeatingInfo.repeatingItems;
-            for (var j=0, jLen=repeatingItems.length; j<jLen; j++) {
-              var qrItemInfo = {
-                linkId: linkId,
-                item: repeatingItems[j],
-                index: j,
-                total: repeatingInfo.total
-              };
-              // check observation instances in the sub level
-              this._checkQRItems(qrItemInfo, repeatingItems[j]);
-              self._checkQRItemAnswerItems(qrItemInfo, repeatingItems[j]);
-              qrItemsInfo.push(qrItemInfo);
-            }
-            repeatingItemProcessed[linkId] = true;
-          }
-        }
-        parentQRItemInfo.qrItemsInfo = qrItemsInfo;
-      }
-    },
-
-
-    /**
-     * Find the number of the repeating items that have the same code
-     * @param linkId an item's linkId
-     * @param parentQRItem a parent item in a QuestionnaireResponse object
-     * @returns a structural info object for a repeating item
-     * @private
-     */
-    _findTotalRepeatingNum : function(linkId, parentQRItem) {
-
-      var total = 0;
-      var repeatingItems = [];
-      for (var i=0, iLen=parentQRItem.item.length; i<iLen; i++) {
-        var item = parentQRItem.item[i];
-        if (linkId === item.linkId) {
-          repeatingItems.push(item);
-          if (Array.isArray(item.answer)) {
-            total += item.answer.length; // answers for repeating questions and repeating answers
-          }
-          else {
-            total += 1;
-          }
-        }
-      }
-
-      return {
-        total: total,
-        repeatingItems: repeatingItems
-      };
-    },
-
-
-    /**
-     * Add repeating items into LForms definition data object
-     * @param parentItem a parent item
-     * @param linkId code of a repeating item
-     * @param total total number of the repeating item with the same code
-     * @private
-     */
-    _addRepeatingItems : function(parentItem, linkId, total) {
-      // find the first (and the only one) item
-      var item = null;
-      if (parentItem.items) {
-        for(var i=0, iLen=parentItem.items.length; i<iLen; i++) {
-          if (linkId === parentItem.items[i].linkId) {
-            item = parentItem.items[i];
-            break;
-          }
-        }
-        // insert new items
-        if (item) {
-          while(total > 1) {
-            var newItem = LForms.Util.deepCopy(item);
-            parentItem.items.splice(i, 0, newItem);
-            total -= 1;
-          }
-        }
-      }
-    },
-
-
-    /**
-     * Find a matching repeating item by item code and the index in the items array
-     * @param parentItem a parent item
-     * @param linkId linkId of a repeating (or non-repeating) item
-     * @param index index of the item in the sub item array of the parent item
-     * @returns {{}} a matching item
-     * @private
-     */
-    _findTheMatchingItemByLinkIdAndIndex : function(parentItem, linkId, index) {
-      var item = null;
-      var idx = 0;
-      if (parentItem.items) {
-        for(var i=0, iLen=parentItem.items.length; i<iLen; i++) {
-          if (linkId === parentItem.items[i].linkId) {
-            if (idx === index) {
-              item = parentItem.items[i];
-              break;
-            }
-            else {
-              idx += 1;
-            }
-          }
-        }
-      }
-      return item;
-    },
-
-
-    /**
-     * Find a matching repeating item by item code alone
-     * When used on the LForms definition data object, there is no repeating items yet.
-     * @param parentItem a parent item
-     * @param linkId linkId of an item
-     * @returns {{}} a matching item
-     * @private
-     */
-    _findTheMatchingItemByLinkId : function(parentItem, linkId) {
-      var item = null;
-      if (parentItem.items) {
-        for(var i=0, iLen=parentItem.items.length; i<iLen; i++) {
-          if (linkId === parentItem.items[i].linkId) {
-            item = parentItem.items[i];
-            break;
-          }
-        }
-      }
-      return item;
-    }
-
-  }
-
-}
-
-export default addSDCImportFns;