formbuilder-lhcforms 12.9.0 → 12.11.0

package/README.md

@@ -87,6 +87,56 @@ cp .env .env.local
 
 The npm scripts automatically load `.env` plus `.env.local` (when present), with `.env.local` taking precedence.
 
+### Choosing the LHC-Forms version and server
+
+By default, the form builder loads the latest version of LHC-Forms from
+https://lhcforms-static.nlm.nih.gov/lforms-versions/ at run time. To change that, set `source` and/or
+`version` in `assets/lforms-config.json5`. Edit `src/assets/lforms-config.json5` before building, or the copy
+in the `assets` folder of the built application. The file is in [JSON5](https://json5.org/) format, and its
+comments describe both values.
+
+To load a specific version from the NLM server, set only `version`:
+
+```json5
+{
+  source: "",
+  version: "44.1.0"
+}
+```
+
+To use a fixed copy served by your own server instead (for example a version that matches the forms renderer
+of your application), set both values:
+
+```json5
+{
+  // Base URL of the LHC-Forms files.
+  source: "/path/to/lforms-44.1.0",
+  // X.Y.Z version of the LHC-Forms files at source.
+  version: "44.1.0"
+}
+```
+
+`source` is the base URL of the extracted
+[LHC-Forms release](https://lhcforms-static.nlm.nih.gov/lforms-versions/) (or of `dist/lforms` of the
+`lforms` npm package). A relative URL is resolved against the form builder's base URL (`<base href>`), and
+`/` is the root of the server. The base URL must contain `webcomponent/styles.css`,
+`webcomponent/assets/lib/zone.min.js`, `webcomponent/lhc-forms.js` and `fhir/lformsFHIRAll.min.js`. `version`
+must be the `X.Y.Z` version, 37.0.0 or later, of that copy, or of the release on the NLM server if `source` is
+not set; older versions lack features the form builder requires, such as FHIR R5 support. The form builder
+logs a warning in the browser console if the version of the loaded copy differs from `version`. Use a recent
+LHC-Forms version; the form builder is developed and tested with the latest one.
+
+The default behavior applies if the file is missing or empty, or if both values are empty or omitted. It also
+applies if the file cannot be read: on an HTTP error other than 404, the form builder logs a warning in the
+browser console and loads the latest version from the NLM server, even if the file sets `source`. A response
+with the content type `text/html` is treated as a missing file, without a warning, because single-page
+application servers return their HTML page for missing files. Make sure the file is served as-is (for
+example, not behind a login page) if your deployment must not load LHC-Forms from the NLM server. If the
+file is not valid JSON5, has `source` without `version`, or has an invalid `version`, the form builder reports
+an error instead of loading LHC-Forms. It also reports an error, without falling back to another version, if
+the configured version cannot be loaded. Browsers may cache the file, so configure your server to revalidate
+it if you change it after deployment.
+
 ## **Contributing**
   - If you plan to contribute new functionality, it is important to coordinate with the maintainers to ensure proper integration and to avoid duplicating efforts. Reach out to the maintainers for guidance on contributing.
 

package/dist/formbuilder-lhcforms/3rdpartylicenses.txt

@@ -950,6 +950,9 @@ Awesome, nor vice versa. **Please do not use brand logos for any purpose except
 to represent the company, product, or service to which they refer.**
 
 
+@lhncbc/expression-editor
+SEE LICENSE IN LICENSE.md
+
 @lhncbc/ngx-schema-form
 MIT
 
@@ -2902,8 +2905,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-ngx-expression-editor
-
 object-inspect
 MIT
 MIT License

package/dist/formbuilder-lhcforms/assets/fhir-definitions.schema.json5

@@ -43,6 +43,29 @@
           "pattern": "^\\S*$",
           "type": "string"
         },
