Merge branch 'main' into authoring-changes

WorldHealthOrganization · Jun 13, 2024 · 37368d3 · 37368d3
2 parents 5ff455d + 0a5d43a
commit 37368d3
Show file tree

Hide file tree

Showing 27 changed files with 69 additions and 53 deletions.
diff --git a/input/images-source/concept-dictionary.plantuml b/input/images-source/concept-dictionary.plantuml
@@ -20,7 +20,7 @@ hide stereotype
     }
 
     class "**Common Dictionary**" as G<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ name 1..1
         |_ title 1..1
         |_ owner 1..*

diff --git a/input/images-source/model.plantuml b/input/images-source/model.plantuml
@@ -6,15 +6,15 @@ hide stereotype
 
 
 class "**BusinessProcess**" as Process<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1
     --
 }
 
     class "**Persona**" as Pers<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -25,7 +25,7 @@ class "**BusinessProcess**" as Process<<TM>> {
     }
 
     class "**Logical Model**" as LM<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ element 1..*
@@ -80,7 +80,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Functional Requirement**" as FReq<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -99,7 +99,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
     class "**AcceptanceCriteria**" as AC<<TM>> {
         |_ parentReq 1..1
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -110,7 +110,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Non-Functional Requirement**" as NFR<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -126,7 +126,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Data Element**" as DE<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1

diff --git a/input/images-source/model_codesystem.plantuml b/input/images-source/model_codesystem.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**CodeSystem**" as CS<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ url 1..*   
     |_ status 1..1
     |_ name 1..1

diff --git a/input/images-source/model_conceptmap.plantuml b/input/images-source/model_conceptmap.plantuml
@@ -7,7 +7,7 @@ hide stereotype
 
 
     class "**  ConceptMap  **" as CM<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ url 1..1
         |_ version 1..1
         |_ name 0..1

diff --git a/input/images-source/model_form.plantuml b/input/images-source/model_form.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**Form**" as F<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ url 1..*   
     |_ status 1..1
     |_ name 1..1

diff --git a/input/images-source/model_logicalmodel.plantuml b/input/images-source/model_logicalmodel.plantuml
@@ -7,7 +7,7 @@ hide stereotype
 
 
     class "**  Logical Model  **" as LM<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ element 1..*
@@ -17,8 +17,7 @@ hide stereotype
           |_ binding 0..1
           |_ comment 0..1
           |_ constraint 0..1
-          |_ code[SG] 1..1   
-            |_ code 1..1
+          |_ code 1..1   
           |_ code[other]
             |_ system 1..1
             |_ code 1..1

diff --git a/input/images-source/model_overall.plantuml b/input/images-source/model_overall.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**BusinessProcess**" as Process<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1
@@ -16,7 +16,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
 class "**BusinessProcess**" as Process<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1
@@ -25,7 +25,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 }
 
     class "**Persona**" as Pers<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -35,7 +35,7 @@ class "**BusinessProcess**" as Process<<TM>> {
         --
     }
     class "**Logical Model**" as LM<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ element 1..*
@@ -59,7 +59,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Functional Requirement**" as FReq<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -78,7 +78,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
     class "**AcceptanceCriteria**" as AC<<TM>> {
         |_ parentReq 1..1
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -89,7 +89,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Non-Functional Requirement**" as NFR<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
@@ -105,7 +105,7 @@ class "**BusinessProcess**" as Process<<TM>> {
 
 
     class "**Data Element**" as DE<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1

diff --git a/input/images-source/model_persona.plantuml b/input/images-source/model_persona.plantuml
@@ -6,13 +6,13 @@ hide stereotype
 
 
     class "**Persona**" as Pers<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
 '        |_ type = 'person'
 '        |_ experimental 1..1    
-        |_ description 1..1
+        |_ description 1..1  
         --
     }
 

diff --git a/input/images-source/model_process.plantuml b/input/images-source/model_process.plantuml
@@ -6,12 +6,12 @@ hide stereotype
 
 
 class "**BusinessProcess**" as Process<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1
     |_ description 1..1
-    |_ diagram_source 1..1  
+    |_ diagram_source 1..1    
     --
 }
 

