added release notes, updated images, fixed links

FirelyTeam · Jan 26, 2023 · 2e1d3c9 · 2e1d3c9
1 parent 07102e1
commit 2e1d3c9
Show file tree

Hide file tree

Showing 24 changed files with 186 additions and 55 deletions.
diff --git a/administration/administration.rst b/administration/administration.rst
@@ -1,7 +1,7 @@
 .. _administration:
 
-Team management
-===============
+Team and Organization management
+================================
 
 On the pages below you will find handy information for team and organization admins.
 

diff --git a/conf.py b/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Simplifier.net'
-copyright = '2021, Firely'
+copyright = '2023, Firely'
 author = 'Firely'
 
 # -- General configuration ---------------------------------------------------

diff --git a/...l/data_governance_and_quality_control.rst → ...l/data_governance_and_quality_control.rst b/...l/data_governance_and_quality_control.rst → ...l/data_governance_and_quality_control.rst
diff --git a/..._and_quality_control/simplifierBrowse.rst → ..._and_quality_control/simplifierBrowse.rst b/..._and_quality_control/simplifierBrowse.rst → ..._and_quality_control/simplifierBrowse.rst
@@ -1,9 +1,10 @@
 Searching on Simplifier
 ========================
 
-Simplifier's search has now been superchared on Elastic! Elastic gives Simplifier almost endless options in searching so let's explain how this works. You can press the down arrow on your keyboard of click in the searchbar when you are in the search UI and Simplifier will show all the categories you can search for and within. 
-
-With the new search you can search for and within entities and specify specific attributes you want to find. Pressing the down arrow while in the searchbar or clicking the looking glass icon will give you an overview of all the search and filter options.
+One of the core pillars of Simplifier is providing the users with the best governance possible. 
+The search bar allows users to search withing jurisdictions and organizations for resources to help prevent unnecessary duplication. 
+Users can easily search within organiations or nationalities for already existing profiles and specify specific attributes they want to find. 
+Pressing the down arrow while in the searchbar or clicking the looking glass icon will give you an overview of all the search and filter options. 
 
 Let's start off with an example of how you can search for the latest publication of the UK core profiles. 
 
@@ -17,8 +18,6 @@ This gives you a list form all the available organizations in the UK. In the UI
 .. image:: ../images/SearchExample2.png
 
 
-One of the core pillars of Simplifier, is providing the users with the best governance possible. With our new and improved search users can now search withing jurisdictions and organizations for resources to help prevent unnecessary duplication. The Elastic search allows for easy searching within organiations or nationalities for already existing profile.
-
 Lets give another example: 
 
 You want to find all the R4 MedicationStatements available in the US. You can select your FHIR version, nationality, category and resource type as shown in the screenshot below. 

diff --git a/...ity_control/simplifierCanonicalClaims.rst → ...ity_control/simplifierCanonicalClaims.rst b/...ity_control/simplifierCanonicalClaims.rst → ...ity_control/simplifierCanonicalClaims.rst
diff --git a/...ty_control/simplifierForgeIntegration.rst → ...ty_control/simplifierForgeIntegration.rst b/...ty_control/simplifierForgeIntegration.rst → ...ty_control/simplifierForgeIntegration.rst
@@ -3,6 +3,8 @@ Simplifier Forge Integration
 
 Simplifier and our datamodelling tool Forge work hand in hand. With our new project synchronization feature this has become even easier. For more information on this feature please see our Forge documentation `here. <https://docs.fire.ly/projects/Forge/features/IntegrationwithSimplifier.html>`_
 
+.. image:: ../images/Forge.png
+
 When uploading resources from Forge to your Simplifier project directly we have limited collision detection. If the resource is changed both locally and on Simplifier since last synchronisation, we will ask you to resolve the conflict.
 But there are certainly cases where you can accidentally overwrite each other’s work if you are really working on the same page in the IG editor at the same time or upload a new version of a resource directly.
 

diff --git a/..._and_quality_control/simplifierGithub.rst → ..._and_quality_control/simplifierGithub.rst b/..._and_quality_control/simplifierGithub.rst → ..._and_quality_control/simplifierGithub.rst
diff --git a/...nd_quality_control/simplifierPackages.rst → ...nd_quality_control/simplifierPackages.rst b/...nd_quality_control/simplifierPackages.rst → ...nd_quality_control/simplifierPackages.rst
diff --git a/...lity_control/simplifierQualityControl.rst → ...lity_control/simplifierQualityControl.rst b/...lity_control/simplifierQualityControl.rst → ...lity_control/simplifierQualityControl.rst
diff --git a/features/api.rst b/features/api.rst
@@ -107,7 +107,7 @@ Simplifier has an package server API, that is compliant to the FHIR NPM package
 
 The api endpoint of the Simplifier FHIR package Server is: https://packages.simplifier.net. The Simplifier package server is the backend for `the official FHIR Package Registry <https://registry.fhir.org/>`_ and is also available as https://packages.fhir.org.
 
