Merge pull request #79 from FirelyTeam/release-notes-4.8.0

Release notes 4.8.0
FirelyTeam · Mar 21, 2022 · 87e4b46 · 87e4b46
2 parents 3216760 + 5dc0bd1
commit 87e4b46
Show file tree

Hide file tree

Showing 4 changed files with 115 additions and 4 deletions.
diff --git a/faq.rst b/faq.rst
@@ -49,4 +49,34 @@ This is very misleading. The actual error is that you probably tried to run ``do
 
 The same error can happen if you have built a Docker image of your own with ``dotnet vonk.server.dll`` as entrypoint.
 
-.NET 5 fixed this and more clearly states that the dll is missing.
+.NET 5 fixed this and more clearly states that the dll is missing.
+
+Homepage takes long to load
+---------------------------
+
+The html homepage that is provided with Firely Server may take a long time to load, even though the server seems fully up and running.
+
+The homepage consumes the bootstrap.js library from a CDN. The delay may be caused by a firewall slowing down that download.
+
+The remedy is to disable the homepage in the pipelinesettings:
+
+   ::
+   
+      "PipelineOptions": {
+        "PluginDirectory": "./plugins",
+        "Branches": [
+        {
+          "Path": "/",
+          "Include": [
+            "Vonk.Core",
+            ...,
+            // "Vonk.UI.Demo", <-- disable this one
+            ...
+          ],
+        },
+        {
+          "Path": "/administration",
+          ...
+        }
+        ]
+      }
diff --git a/features/multiversion.rst b/features/multiversion.rst
@@ -17,6 +17,9 @@ Accepted values for the parameter are:
 
 You can add the fhirVersion to the Accept and/or the Content-Type header. If you specify it on both, the fhirVersion parameters have to be the same.
 
+.. note::
+   The fhirVersion parameter is also part of the Content-Type header of the response by Firely Server. Settings can control this, see :ref:`feature_multiversion_endpoints` below.
+
 The examples below explain the behaviour with STU3, but if you replace fhirVersion with 4.0, it works exactly the same on R4. 
 
 .. note:: 
