Skip to content

Commit

Permalink
Merge pull request #14 from FirelyTeam/Update_scaling
Browse files Browse the repository at this point in the history
Updated scaling, added yaml
  • Loading branch information
Rob5045 committed Jul 27, 2023
2 parents b916ae0 + f46805e commit 170e08e
Show file tree
Hide file tree
Showing 14 changed files with 88 additions and 12 deletions.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.7"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: ./conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
1 change: 1 addition & 0 deletions Features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ user-interface.

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

With Forge you can:

Expand Down
2 changes: 1 addition & 1 deletion _static/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ a.icon-home:hover {

}
.wy-nav-content {
max-width: 800px;
max-width: 95%;
width: 100%;

word-wrap: break-word;
Expand Down
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'Forge'
copyright = '2022, Firely'
copyright = '2023, Firely'
author = 'Firely'


Expand All @@ -27,7 +27,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.intersphinx', 'recommonmark']
extensions = ['sphinx.ext.intersphinx']

intersphinx_mapping = {
'main_docs': ('https://docs.fire.ly', None),
Expand Down
6 changes: 6 additions & 0 deletions features/CreateDerivedProfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ profile.

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

Adding dependencies
-------------------
Expand All @@ -43,6 +44,7 @@ Select **hl7.fhir.us.core** in the list and then select package version

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

Click the ``Project`` tab to see what packages are installed. Notice
that dependent packages are installed too.
Expand All @@ -58,17 +60,20 @@ To create a derived profile for the US Core Patient, open the package

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

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

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

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%

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 @@ -82,3 +87,4 @@ differential will reflect constraints on the national profile.

.. figure:: ../images/Profilehierarchy.png
:alt: The hierarchy and conformance between FHIR profiles
:scale: 75%
3 changes: 3 additions & 0 deletions features/CreateLogicalModels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +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%

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 @@ -25,11 +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%

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%

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
1 change: 1 addition & 0 deletions features/CreatenewProfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Resources or DataTypes.

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

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

.. figure:: ../images/ConstraintsCardinality.png
:alt: Set element cardinality in Forge

:scale: 75%

Element Type
------------

Expand All @@ -38,11 +39,17 @@ be a reference to another Resource profile. Forge automatically gives
the profile as a Type option if the profile is opened in the session
explorer and the profile's base Resource fits the element.

*Setting Observation.value[x] types in Forge* |Setting
Observation.value[x] types in Forge|
.. figure:: ../images/ConstraintsType.png
:alt: Setting valueset binding in Forge
:scale: 75%

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

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

*Setting Observation.subject reference type in Forge* |Setting
Observation.subject reference type in Forge|
*Setting Observation.subject reference type in Forge*

Valueset binding
----------------
Expand All @@ -56,6 +63,7 @@ value.

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

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

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

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

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

.. |Setting Observation.value[x] types in Forge| image:: ../images/ConstraintsType.png
.. |Setting Observation.subject reference type in Forge| image:: ../images/ConstraintsTypeReference.png
7 changes: 7 additions & 0 deletions features/DefineExtensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ in in the HL7 extension registry.

.. figure:: ../images/PatientExtensionBirthPlace.png
:alt: Editing an extension with Forge
:scale: 75%

New extension
-------------
Expand All @@ -28,6 +29,7 @@ context information for this new extension.

.. figure:: ../images/PatientExtensionBirthPlaceContext.png
:alt: Editing an extension context with Forge
:scale: 75%

Provide this information in ``Properties`` tab of the extension. Context
Type indicates if the extension extends a Resource, Datatype, Mapping or
Expand All @@ -36,6 +38,7 @@ another Extension. Give the exact context by clicking the button next to

.. figure:: ../images/PatientExtensionBirthPlaceContextExpressionButton.png
:alt: Editing an extension context with Forge
:scale: 75%

This brings you to a new screen were you can select the specific
resource or datatype where the extension is allowed to be placed. If you
Expand All @@ -47,6 +50,7 @@ relevant information in the properties section as well.

.. figure:: ../images/SelectingExtensionContext.png
:alt: Selecting Extension context in Forge
:scale: 75%

Extension profile
-----------------
Expand All @@ -73,6 +77,7 @@ to your project folder or add a package to your project folder.

.. figure:: ../images/AddPackage.png
:alt: Adding a package to your project
:scale: 75%

Select the element in the Element Tree of your profile where you want to
add the extension. Then, click ``Extend`` which is shown in the tool
Expand All @@ -86,6 +91,7 @@ Forge shows the extensions that are available in your project folder.

.. figure:: ../images/SelectExtension.png
:alt: Adding an extension to a profile in Forge
:scale: 75%

Note that you can only select extensions that are compatible with your
context (e.g. when extending an AdverseEvent resource you can only
Expand All @@ -95,3 +101,4 @@ extensions by clicking ``Filter`` to turn off filtering.

.. figure:: ../images/SelectExtensionFilter.png
:alt: Showing only compatible extensions in Forge
:scale: 75%
5 changes: 4 additions & 1 deletion features/DefineSlices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Select the element that you want to slice and click on ``Slice``.

.. figure:: ../images/SliceCreate.png
:alt: Slicing an element in Forge
:scale: 75%

The element is now ‘Sliced’ and it is possible to add slices by clicking
``Add Slice``. You can create as many slices as necessary by selecting
Expand All @@ -31,6 +32,7 @@ message that there is no discriminator defined for the sliced elements.

.. figure:: ../images/SliceCreated.png
:alt: Slicing an element in Forge
:scale: 75%

The discriminator is used to distinguish the sliced elements from one
another. The discriminators in their sum should allow applications to
Expand All @@ -40,7 +42,8 @@ element under **Slicing Details**.

.. figure:: ../images/SlicingDetails.png
:alt: Slicing an element in Forge

:scale: 75%

More information concerning slicing and discriminators can be found
here: http://hl7.org/fhir/profiling.html.

Expand Down
5 changes: 5 additions & 0 deletions features/EditProfiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ detail.

.. figure:: ../images/EditProfileTabs.png
:alt: The tabs in Forge for editing a profile
:scale: 75%

Properties
----------
Expand All @@ -18,6 +19,7 @@ the ``Properties`` tab.

.. figure:: ../images/ElementProperties.png
:alt: The Properties overview in Forge
:scale: 75%

Narrative
---------
Expand All @@ -31,6 +33,7 @@ profile.

.. figure:: ../images/ElementNarrative.png
:alt: The Narrative overview in Forge
:scale: 75%

Element Tree and Element Grid
-----------------------------
Expand All @@ -44,6 +47,7 @@ Element Tree

.. figure:: ../images/ElementTree.png
:alt: The Element Tree overview in Forge
:scale: 75%

Via the ``Element Tree`` tab you can edit Element Properties, slice
Elements, or add extensions.
Expand All @@ -53,6 +57,7 @@ Element Grid

.. figure:: ../images/ElementGrid.png
:alt: The Element Grid overview in Forge
:scale: 75%

XML viewer
----------
Expand Down

0 comments on commit 170e08e

Please sign in to comment.