+        // The id and/or extensions of the primitive fields, copied from
+        // $.definitions.Extension in fhir.schema.json. Without them, the form drops e.g. a
+        // child extension's _valueString when the extension array is rebuilt.
+        "_url": {"description": "Extensions for url", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueBase64Binary": {"description": "Extensions for valueBase64Binary", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueBoolean": {"description": "Extensions for valueBoolean", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueCanonical": {"description": "Extensions for valueCanonical", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueCode": {"description": "Extensions for valueCode", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueDate": {"description": "Extensions for valueDate", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueDateTime": {"description": "Extensions for valueDateTime", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueDecimal": {"description": "Extensions for valueDecimal", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueId": {"description": "Extensions for valueId", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueInstant": {"description": "Extensions for valueInstant", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueInteger": {"description": "Extensions for valueInteger", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueMarkdown": {"description": "Extensions for valueMarkdown", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueOid": {"description": "Extensions for valueOid", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valuePositiveInt": {"description": "Extensions for valuePositiveInt", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueString": {"description": "Extensions for valueString", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueTime": {"description": "Extensions for valueTime", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueUnsignedInt": {"description": "Extensions for valueUnsignedInt", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueUri": {"description": "Extensions for valueUri", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueUrl": {"description": "Extensions for valueUrl", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
+        "_valueUuid": {"description": "Extensions for valueUuid", "$ref": "#/definitions/Element", "widget": {"id": "hidden"}},
         "valueBase64Binary": {
           "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
           "pattern": "^(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+$",

package/dist/formbuilder-lhcforms/assets/fl-fields-layout.json5

@@ -23,6 +23,7 @@
           { field:  "identifier", col:  12},
           { field:  "meta", col:  12},
           { field:  "useContext", col:  12},
+          { field:  "jurisdiction", col:  12},
           { field:  "subjectType", "col": 12},
           { field:  "date", col:  12},
           { field:  "publisher", col:  12},
@@ -31,6 +32,7 @@
           { field:  "lastReviewDate", col:  12},
           { field:  "effectivePeriod", col:  12},
           { field:  "contained", "col": 12},
+          { field:  "__$templateExtract", "col": 12},
           { field:  "__$variable", col: 12},
           { field:  "__$extensionContainer", col: 12}
         ]
@@ -49,6 +51,11 @@
     '$.properties.meta': 'Meta',
     '$.properties.useContext': 'Usage Context',
     '$.properties.useContext.items.properties.__$valueSummary': 'Value',
+    '$.properties.jurisdiction.items.properties.text': 'Text',
+    '$.properties.jurisdiction.items.properties.coding': 'Coding',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.display': 'Display',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.code': 'Code',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.system': 'System',
     '$.definitions.Meta.properties.versionId': 'Version ID (Read-only)',
     '$.definitions.Meta.properties.lastUpdated': 'Last updated (Read-only)',
     '$.definitions.Meta.properties.source': 'Source',
@@ -64,6 +71,7 @@
     inputBox: 'formStringField',
     textArea: 'formTextareaField',
     inlineTextArea: 'formInlineTextareaField',
+    jurisdictionCoding: 'dialogCodingTable',
     instant: 'formInstantField',
     'positive-integer': 'formPositiveIntegerField',
     'unsigned-integer': 'formUnsignedIntegerField'
@@ -185,21 +193,39 @@
         {"field": "__$valueSummary", "title": "Value", "col": 4, "nolabel": true}
       ]
     },
+    jurisdiction: {
+      "id": "array",
+      "addDefaultItemIfEmpty": false,
+      "labelPosition": "left",
+      "labelClasses": "col-sm-2 ps-0 pe-1",
+      "controlClasses": "col-sm-10",
+      "addButtonLabel": "Add jurisdiction",
+      "noCollapseButton": true
+    },
+    jurisdictionConcept: {
+      "id": "lfb-object",
+      "nolabel": true,
+      "childOffsetClass": "ms-0",
+      "showFields": [
+        {"field": "text", "col": 12},
+        {"field": "coding", "col": 12}
+      ]
+    },
     contained: {
       "id": "contained",
       "addEditAction": true,
       "labelPosition": "left",
       "labelClasses": "col-sm-2 ps-0 pe-1",
       "controlClasses": "col-sm-10",
-      "addButtonLabel": "Add new ValueSet",
-      "addButtonTitle": "At present, only ValueSet is supported as contained resource.",
+      "addButtonLabel": "Add contained resource",
+      "addButtonTitle": "Create or import a contained FHIR resource.",
       "showFields": [
         // The fields here are canonical paths of FormProperty.
-        {"field": "resourceType", "col": 1, "nolabel": true},
-        {"field": "id", "col": 3, "nolabel": true},
-        {"field": "title", "col": 4, "nolabel": true},
-        {"field": "date", "col": 2, "nolabel": true},
-        {"field": "status", "col": 1, "nolabel": true}
+        {"field": "resourceType", "title": "Type", "col": 2, "nolabel": true},
+        {"field": "id", "title": "Id", "col": 3, "nolabel": true},
+        {"field": "__$resourceDisplay", "title": "Display", "col": 4, "nolabel": true},
+        {"field": "__$fhirVersionInfo.version", "title": "FHIR version", "col": 1, "nolabel": true},
+        {"field": "status", "title": "Status", "col": 1, "nolabel": true}
       ]
     },
     "__$extensionContainer": {
@@ -289,9 +315,13 @@
       '$.properties.publisher',
       '$.definitions.Meta.properties.versionId',
       '$.definitions.Meta.properties.lastUpdated',
+      '$.properties.jurisdiction.items.properties.text',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.display',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.code',
     ],
     url: [
       '$.definitions.Meta.properties.source',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.system',
     ],
     inlineTextArea: [
       '$.properties.description',
@@ -328,6 +358,15 @@
     usageContext: [
       '$.properties.useContext'
     ],
+    jurisdiction: [
+      '$.properties.jurisdiction'
+    ],
+    jurisdictionConcept: [
+      '$.properties.jurisdiction.items'
+    ],
+    jurisdictionCoding: [
+      '$.properties.jurisdiction.items.properties.coding'
+    ],
     extension: [
       '$.properties.extension'
     ],

package/dist/formbuilder-lhcforms/assets/items-layout.json5

@@ -63,6 +63,7 @@
           { "field": "__$terminologyServer", "col": 12 },
           { "field": "__$observationLinkPeriod", "col": 12},
           { "field": "__$observationExtract", "col": 12},
+          { "field": "__$templateExtract", "col": 12},
           { "field": "__$extensionContainer", "col": 12 }
         ]
       }

package/dist/formbuilder-lhcforms/assets/lforms-config.json5

@@ -0,0 +1,18 @@
+{
+  // Optional: choose the LHC-Forms version and the server it is loaded from.
+  // - Both values empty (default): the latest version from
+  //   https://lhcforms-static.nlm.nih.gov/lforms-versions/.
+  // - Only version set: that version from the same NLM server.
+  // - Both values set: your own copy of LHC-Forms at source. source requires version.
+  // See "Choosing the LHC-Forms version and server" in README.md.
+
+  // Base URL of the LHC-Forms files, e.g. "/lforms/44.1.0" or "https://example.org/lforms/44.1.0".
+  // A relative URL is resolved against the form builder's base URL (<base href>); "/" is the server
+  // root. It must contain webcomponent/styles.css, webcomponent/assets/lib/zone.min.js,
+  // webcomponent/lhc-forms.js and fhir/lformsFHIRAll.min.js.
+  source: "",
+
+  // X.Y.Z version of LHC-Forms, 37.0.0 or later, e.g. "44.1.0": the version of the files at source,
+  // or, without source, the version to load from the NLM server.
+  version: ""
+}

package/dist/formbuilder-lhcforms/assets/ngx-fl.schema.json5

@@ -1357,10 +1357,47 @@
     "contained": {
       "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
       "items": {
-        "$ref": "#/definitions/ValueSet"
+        "description": "Any FHIR resource stored inline with the Questionnaire.",
+        "type": "object",
+        "properties": {
+          "resourceType": {
+            "description": "FHIR resource type.",
+            "type": "string"
+          },
+          "id": {
+            "description": "Logical id used for local references to the contained resource.",
+            "$ref": "#/definitions/id"
+          }
+        },
+        "required": ["resourceType"],
+        "additionalProperties": true
       },
       "type": "array"
     },
+    "__$templateExtract": {
+      "description": "Create extracted FHIR resources from the Questionnaire's existing contained resource templates.",
+      "title": "Template-based extraction",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Extension"
+      },
+      "widget": {
+        "id": "template-extract",
+        "addEditAction": true,
+        "addDefaultItemIfEmpty": false,
+        "addButtonLabel": "Add new template extraction",
+        "addButtonDisabledReason": "A contained resource is required before adding a template extraction. Add one under Contained resources above.",
+        "labelPosition": "left",
+        "labelClasses": "col-sm-2 ps-0 pe-1",
+        "controlClasses": "col-sm-10",
+        "showFields": [
+          {"field": "template", "col": 3, "title": "Template"},
+          {"field": "fullUrl", "col": 3, "title": "fullUrl"},
+          {"field": "resourceId", "col": 2, "title": "resourceId"},
+          {"field": "conditionalRequest", "col": 3, "title": "Conditional request"}
+        ]
+      }
+    },
     "__$variable": {
       "description": "Use to store values derived from calculations, references to other answers, or external data.",
       "title": "Variables",
@@ -1406,6 +1443,7 @@
         "description",
         "purpose",
         "__$terminologyServer",
+        "__$templateExtract",
         "__$variable",
         "__$extensionContainer"
       ]

package/dist/formbuilder-lhcforms/assets/ngx-item.schema.json5

@@ -2615,6 +2615,30 @@
         "type": ["$EXP$ target.value != 'display'"]
       }
     },
+    "__$templateExtract": {
+      "description": "Create extracted FHIR resources from the Questionnaire's existing contained resource templates.",
+      "title": "Template-based extraction",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Extension"
+      },
+      "widget": {
+        "id": "template-extract",
+        "addEditAction": true,
+        "addDefaultItemIfEmpty": false,
+        "addButtonLabel": "Add new template extraction",
+        "addButtonDisabledReason": "A contained resource is required before adding a template extraction. Add one under Contained resources in the form-level fields.",
+        "labelPosition": "left",
+        "labelClasses": "col-2 ps-0 pe-1",
+        "controlClasses": "col-10",
+        "showFields": [
+          {"field": "template", "col": 3, "title": "Template"},
+          {"field": "fullUrl", "col": 3, "title": "fullUrl"},
+          {"field": "resourceId", "col": 2, "title": "resourceId"},
+          {"field": "conditionalRequest", "col": 3, "title": "Conditional request"}
+        ]
+      }
+    },
     "__$extensionContainer": {
       "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
       "title": "General Extensions",
@@ -3283,6 +3307,17 @@
         }
       ]
     },
+    {
+      "fields": [
+        "__$templateExtract"
+      ],
+      "showFields": [
+        {
+          "field": "__$templateExtract",
+          "col": 12
+        }
+      ]
+    },
     {
       "fields": ["id", "__$treeNodeId", "__$extensionContainer", "extension", "modifierExtension", "definition"]
     }