@@ -128,6 +131,7 @@ Assigning an endpoint to a FHIR version is exactly equivalent to adding that par
 
    "InformationModel": {
       "Default": "Fhir4.0",
+      "IncludeFhirVersion": ["Fhir4.0", "Fhir5.0"],
       "Mapping": {
          "Mode": "Path",
          "Map": {
@@ -171,6 +175,12 @@ and the administration call
 
 As you can see, on a mapped endpoint it is never necessary to use a FHIR ``_format`` parameter or a ``fhirVersion`` MIME parameter in a ``Content-Type`` or ``Accept`` header.
 
+Response Content-Type
+^^^^^^^^^^^^^^^^^^^^^
+
+The setting ``IncludeFhirVersion`` is used for the Content-Type of the response from Firely Server. Some clients cannot handle a parameter on the mimetype, and the fhirVersion parameter was originally not part of FHIR STU3. Therefore this settings allows you to specify for which FHIR versions this parameter should be included in the Content-Type header.
+By default we set it to FHIR R4 and R5, as for STU3 the fhirVersion may be unexpected for clients.
+
 .. _feature_multi_version_r5:
 
 Support for R5 (experimental!)

diff --git a/releasenotes/releasenotes.rst b/releasenotes/releasenotes.rst
@@ -24,7 +24,55 @@ Public Endpoint Announcement 8 July 2021
 
 The default FHIR version of the `public Firely Server endpoint <https://server.fire.ly/>`_ is now R4.
 
-.. _vonk_releasenotes_471:
+.. _vonk_releasenotes_480:
+
+Release 4.8.0, Mar 21st, 2022
+-----------------------------
+
+Plugins
+^^^^^^^
+
+#. Upgraded the .NET SDK to 3.8.0. Please review its `release notes <https://github.com/FirelyTeam/firely-net-sdk/releases>`_ for changes.
+
+Database
+^^^^^^^^
+
+#. SQL Server
+
+   1. Reduced database size by compressing the resource JSON.
+
+   .. attention::
+
+      This change requires a complex SQL migration which can be long if you have many resources. To estimate how long it will take for you, you can try running the migration for a subset of your data. The overall migration time will grow linearly with the number of resources in the database.
+
+      For our test database containing ~185mln FHIR resources, the migration took approximately 1.5 days.
+
+      If you have questions about the migration, please :ref:`contact us<vonk-contact>`.
+
+
+Performance
+^^^^^^^^^^^
+
+#. Improved performance for update, _include/_revinclude and conditional create interactions
+
+Feature
+^^^^^^^
+
+#. You can now control the inclusion of the ``fhirVersion`` mimetype parameter in the Content-Type header of the response. See :ref:`feature_multiversion_endpoints`. We chose to change the default for FHIR STU3 to *not* include it as this parameter was introduced with FHIR R4.
+
+Fix
+^^^
+
+#. Fixed exception by improving transaction handling when updating and deleting the same resource in parallel.
+#. Use correct restful interaction codes in AuditEvent.subtype when recording a request to Firely Server
+#. AuditEvent.action contained the wrong code when recording a SEARCH interaction
+#. The name of a custom operation is now recorded in an AuditEvent
+#. Fixed searching using the :identifier modifier in case the identifier system is not a valid URL
+#. Searching using a If-None-Exist header was not scoped to an information model, i.e. a request using FHIR R4 also matched STU3 resources
+#. Improved error message if $lastN operation is enabled but the corresponding repository is not inlcuded in the pipeline options
+#. Changed CapabilityStatement.software.name to Firely Server
+#. Fixed SQL Server maintenance job timeouts on large SQL Server databases
+#. Improved Bundle reference resolving in some corner cases, which are clarified in the `specification <https://jira.hl7.org/browse/FHIR-29271>`_
 
 Release 4.7.1, Feb 15th, 2022
 -----------------------------

diff --git a/tools/firely-server-import.rst b/tools/firely-server-import.rst
@@ -108,6 +108,8 @@ Supported arguments
 +---------------------------------------------------+----------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
 | CLI argument                                      | Appsettings parameter name       | Required | Description                                                                                                                                         |
 +===================================================+==================================+==========+=====================================================================================================================================================+
+| ``--settings <settingsJsonFile>``                 |                                  |          | Custom settings json file                                                                                                                           |
++---------------------------------------------------+----------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
 | ``-f``, ``--fhir-version <R3|R4>``                | fhirVersion                      |          | FHIR version of the input                                                                                                                           |
 +---------------------------------------------------+----------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
 | ``-s``, ``--source <source>``                     | source                           | yes      | Input directory for work (this directory is visited recursively including all the subdirectories)                                                   |
@@ -171,7 +173,23 @@ Supported arguments
 Examples
 --------
 
-Runs the import for files located in directory **/path/to/your/input/files** and its subdirectories using license file **/path/to/your/license/fsi-license.json** targeting the database defined by the connection string. In case a resource being imported already exists in the target database, it gets skipped.
+Specify a custom settings file **/path/to/your/custom/settings/appsettings.instance.json**.
+
+.. code-block:: bash
+
+  fsi --settings ./path/to/your/custom/settings/appsettings.instance.json 
+
+.. note::
+  If ``--settings`` is omitted, FSI searches following folders sequentially and tries to find ``appsettings.instance.json``. The first occurrence will be used if FSI finds one, otherwise the default ``appsettings.json`` will be used.  
+
+  * Current launched folder |br| 
+    e.g. ``C:\Users\Bob\Desktop``  
+  * FSI installation folder |br|
+    e.g. ``C:\Users\Bob\.dotnet\tools``  
+  * FSI installation ``dll`` folder |br| 
+    e.g. ``C:\Users\Bob\.dotnet\tools\.store\firely.server.ingest\version\firely.server.ingest\version\tools\net6.0\any``
+
+Run the import for files located in directory **/path/to/your/input/files** and its subdirectories using license file **/path/to/your/license/fsi-license.json** targeting the database defined by the connection string. In case a resource being imported already exists in the target database, it gets skipped.
 
 .. code-block:: bash
 
@@ -265,4 +283,9 @@ Release 1.0.0
 * First public release
 * Performance: optimized memory consumption (especially, when reading large `*.ndjson` files)
 * Feature: quantitative values can be automatically canonicalized to UCUM values (see --useUcum CLI option)
-* Multiple smaller fixes to improve reliability and performance of the tool
+* Multiple smaller fixes to improve reliability and performance of the tool
+
+
+.. |br| raw:: html
+
+   <br />