Skip to content

Commit

Permalink
Merge pull request #15 from FirelyTeam/update/Forge_31_0
Browse files Browse the repository at this point in the history
Update for Forge 31.0
  • Loading branch information
Rob5045 committed Aug 17, 2023
2 parents 170e08e + 7ccfef6 commit 34c0d8d
Show file tree
Hide file tree
Showing 72 changed files with 205 additions and 149 deletions.
2 changes: 1 addition & 1 deletion Features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ user-interface.

.. image:: images/ForgeProject.png
:alt: Forge
:scale: 75%
:width: 1302

With Forge you can:

Expand Down
7 changes: 4 additions & 3 deletions InstallingForge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ the application. After installation of a new release, you will receive
automatic update notifications when you start the application.

Forge is built with the `Microsoft .NET Framework 4.7.2, .NET
6 <https://dotnet.microsoft.com/learn/dotnet/what-is-dotnet>`__ and
7 <https://dotnet.microsoft.com/learn/dotnet/what-is-dotnet>`__ and
`WPF <https://visualstudio.microsoft.com/vs/features/wpf/>`__. The
ClickOnce installer will download and install the .NET Framework 4.7.2
if necessary. Forge itself will download and install .NET 6 if
if necessary. Forge itself will download and install .NET 7 if
necessary.

.. Attention:: Installing or updating the .NET Framework or .NET 6 requires
.. Attention:: Installing or updating the .NET Framework or .NET 7 requires
administrator permissions. If you have insufficient permissions,
please contact your system administrator.

Expand All @@ -46,6 +46,7 @@ In some cases users find that when installing or updating Forge the
following security warning appears:

.. image:: ./images/ForgeInstallSecurityWarning.png
:width: 597