-**Note**: It is not possible to create a package using the API. For more information on how to create a package please read our `documentation <../features/simplifierPackages.html#publish-packages>`_ on packages. 
+**Note**: It is not possible to create a package using the API. For more information on how to create a package please read our `documentation <../data_governance_and_quality_control/simplifierPackages.html#publish-packages>`_ on packages. 
 
 NPM compatible endpoint
 =======================

diff --git a/features/simplifierEmbeddedRendering.rst b/features/simplifierEmbeddedRendering.rst
@@ -5,13 +5,16 @@ Embedded Rendering
 
     `This feature is available from the Enterprise plan <https://simplifier.net/pricing>`_.
 
-Simplifier enables rendering of profiles as a tree, XML or table. Users with an enterprise account can also embed rendering in their own website by using the following URL and copying it into their own code. Note that this only works for public projects that are created by a user with an enterprise account.
+Simplifier enables rendering of profiles as a tree, XML or table. Users with an enterprise account can also embed rendering in their own website by using the following URL and copying it into their own code:: 
 
-`https://www.simplifier.net/embed/render?id=[Name of your project]/[Name of your resource]`
+    https://www.simplifier.net/embed/render?id=[Name of your project]/[Name of your resource]
+
+Note that this only works for public projects that are created by a user with an enterprise account.
 
 For example, https://www.simplifier.net/embed/render?id=nictizstu3-zib2017/nl-core-patient shows embedded rendering of the nl-core-patient defined by Nictiz. You can copy this URL in your browser to see what the rendering looks like.
 
 To embed the rendering in your own website, you could use the following HTML code::
+
     <iframe src=https://www.simplifier.net/embed/render?id=nictizstu3-zib2017/nl-core-patient height="345px" width="100%"></iframe>
 
 Below you see the result. You could adjust the height and width of the iframe as you like.

diff --git a/getting_started/simplifierIntro.rst b/getting_started/simplifierIntro.rst
@@ -38,11 +38,3 @@ Simplifier content
 ------------------
 
 Simplifier is specially created for Data Modelers, Developers and Clinical Informatics Specialists. The available FHIR content is organized at four levels: Users, Resources, Projects and Organizations. You can import your FHIR resources and make use of the seamless integration between Forge and Simplifier.  
-
-Firely
---------
-
-Simplifier.net is created and managed by Firely, formerly known as Furore Health Informatics.
-We are a group of software engineers, support engineers and FHIR consultants, based in Amsterdam,
-the Netherlands. We have been involved in HL7 FHIR since day one and have been contributing to the
-standard ever since. For more information about our company, please visit `fire.ly <https://fire.ly/>`_.
diff --git a/getting_started/simplifierPersonalContent.rst b/getting_started/simplifierPersonalContent.rst
@@ -1,7 +1,8 @@
 .. _User_portal:
 
-Users
+User Portal
 ^^^^^^^^^^^^^
+Your user portal provides you with an overview of your work in Simplifier.net and allows you to manage your content. 
 Click on your avatar in the top right corner to access your personal menu. From here you can access your personal portal, invites page, user profile, snippets page, organization portal(s) and account settings.
 
 .. image:: ../images/UserMenu.PNG 

