lforms 29.3.0 → 33.2.0

package/r4-support.md

@@ -0,0 +1,147 @@
+# Support for FHIR version R4
+This briefly details the support for FHIR R4 Questionnaire and
+QuestionnaireResponse.  Note that we have also support for FHIR STU3 for
+Questionnaire and QuestionnaireResponse, but that is not documented here.
+
+# Questionnaire
+See https://www.hl7.org/fhir/questionnaire.html for a list of the fields in
+Questionnaire.  For a list of core extensions, see
+https://www.hl7.org/fhir/questionnaire-profiles.html#extensions.
+
+## Supported
+
+### Top-level fields
+All top-level (form-level) fields are supported, but since most of those fields
+do not affect the rendering of a Questionnaire, mostly that means that if a
+Questionnaire containing those fields is imported into LHC-Forms, and
+re-exported in FHIR Questionnaire, the fields are preserved.
+
+For "status", if it was not previously set at import, it will be set to "draft" on export.
+
+### Item-level fields
+* linkId
+* code
+* prefix
+* text
+* type:  All types except reference, and with partial support for date,
+  dateTime, and time.  (See "not yet supported" for details.)
+* enableWhen:  Supported, but has a couple of known bugs:
+   * Does not support > on strings or dates.
+   * For multi-select lists, the "exists" continues to return true after all
+     selected values are removed.
+* enableWhenBehavior
+* required
+* repeats
+* readOnly
+* maxLength
+* answerValueSet:  Supported, with the exception "contained" ValueSets are
+  required to include an expansion.
+* answerOption
+* answerOption.initialSelected
+* initial
+
+### Extensions
+* maxSize
+* maxValue
+* mimeType
+* minLength
+* minValue
+* ordinalValue
+* choiceOrientation
+* hidden
+* itemControl:  Support for types: gtable, table, drop-down, autocomplete,
+  radio-button, check-box, help.  Note that type "list", "inline", and
+  "text-box" are default behavior, so those are supported, and the extension is
+  not needed for those cases.
+* maxOccurs
+* minOccurs
+* unitOption
+* regex
+* variable
+
+The following extensions seem to be out of scope for a form renderer, but they
+are "supported" in the sense that if a Questionnaire using them is re-exported
+from LHC-Forms, the extensions will still be present.
+* 11179-permitted-value-conceptmap
+* 11179-permitted-value-valueset
+* designNote
+* replaces
+* baseType
+
+## Not yet supported
+### Item-level fields
+* item.definition
+* item.type:  No support for type=reference.  Also, there are the following
+  limitations on the support for types "date", "dateTime", and "time":
+   * The date in "date" "dateTime" must be complete dates.  No timezone is shown
+     or selectable for "dateTime".  When entering a
+     dateTime the local timezone is assumed.
+   * The time in "time" and "dateTime" must have both hours and minutes, only.
+     Seconds and milliseconds cannot be entered.
+   * We have not tested what happens if you load a QuestionnaireResponse with
+     data that violates the above restrictions.  We are planning to correct
+     these deficiencies when we can find a suitable UI package that is more
+     flexible about entry of dates and times.  Possibly we will need to write
+     our own.
+* answerValueSet:  "contained" ValueSets without expansions are unsupported
+
+### Extensions
+Note that non-supported extensions are simply ignored, but are also retained on
+a re-export to Questionnaire.
+* maxDecimalPlaces
+* constraint
+* displayCategory
+* itemControl:  See above for supported types.  Unsupported:  htable, header,
+  footer, lower, upper, flyover, lookup, slider, spinner.  Type "unit" is
+  unsupported, but is also unnecessary with LHC-Forms if "questionnaire-unit" is
+  used.  Type "prompt" is also unsupported but is being removed in
+  R5 (https://jira.hl7.org/browse/FHIR-21023).
+* unitValueSet
+* usageMode
+
+
+# QuestionnaireResponse
+See https://www.hl7.org/fhir/questionnaireresponse.html for a list of the fields in
+QuestionnaireResponse.
+
+For a list of core extensions, see
+https://www.hl7.org/fhir/questionnaireresponse-profiles.html.  LHC-Forms does
+not output any of those extensions when creating a QuestionnaireResponse, and
+they do not affect the display of the form if a QuestionnaireResponse containing
+them is imported.
+
+## Fields in QuestionnaireResponse
+
+Because many of the fields in QuestionnaireResponse are either not relevant for
+rendering a form, or when
+[exporting](https://lhncbc.github.io/lforms/#retrieving-fhir-data) to a
+QuestionnaireResponse are left for the application to set, the following list is
+not broken out into supported and unsupported sub-sections as for Questionnaire.
+
+* identifier:  Not used on import, and not set on export.
+* basedOn:  Out of scope; this would be something for the application to set
+* partOf:  Out of scope; this would be something for the application to set
+* questionnaire:  LHC-Forms currently leaves it up the application to set this
+  field, though in the future we plan to set it with value of Questionnaire.url.
+* status:  LHC-Forms sets this to "completed", but the application should change
+  this value it knows that it should be something else (e.g. "amended").
+* subject:  The application can pass in the subject value as an option when
+  [exporting](https://lhncbc.github.io/lforms/#retrieving-fhir-data) the
+  QuestionnaireResponse, or it can set it afterward.
+* encounter:  Left for the application to set.  LHC-Forms would not know this
+  except in certain cases.
+* authored:  Set by LHC-Forms to the date and time at which the QuestionnaireResponse is
+  exported.
+* author:  Left for the application to set.  LHC-Forms would not know this
+  except in certain cases.
+* source:  Left for the application to set.  LHC-Forms would not know this
+  except in certain cases.
+* item.linkId:  Supported
+* item.definition:  Not supported
+* item.text:  LHC-Forms does not currently export this field, though we might
+  change that in the future.  It is not necessary, since it is present in the
+  Questionnaire, but it makes it easier to read a QuestionnaireResponse by
+  itself.
+* item.answer.value[x]:  All types are supported except valueReference.
+* item.item:  Supported
+

package/sdc-support.md

@@ -0,0 +1,127 @@
+# Support for FHIR Structured Data Capture
+
+The following is a terse listing of our support for the Structured Data Capture
+(SDC) FHIR Implementation Guide.  For more details about the items listed here,
+see:  https://build.fhir.org/ig/HL7/sdc/index.html
+
+For the expression extensions mentioned below, we do not support CQL, but do
+support FHIRPath and x-fhir-query where appropriate for the extension.
+
+The following lists are organized by the sections of the SDC implementation
+guide (IG).
+
+## Supported Features
+### Advanced Rendering
+See https://build.fhir.org/ig/HL7/sdc/rendering.html for descriptions of these
+fields.
+* rendering-style:  on item.text and prefix
+* rendering-xhtml:  on item.text, but only for itemControl of type "help", and
+  it does not perform any sanization, and allows any HTML, so please consider
+  security issues before using.
+* hidden
+* itemControl:  Support for types:  gtable, table, drop-down, autocomplete,
+  radio-button, check-box, help.  Note that type "list" is the default type of
+  display, so that is supported, and the extension is not needed for that case.
+* choiceOrientation
+* optionPrefix
+* required
+* repeats
+* readOnly
+* entryFormat
+
+### Form Behavior
+See https://build.fhir.org/ig/HL7/sdc/behavior.html for descriptions of these
+fields.
+* maxLength
+* minLength
+* regex
+* minValue
+* maxValue
+* mimeType
+* maxSize
+* answerOption
+* answerValueSet:  Note that contained ValueSets are expected to contain an expansion.
+* answerExpression
+* required: (also listed in previous section of the SDC IG)
+* repeats
+* readOnly
+* minOccurs
+* maxOccurs
+* unitOption
+* launchContext: limited to what can be obtained through the npm package
+  "fhirclient" (user, patient, encounter)
+* variable
+* initialExpression
+* calculatedExpression
+* initial
+* enableWhen
+* enableBehavior
+* enableWhenExpression
+* ordinalValue
+
+### Form Population
+See https://build.fhir.org/ig/HL7/sdc/populate.html for descriptions of these
+fields.
+* observationLinkPeriod
+* launchContext
+* variable
+* initialExpression
+
+### Form Data Extraction
+See https://build.fhir.org/ig/HL7/sdc/extraction.html for descriptions of these
+fields.
+* observationExtract
+
+
+
+## Not yet supported
+### Advanced Rendering
+See https://build.fhir.org/ig/HL7/sdc/rendering.html for descriptions of these
+fields.
+* rendering-xhtml:  Other than for item.text with itemControl of type "help"
+* displayCategory
+* sliderStepValue
+* width
+* collaspible
+* supportLink
+* choiceColumn
+* valueset-label
+* shortText
+* rendering-styleSensitive
+* optionalDisplay
+
+### Form Behavior
+See https://build.fhir.org/ig/HL7/sdc/behavior.html for descriptions of these
+fields.
+* minQuantity
+* maxQuantity
+* maxDecimalPlaces
+* optionExclusive
+* unitValueSet
+* referenceResource
+* referenceProfile
+* candidateExpression
+* lookupQuestionnaire
+* cqf-library
+* cqf-calculatedValue
+* cqf-expression
+* entryMode
+* usageMode
+* constraint
+* endPoint
+* signatureRequired
+
+### Form Population
+See https://build.fhir.org/ig/HL7/sdc/populate.html for descriptions of these
+fields.
+* itemPopulationContext
+* candidateExpression
+* contextExpression
+* sourceQueries
+* sourceStructureMap
+
+### Form Data Extraction
+See https://build.fhir.org/ig/HL7/sdc/extraction.html for descriptions of these
+fields.
+* itemExtractionContext
+* targetStructureMap

package/app/.npmignore

@@ -1,3 +0,0 @@
-data
-fhir-data
-test

package/app/index.html

@@ -1,10 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <!-- the content of this file is used by grunt tasks only -->
-    <!-- redirect to a test page -->
-    <meta http-equiv="refresh" content="0; url=/test/lforms_testpage.html" />
-  </head>
-  <body>
-  </body>
-</html>

package/app/lforms.js

@@ -1,56 +0,0 @@
-// Use IIFE so that strict mode is not at the file level
-(function() {
-  'use strict';
-  var widgetDeps = [
-    'smoothScroll',
-    'autocompleteLhcMod',
-    'ui.bootstrap.datetimepicker'];
-  var Def = require('autocomplete-lhc');
-  if (Def._tooltip)
-    widgetDeps = [Def._animate, Def._popover, Def._tooltip, 'ui.bootstrap'].concat(widgetDeps);
-  else
-    widgetDeps = ['ngAnimate', 'ui.bootstrap'].concat(widgetDeps);
-  angular.module('lformsWidget', widgetDeps)
-    .config(['$animateProvider', '$rootScopeProvider', '$compileProvider',
-            function ($animateProvider, $rootScopeProvider, $compileProvider) {
-      $animateProvider.classNameFilter(/has-ng-animate/);
-      // AngularJS complains if there are too many levels of nesting in the form
-      // (due to directives calling directives....)  Increase the maximum from
-      // the default of 10.  When the number of levels is exceeded, the form
-      // still renders, but error messages appear in the console, and it is
-      // probably not properly initialized.
-      $rootScopeProvider.digestTtl(20);
-      // Allow "data:" URLs to be assigned to an href.
-      $compileProvider.aHrefSanitizationTrustedUrlList(/^(https?|ftp|mailto|data):/);
-    }])
-    .directive('lforms', function() {
-      return {
-        restrict: 'E',
-        scope: {
-          lfData: '=',
-          // set a variable 'item' for 'lfData'
-          // 'item' is used by some internal recursive directives
-          item: '=lfData',
-          lfOptions: '=?'},
-        link: function(scope, element, attributes) {
-          // watch on data change
-          scope.$watch("lfOptions", function (value){
-            if (scope.lfData && value)
-              scope.lfData.setTemplateOptions(value);
-          }, true);
-          // watch on variable change
-          scope.$watch("lfOptions", function (value){
-            if (scope.lfData && value)
-              scope.lfData.setTemplateOptions(value);
-          });
-        },
-        transclude: true,
-        controller: 'LFormsCtrl',
-        templateUrl: 'form-view.html'
-      };
-    });
-})();
-
-// Define the top-level namespace object
-var LForms = Object.assign({}, require('./version.json'));
-module.exports = LForms;