If this is the case for you, please follow `the steps listed in this
blog
Expand Down
38 changes: 38 additions & 0 deletions OldReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,44 @@
Old release notes
=================

Release 27.3.1
--------------
Bug fixes
^^^^^^^^^
* Forge prerequisite check did not take .NET 5 updates into account.

Release 27.3
------------
R4B Support
^^^^^^^^^^^
The first release of Forge for FHIR R4B. This alpha release is based on FHIR
preview release 4.1.0, which is part of the FHIR R4B version range.

.. note::
Please note that as both the FHIR version and this Forge alpha version are
far from definitive, Forge 27.3 alpha may or may not contain unexpected errors
and missing functionality.

There is experimental support for migrating R4 profiles to R4B.

Changes
^^^^^^^
* Upgrade to Firely .NET SDK 3.4.0.
* Upgrade to .NET 5.

Bug fixes
^^^^^^^^^
* Faulty slicing behaviour in extension.
* Extension misplacement.
* Forge not enforcing slicing rules element.
* StructureDefinition.name regex should be warning only.
This was already a warning but the tooltip suggested that it was an error. Changed tooltip title to "Validation messages:".
* Index was out of range error when saving profile.
* Forge now calculates the minimum cardinality for extension arrays.
Note that in order to update your existing profiles in this regard you need to open and then save a profile again.
* Removed "New Implementation Guide" menu option (feature was not supported anyway).
* **[R4-R5]** Forge cannot extend choice[x] elements.

Release 27.1
------------
Changes
Expand Down
79 changes: 41 additions & 38 deletions ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,47 @@

OldReleaseNotes

Release 31.0
------------
Changes
^^^^^^^
* Upgraded to Firely .NET SDK 5.3.0.
* Upgraded to .NET 7.
* R5 officially supported by Forge.
* Resource tree view rendering is now consistent with Simplifier with two rendering options:

- Unmodified elements in the tree are displayed dimmed (default).
- Modified elements in the tree are indicated with a pen icon.
* When adding an extension to an element the cardinality of the extension is now applied by default.
* Added option for saving **Xml Declaration** header in xml files to the settings dialog:

- Same as source
- Include
- Omit
* Various other UI styling improvements.

Bug fixes
^^^^^^^^^
* A parent extension element definition was always created with default values in Forge ignoring differential values from the resource file.
* When adding a data type profile (with constraints) on a data type that already has constraints on it from a base profile then now all constraints are merged whenever possible.
* Fixed false positive correction messages for inherited extensions.
* Opening a profile saved with a snapshot but without a differential would result in false correction messages.
* When saving a profile with a snapshot then the snapshot could contain superfluous elements.
* When adding a new extension to a profile then the **Element Properties** panel would not show the correct values (e.g. description).
* After adding an extension to a primitive data type then saving and reloading the profile then the id property of the primitive data type would be visible in the tree while it should be hidden.
* Forge would allow you to add (modifier) extensions on elements that do not support it.
* Forge no longer tries to correct the cardinality of parent extensions where the extension definition slicing rule is closed.
* When creating a new complex extension the **value[x]** element is hidden in the tree view but the element is included in the differential.
However, the differential for element **Extension.value[x]** contains type elements whereas none were expected as the element does not alter the base element definition.
Forge did not always include the Meta type and thus created a difference with the base definition.
* A profile with a sliced element but without a discriminator would not load properly.
* Using the **Duplicate** or **Open** profile (from Element Properties panel) would cause Forge to crash when the resource had an old Fhir version.
* Changes to the option **Resolve resources from subfolders** in the **Settings** dialog and the Open folder dialog were not saved.
* Profiles with a FHIR version unknown to Forge (e.g. FHIR version 5.0.0 for Forge 30.2.0 for R5) but where that unknown version is newer
than the latest FHIR version known by Forge (e.g. 5.0.0-snapshot1 for Forge 30.2.0 for R5) would result in an error message and the profile would not be opened.
* Fixed various minor UI (styling) issues.
* **[R4B/R5]** CodeableReference was not treated as a reference and thus the target profile property was not shown in the **Element Properties** panel.

Release 30.2
------------
Changes
Expand Down Expand Up @@ -224,41 +265,3 @@ Bug fixes
* **[STU3]** Not possible to create/edit Logical Models in Forge 27.3.1.
* **[R4-R5]** Extensions don't show in what context they are supposed to be used
* **[R4-R5]** Forge allows definition of default values in Profiles. Constraint sdf-21 is now enforced.

Release 27.3.1
--------------
Bug fixes
^^^^^^^^^
* Forge prerequisite check did not take .NET 5 updates into account.

Release 27.3
------------
R4B Support
^^^^^^^^^^^
The first release of Forge for FHIR R4B. This alpha release is based on FHIR
preview release 4.1.0, which is part of the FHIR R4B version range.

.. note::
Please note that as both the FHIR version and this Forge alpha version are
far from definitive, Forge 27.3 alpha may or may not contain unexpected errors
and missing functionality.

There is experimental support for migrating R4 profiles to R4B.

Changes
^^^^^^^
* Upgrade to Firely .NET SDK 3.4.0.
* Upgrade to .NET 5.

Bug fixes
^^^^^^^^^
* Faulty slicing behaviour in extension.
* Extension misplacement.
* Forge not enforcing slicing rules element.
* StructureDefinition.name regex should be warning only.
This was already a warning but the tooltip suggested that it was an error. Changed tooltip title to "Validation messages:".
* Index was out of range error when saving profile.
* Forge now calculates the minimum cardinality for extension arrays.
Note that in order to update your existing profiles in this regard you need to open and then save a profile again.
* Removed "New Implementation Guide" menu option (feature was not supported anyway).
* **[R4-R5]** Forge cannot extend choice[x] elements.
18 changes: 9 additions & 9 deletions features/CreateDerivedProfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ profile.

.. figure:: ../images/Profilehierarchy2.png
:alt: The hierarchy between FHIR profiles
:scale: 75%
:width: 674

Adding dependencies
-------------------
Expand All @@ -40,40 +40,40 @@ following example adds the **hl7.fhir.us.core** package to the project.
Select the ``Dependencies`` tab, then click ``Simplifier``, then type
*hl7.fhir.us* in the **Search** field and finally click ``Search``.
Select **hl7.fhir.us.core** in the list and then select package version
**5.0.0**. Finally click ``Add`` to add the package to the project.
**6.1.0**. Finally click ``Add`` to add the package to the project.

.. figure:: ../images/DerivedAddPackage.png
:alt: Add a core package
:scale: 75%
:width: 830

Click the ``Project`` tab to see what packages are installed. Notice
that dependent packages are installed too.

.. figure:: ../images/DerivedPackagesInstalled.png
:alt: Installed packages
:scale: 75%
:width: 378

To create a derived profile for the US Core Patient, open the package
**hl7.fhir.us.core#5.0.0** by selecting it from the list and clicking
**hl7.fhir.us.core#6.1.0** by selecting it from the list and clicking
``Open``. Then select **package** in the list and click ``Open``. In the
**Filter** toolbar select **Patient** as Structure Type to filter on.

.. figure:: ../images/DerivedUSCorePatient.png
:alt: Derive profile
:scale: 75%
:width: 1246

Select the US Core Patient in the list and click ``Derive``.

.. figure:: ../images/DerivedUSCorePatientProperties.png
:alt: Derive profile properties
:scale: 75%
:width: 1302

Enter the name for the profile and click ``OK``. A new derived profile
is created and opened. You can now make your own modifications.

.. figure:: ../images/DerivedUSCorePatientProfile.png
:alt: US Core Patient profile
:scale: 75%
:width: 879

Things to keep in mind are that you can only further constrain (or add
extensions to) profiles. This means that each derived profile is more
Expand All @@ -87,4 +87,4 @@ differential will reflect constraints on the national profile.

.. figure:: ../images/Profilehierarchy.png
:alt: The hierarchy and conformance between FHIR profiles
:scale: 75%
:width: 645
6 changes: 3 additions & 3 deletions features/CreateLogicalModels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Enter a name for your logical model and click ``OK``.

.. figure:: ../images/LogicalModel-Create.png
:alt: Creating a Logical Model in Forge
:scale: 75%
:width: 1302

You can customize the meta properties for your model and add backbone
elements and typed elements. A backbone element has no datatype. A
Expand All @@ -26,13 +26,13 @@ and/or other (nested) backbone elements.

.. figure:: ../images/LogicalModel-BackboneElement.png
:alt: Editing a backbone element for a Logical Model in Forge
:scale: 75%
:width: 1015

A typed element is mapped to a FHIR datatype or resource profile.

.. figure:: ../images/LogicalModel-TypedElement.png
:alt: Editing a typed element for a Logical Model in Forge
:scale: 75%
:width: 998

You cannot introduce new child elements of a typed element, because they
are implicitly defined by the element datatype profile.You also have the
Expand Down
4 changes: 2 additions & 2 deletions features/CreatenewProfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ folder.

.. figure:: ../images/NewProfileMenu.png
:alt: Project folder toolbar
:scale: 75%
:width: 368

This will open a window in which you can select one of the base
Resources or DataTypes.

.. figure:: ../images/NewProfile.png
:alt: Create a new FHIR profile in Forge
:scale: 75%
:width: 1302

New profile resource selection
------------------------------
Expand Down
12 changes: 6 additions & 6 deletions features/DefineConstraints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ happens.

.. figure:: ../images/ConstraintsCardinality.png
:alt: Set element cardinality in Forge
:scale: 75%
:width: 1072

Element Type
------------
Expand All @@ -41,13 +41,13 @@ explorer and the profile's base Resource fits the element.

.. figure:: ../images/ConstraintsType.png
:alt: Setting valueset binding in Forge
:scale: 75%
:width: 1296

*Setting Observation.value[x] types in Forge*

.. figure:: ../images/ConstraintsTypeReference.png
:alt: Setting valueset binding in Forge
:scale: 75%
:width: 1297

*Setting Observation.subject reference type in Forge*

Expand All @@ -63,7 +63,7 @@ value.

.. figure:: ../images/ConstraintsValueSetBinding.png
:alt: Setting valueset binding in Forge
:scale: 75%
:width: 1296

Inline constraints
------------------
Expand All @@ -84,7 +84,7 @@ elements defined by external type profiles.

.. figure:: ../images/Inlineconstraintontypeslice.png
:alt: Setting an inline constraint on an element in Forge
:scale: 75%
:width: 1296

This behavior also applies to Extension Definitions, as technically they
are also external type profiles. Suppose you author a profile with an
Expand All @@ -97,5 +97,5 @@ in the underlying extension definition.

.. figure:: ../images/Inlineconstraintonprofileextension.png
:alt: Setting an inline constraint on an extension in Forge
:scale: 75%
:width: 1297

0 comments on commit 34c0d8d

Please sign in to comment.