diff --git a/getting_started/simplifierProjects.rst b/getting_started/simplifierProjects.rst
@@ -13,11 +13,11 @@ Open your project
 """""""""""""""""
 For an overview of your projects, go to your `personal portal <../administration/simplifierPersonalContent.html>`_ by clicking on your avatar in the top right corner.
 
-.. image::../images/UserMenu.PNG 
+.. image:: ../images/UserMenu.PNG 
 
 The Projects tabs lists all projects you are involved in, either because you created the project yourself (making you the owner of the project) or because you are invited to the project as a project member.
 
-.. image::../images/PersonalPortal.PNG
+.. image:: ../images/PersonalPortal.PNG
 
 Click on the title of a project to open its project page.
 
@@ -27,6 +27,8 @@ Project page
 """"""""""""
 Each project contains a couple of tabs depending on the settings of the project and your role in the project. The tabs described below are visible for each user in each Simplifier project.
 
+.. image:: ../images/ProjectTabs.PNG
+
 Introduction
 ------------
 This section serves as an overview of your project. This is a good area to share information about your project with people that may be team members or viewing your project for the first time. 
@@ -53,9 +55,9 @@ Guides
 ------
 The ``Guides`` tab shows all Implementation Guides for this project built in Simplifier. Click on the Guide or hit the ``Browse`` button to go to the Implementation Guide. Use the `IG-editor <../features/simplifierIGeditor.html#implementation-guide-editor>`_ to create and edit Implementation Guides.
 
-Members
--------
-On the ``Members`` tab you can find all project members and their role. This tab also offers a search option, allowing you to search for other members using their full name or username. Depending on your role in the project you can `add project members <simplifierProjects.html#id1>`_ here.
+Team
+----
+On the ``Team`` tab you can find all project members and their role. This tab also offers a search option, allowing you to search for other members using their full name or username. Depending on your role in the project you can `add project members <simplifierProjects.html#id1>`_ here.
 
 Log
 ---
@@ -77,25 +79,31 @@ The ``Packages`` tab shows all released versions of a project. Project members m
 `Packages <../features/simplifierPackages.html#package-management>`_  are now public BETA. We encourage you to try them out. But you should not use them for production environments yet. 
 
 
-Bookmarks
-"""""""""
-To stay informed in real time click the ``Bookmark`` button in the top right. You do not have to be a member of a project to stay up to date on the latest developments. 
+Subscriptions
+"""""""""""""
+To stay informed in real time click the ``Subscribe`` button in the top right. You do not have to be a member of a project to stay up to date on the latest developments. 
+
+.. image:: ../images/Subscribe.PNG
+
+You can fin dyour current subscriptions in your user portal under the ``Subscriptions`` tab:
+
+.. image:: ../images/Subscriptions.PNG
 
 Create a project
 """"""""""""""""
 In the Projects tabs on your Portal page you can find the button labeled ``Create``. 
 
-.. image::../images/PersonalPortal.PNG
+.. image:: ../images/PersonalPortal.PNG
 
 Clicking this button will allow you to create a new project by entering a Display Name, Description, and Scope. Once the project has been created you can then customize project information, add resources, add members, and follow changes that are occurring in that project.
 
-.. image::../images/CreateProject.PNG 
+.. image:: ../images/CreateProject.PNG 
 
-Project Settings
-""""""""""""""""
-You can always change your project settings by clicking on the ``Settings`` button in the right upper corner. There are a couple of options in the Settings menu, which will be explained below.
+Project Management
+""""""""""""""""""
+You can always change your project settings by clicking on the ``Manage`` button in the right upper corner. There are a couple of options in the Manage menu, which will be explained below.
 
-.. image::../images/ProjectSettings.PNG
+.. image:: ../images/ProjectSettings.PNG
 
 Properties
 ----------
@@ -126,8 +134,12 @@ Workflow
 --------
 Here you can select one of the custom workflows of your organization to use it in your project. The workflows are configured and mapped to the FHIR workflow add the organizational level.
 
-Canonical base urls
--------------------
+Metadata Expressions
+--------------------
+Here you can define how to extract metadata, like title, URL key, filename/path from a resource using FhirPath.
+
+Canonical claims
+----------------
 Project owners can customize their base canonical URLs to brand their projects. Canonical URLs of resources will only be valid if they match the canonical base URL of their project. For more information see our documentation on :ref:`Canonical Claims. <Canonical_Claims>` 
 
 Import log
@@ -181,24 +193,24 @@ The following options are available:
 * Publish all of them
 
 Team Management
-"""""""""""""""""""
+"""""""""""""""
 .. important::
 
     `From the Team plan and up, you are allowed to work with multiple users on a project <https://simplifier.net/pricing>`_.
 
-The ``Members`` tab displays a list of all the members with rights to that project. In this section you can invite Simplifier and non-Simplifier members to your project by clicking the ``Invite User`` button and typing in an emailaddress. For more information on Team Management please look at our :ref:`Team Management page <Team_Management>`.
+The ``Teams`` tab displays a list of all the members with rights to that project. In this section you can invite Simplifier and non-Simplifier members to your project by clicking the ``Invite User`` button and typing in an emailaddress. For more information on Team Management please look at our :ref:`Team Management page <Team_Management>`.
 
-Along the top of the ``Members`` tab you will find a summary of User information for your project. The number of users, the max users allowed for this project (in accordance with the type of plan you have), and the number of invitations you have pending (the number of users who have a not yet accepted an invitation).  
+Along the top of the ``Teams`` tab you will find a summary of User information for your project. The number of users, the max users allowed for this project (in accordance with the type of plan you have), and the number of invitations you have pending (the number of users who have a not yet accepted an invitation).  
 
-.. image::../images/Numberofmembers.png
+.. image:: ../images/Numberofmembers.png
 
 Track Project Changes
 """""""""""""""""""""
 On the ``Log`` tab you will find event tracking of a project. This log keeps a list of all changes made to resources within the project, along with the name of the person that made changes and the time the changes were made. 
 
 At the top of the screen you will find the Atom feed button. This allows you to subscribe to stay informed about any changes being made within your projects. To utilize this feature, navigate to a project on Simplifier.net that you are interested in following. Once there click on the ``Subscribe`` button in the upper right hand corner and copy the link into a feed reader of your choice. You are then ready to start receiving updates. 
 