diff --git a/input/images-source/model_profile.plantuml b/input/images-source/model_profile.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**Profile**" as P<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ url 1..*   
     |_ status 1..1
     |_ name 1..1

diff --git a/input/images-source/model_requirements.plantuml b/input/images-source/model_requirements.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**Requirement Set**" as RS<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1
@@ -17,7 +17,7 @@ class "**Requirement Set**" as RS<<TM>> {
 }
 
 class "**Requirement**" as R<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ category 0..*
     |_ strength 0..1
     --

diff --git a/input/images-source/model_scenario.plantuml b/input/images-source/model_scenario.plantuml
@@ -6,17 +6,17 @@ hide stereotype
 
 
     class "**Scenario**" as Scenario<<TM>> {
-        |_ identifier[SG] 1..*   
+        |_ identifier 1..*   
         |_ status 1..1
         |_ name 1..1
         |_ title 1..1
-        |_ description 1..1
+        |_ description 1..1  
         |_ actor 1..*
         |_ step 1..1
           |_ initiator 0..1
           |_ receiver 0..1
           |_ activity 0..1
-          |_ description 0..1
+          |_ description 0..1  
         --
     }
 

diff --git a/input/images-source/model_structuremap.plantuml b/input/images-source/model_structuremap.plantuml
@@ -6,7 +6,7 @@ hide stereotype
 
 
 class "**StrutureMap**" as StructureMap<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ status 1..1
     |_ name 1..1
     |_ title 1..1

diff --git a/input/images-source/model_valueset.plantuml b/input/images-source/model_valueset.plantuml
@@ -7,7 +7,7 @@ hide stereotype
 
 
 class "**ValueSet**" as VS<<TM>> {
-    |_ identifier[SG] 1..*   
+    |_ identifier 1..*   
     |_ url 1..*   
     |_ status 1..1
     |_ name 1..1

diff --git a/input/pagecontent/diagram_legend.md b/input/pagecontent/diagram_legend.md
@@ -29,7 +29,7 @@ The relations are represented by arrows
 
 - **Flows to**: A relationship where an activity (process) is followed by another activity
 
-<figure>
+<figure style = "width:90em; max-width:90%">
   {% include diagram-arrows.svg %}
 </figure>
 

diff --git a/input/pagecontent/gov_concepts.md b/input/pagecontent/gov_concepts.md
@@ -19,7 +19,7 @@ See section "Semantic Compatibility Assessment" for more details.
 The introduction of concept management (by means of common data dictionaries) enables a more complete approach to semantic interoperability.
 
 Each concept in the Commons dictionary has therefore its definition and mappings:
-<figure>
+<figure style = "width:25em">
   {% include concept-dictionary.svg %}
   <figcaption>Concepts and Dictionary - metadata</figcaption>
 </figure>

diff --git a/input/pagecontent/ig_setup.md b/input/pagecontent/ig_setup.md
@@ -1,4 +1,20 @@
-When starting L3, if an ImplementationGuide is not present, it should be created now.
+Each L3 layer of SMART Guidelines for a health programme area is represented in an individual Implementation Guide. The first step in starting a L3 FHIR IG is to create a FHIR IG in a GitHub repository. This page is a guide on how to setup a FHIR IG repository for L3.
+
+### Repositories
+
+A SMART Guidelines Implementation Guide makes use of existing tooling and content, to create a consistent ecosystem and allow L3 developers to focus on the authoring and validation.
+
+The key repositories that play a role are identified in the diagram below:
+
+<figure style = "width:90em; max-width:90%">
+  {% include dependencies.svg %}
+</figure>
+
+
+### Repository Setup
+The [SMART-Empty repository](https://github.com/WorldHealthOrganization/smart-ig-empty) is the repository that should be forked to create a new Implementation Guide.
+
+To do so, click on "Use this Template" option in Github. **Ensure that the option to "Include all branches".** so that the `gh-pages` branch is also cloned. Otherwise you must create it manually. 
 
 * For WHO repositories: WHO will create it upon request.
 * For adaptations: the responsible organization will create it. They may use some of the WHO infrastructure.

diff --git a/input/pagecontent/l3_codesystems.md b/input/pagecontent/l3_codesystems.md
@@ -4,7 +4,7 @@ In particular, each SMART guideline will have a guideline-level code system defi
 
 In addition, sometimes existing code systems need to be completed, for example adding designations in different languages to codes, or adding relationships between vaccine codes.
 
-<figure style="width:30%">
+<figure style = "width:25em">
   {% include model_codesystem.svg %}
 </figure>
 

diff --git a/input/pagecontent/l3_forms.md b/input/pagecontent/l3_forms.md
@@ -2,7 +2,7 @@ Data used in the different stages of the business processes can be captured from
 
 Since the purpose of the forms is to expose data in a user-friendly manner (and following the L2 DAK data structures), it is expected that several of these forms will result in the data being extracted to FHIR-native resources, like Patient, Observation, Condition, etc.
 This means the L2 data structures are represented both as instances Questionnaires and as FHIR resource profiles, and these FHIR resources can be obtained natively or by extracting a QuestionnaireResponse:
-<img src="./forms_resources.png" style="width:50%"/>
+<img src="./forms_resources.png" style="width:40%"/>
 <br clear="all"/>
 
 
@@ -12,12 +12,12 @@ SMART Guidelines make use of the [FHIR Structured Data Capture specification](ht
 * Data extraction
 
 Forms are reuse other forms and make use of value sets. 
-<figure>
+<figure style = "width:25em">
   {% include model_form.svg %}
 </figure>
 
 This extraction uses [structure maps](l3_structuremaps.html) and is represented as follows:
-<figure>
+<figure style = "width:75em; max-width:90%">
   {% include extraction.svg %}
 </figure>
 

diff --git a/input/pagecontent/l3_logicalmodels.md b/input/pagecontent/l3_logicalmodels.md
@@ -11,7 +11,7 @@ Logical models relate to other models in 3 aspects:
 
 
 Each Logical Model is defined by the following data:
-<figure style = "width:30%">
+<figure style = "width:30em">
   {% include model_logicalmodel.svg %}
 </figure>
 
@@ -24,9 +24,10 @@ Each Logical Model is defined by the following data:
 
 * Logical Models in `input/models` or `fsh/models`
 
-### **Activities**
+### **Activities:**  
+
+This is the overview of the activities and related artifacts used:  
 
-This is the overview of the activities and related artifacts used:
 <img src="./l3_process_logicalmodel.png" style="width:50%"/>
 <br clear="all"/>
 

diff --git a/input/pagecontent/l3_personas.md b/input/pagecontent/l3_personas.md
@@ -1,7 +1,7 @@
 ActorDefinitions are the ways that the Personas are structured; A common repository of Personas allows reuse, exchange, change tracking, etc.  
 
 Each Persona is defined by the following data:
-<figure style = "width:30%">
+<figure style = "width:15em">
   {% include model_persona.svg %}
 </figure>
 

diff --git a/input/pagecontent/l3_processes.md b/input/pagecontent/l3_processes.md
@@ -3,7 +3,7 @@ Business processes are structured into FHIR PlanDefinitions. This can be used to
 The L3 author must ensure there is a PlanDefinition for each Business Process mentioned in the L2. 
 
 The data required to be captured for each Business Process is:
-<figure style="width:30%">
+<figure style = "width:15em">
   {% include model_process.svg %}
 </figure>