-.. image::../images/SimplifierProjectLog.png
+.. image:: ../images/SimplifierProjectLog.png
 
 Issue Tracker
 """""""""""""
@@ -209,7 +221,7 @@ Issue Tracker
 
 Would you like to capture feedback about your resources from users? The Issue tracker option is a great way to do this. If you go to the ``Settings`` dropdown menu and then select ``Properties``. You will see the option to Enable Issues at the bottom of your screen. By selecting the On option, you enable the issue tracking feature of your project.
 
-.. image::../images/SimplifierIssueTracker.png
+.. image:: ../images/SimplifierIssueTracker.png
 
 There are two additional options that display once you have turned Issue tracking on. You have the option to limit Issue visibility to project members only or make them publicly visible. The issues that are reported by the community can also be limited to be visable to your project members only or visible to the public.
 

diff --git a/getting_started/simplifierResources.rst b/getting_started/simplifierResources.rst
@@ -15,8 +15,10 @@ Depending on the type of resource, the different views include:
 * **Mappings** - This is a list of all the mappings specified in a profile.
 * **Table** – This is a simple table view of the resource.
 * **XML & JSON** – Respective views of resources in either XML or JSON formatting.
+* **Related** - The references to the profiles from which this profile was derived.
 * **History** – On this tab you can view the difference between two versions of the same profile. This is a great feature for comparing and tracking changes.
 * **Issues** - On this tab users with a paid account can track issues. New issues can be created by clicking the ``New issue`` button. The issue list can be filtered on open, closed or your own issues. By clicking on an issue you can read the entire conversation and add a new comment.
+* **Documentation** - Here you can provide extra documentation on your resource.
 
 Update Resources
 """"""""""""""""
@@ -39,23 +41,23 @@ Sharing resources with Snippet
 """"""""""""""""""""""""""""""
 The Snippet feature in Simplifier enables you to quickly share resources with another Simplifier user (e.g. for review purposes) without storing them in your project. Click on the ``Snippet`` button in the top right corner to use this feature.
 
-.. image::../images/Snippet.PNG
+.. image:: ../images/Snippet.PNG
 
 Start by giving your Snippet a title, e.g. MyPatient. You can either upload a file or copy-paste your XML code in the editor. Select ``Add another file`` to upload more than one resource within the same Snippet. When you are finished uploading and editing your resources, click on the ``Create`` button on the right.
 
 Your Snippet will now be available on Simplifier. The URL is displayed at the top right of the Snippet. You can quickly copy the URL to your clipboard by clicking on the ``Copy`` icon at the right.
 
-.. image::../images/SnippetCopyLink.PNG
+.. image:: ../images/SnippetCopyLink.PNG
 
 When visiting the URL of a Snippet, you can choose to view either the XML code, JSON code or the rendered resource by selecting one of the available tabs. In the top right menu you can either select ``Edit`` to edit the resource, ``Clone`` to copy it in a new Snippet, ``New`` to create a new Snippet or ``Download`` to download the resource as a XML or JSON file. You can also validate the resource by using the green ``Validate`` button at the right.
 
-.. image::../images/Snippet2.PNG
+.. image:: ../images/Snippet2.PNG
 
 Personal Snippets
 -----------------
 Through your  `personal menu <../administration/simplifierPersonalContent.html#users>`_ (click on your avatar at the top right and select ``Snippets``) you can access a list of all your Snippets. From here you can also quickly add a new Snippet by clicking the green ``+New`` button.
 
-.. image::../images/MySnippets.PNG
+.. image:: ../images/MySnippets.PNG
 
 Metadata Expressions
 """"""""""""""""""""

diff --git a/images/Contact.PNG b/images/Contact.PNG
diff --git a/images/Forge.PNG b/images/Forge.PNG
diff --git a/images/ProjectSettings.PNG b/images/ProjectSettings.PNG
diff --git a/images/ProjectTabs.PNG b/images/ProjectTabs.PNG
diff --git a/images/Subscribe.PNG b/images/Subscribe.PNG
diff --git a/images/Subscriptions.PNG b/images/Subscriptions.PNG
diff --git a/index.rst b/index.rst
@@ -29,8 +29,8 @@ In addition to the release notes on `the Release notes page <https://docs.fire.l
   :caption: Simplifier.net Docs:
 
   Starting with Simplifier <getting_started/getting_started>
-  Team management <administration/administration>
-  Data Governance and Quality Control <data _governance_and_quality_control/data_governance_and_quality_control>
+  Team and Organization management <administration/administration>
+  Data Governance and Quality Control <data_governance_and_quality_control/data_governance_and_quality_control>
   Implementation Guide <implementation_guide/implementation_guide>
   Additional features and playgrounds<features/features>
   Release notes <simplifierReleaseNotes>