Skip to content

Commit

Permalink
update diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
costateixeira committed Jun 14, 2024
1 parent 6c27ade commit 70ec0bc
Show file tree
Hide file tree
Showing 18 changed files with 97 additions and 14 deletions.
4 changes: 3 additions & 1 deletion archimate/WHO_SMART_GUIDELINES.archimate
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,9 @@
<bounds x="336" y="300" width="85" height="49"/>
<sourceConnection xsi:type="archimate:Connection" id="id-e29f9416bd52456783a5483c25a5839c" source="id-c9b765411d134c148412bf0ae3d0c8cb" target="id-1ea76d02b1e8441e8a506f2b4f5c3f23" archimateRelationship="id-8f05793d1a3c44c8aae7f70af2cbc52d"/>
<sourceConnection xsi:type="archimate:Connection" id="id-8ff42b0d4e4a4b8db30cc8a85821a9f5" source="id-c9b765411d134c148412bf0ae3d0c8cb" target="id-c930201f198e4255a35654fd23f53f11" archimateRelationship="id-4144bd05939740369d3d0d09a4d4406a"/>
<sourceConnection xsi:type="archimate:Connection" id="id-d72538d528014476af016b68dfd87e2a" source="id-c9b765411d134c148412bf0ae3d0c8cb" target="id-40257793a57c47a19493cdf5ae7ed97f" archimateRelationship="id-2886794574e04e30a8e7fe5de064264b"/>
<sourceConnection xsi:type="archimate:Connection" id="id-d72538d528014476af016b68dfd87e2a" source="id-c9b765411d134c148412bf0ae3d0c8cb" target="id-40257793a57c47a19493cdf5ae7ed97f" archimateRelationship="id-2886794574e04e30a8e7fe5de064264b">
<bendpoint startX="126" startY="72" endX="-66" endY="-36"/>
</sourceConnection>
<sourceConnection xsi:type="archimate:Connection" id="id-1d49fe15e7fe4743a1f106c5fcc84ce8" source="id-c9b765411d134c148412bf0ae3d0c8cb" target="id-5ab3399dfe6d4cee8248a3a3e761b7ec" archimateRelationship="id-6488c5b6bcb5405c93b5f75d4109a220"/>
</child>
<child xsi:type="archimate:DiagramObject" id="id-c930201f198e4255a35654fd23f53f11" targetConnections="id-8ff42b0d4e4a4b8db30cc8a85821a9f5" archimateElement="id-86a13f6f6c2d416a81bc4c4cc7c54b7e" type="1">
Expand Down
10 changes: 9 additions & 1 deletion input/images-source/concept-dictionary.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ hide stereotype
--
}

class "**Common Dictionary**" as G<<TM>> {
class "**Data Dictionary**" as G<<TM>> {
|_ identifier 1..*
|_ name 1..1
|_ title 1..1
Expand All @@ -31,4 +31,12 @@ hide stereotype

C "*" -o "1" G :" "


legend
Data needs
for concepts
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
5 changes: 5 additions & 0 deletions input/images-source/model_codesystem.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,10 @@ CS - CSS : " Extends "

CS -- CSU : " Uses "

legend
Data needs
for code systems
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend

@enduml
5 changes: 5 additions & 0 deletions input/images-source/model_conceptmap.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ hide stereotype
}


legend
Data needs
for concept maps
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
6 changes: 6 additions & 0 deletions input/images-source/model_form.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,11 @@ F - MF : " Reuses "

F -- VS : " Contains "

legend
Data needs
for forms
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
5 changes: 5 additions & 0 deletions input/images-source/model_logicalmodel.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ LMP -r[hidden]-|> LMR : " "
LMR -D[hidden]- LMD : " \n\n\n\n\n "
'LM -u- LMR : " "

legend
Data needs
for logical models
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
8 changes: 7 additions & 1 deletion input/images-source/model_persona.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,11 @@ hide stereotype
--
}



legend
Data needs
for personas
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend

@enduml
7 changes: 7 additions & 0 deletions input/images-source/model_process.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,11 @@ class "**BusinessProcess**" as Process<<TM>> {
--
}

legend
Data needs for
business processes
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
6 changes: 6 additions & 0 deletions input/images-source/model_profile.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,11 @@ ED -r[hidden]- C : " "

P -- ED : " Contains "

legend
Data needs
for profiles
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
8 changes: 8 additions & 0 deletions input/images-source/model_requirements.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,12 @@ R -u-* RS
FR -u-|> R
NFR -u-|> R


legend
Data needs
for requirements
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
8 changes: 7 additions & 1 deletion input/images-source/model_scenario.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,11 @@ hide stereotype
--
}


legend
Data needs
for scenarios
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
7 changes: 7 additions & 0 deletions input/images-source/model_structuremap.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,11 @@ class "**StrutureMap**" as StructureMap<<TM>> {
--
}

legend
Data needs for
structure maps
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend


@enduml
5 changes: 5 additions & 0 deletions input/images-source/model_valueset.plantuml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,10 @@ class "**ValueSet**" as VS<<TM>> {
--
}

legend
Data needs
for value sets
(see [[./diagram_legend.html#data-object-details-with-plantuml legend]])
endlegend

@enduml
5 changes: 5 additions & 0 deletions input/images-source/style.iuml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ skinparam {
' See Custom Style section below to override items here.

skinparam {

LegendBorderThickness 0
LegendBorderColor transparent
LegendBackgroundColor transparent

svgDimensionStyle false
' Global Options
'DPI 200
Expand Down
Binary file modified input/images/content_types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified input/images/forms_resources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 11 additions & 9 deletions input/pagecontent/diagram_legend.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ This specification uses:

### ArchiMate Notation Overview

#### Layers:
#### Layers

- **Application Layer**: Offers a functional description, typically illustrating processes, functions, and services. This is represented by blue elements.

- **Technology Layer**: Represents actual artifacts, like files, resource instances, or other data objects. This is represented by green elements.

#### Relations :
#### Relations

The relations are represented by arrows

Expand All @@ -29,15 +29,14 @@ The relations are represented by arrows

- **Flows to**: A relationship where an activity (process) is followed by another activity

<figure style = "width:90em; max-width:90%">
<figure style = "width:80em; max-width:90%">
{% include diagram-arrows.svg %}
</figure>


#### Example Diagram:
<img src="./l3_process_indicator.png" style="width:50%"/>
<br clear="all"/>
> The diagram above shows the process for creating an indicator:
#### Example Diagram

The diagram below represents the process for creating an indicator:
* The input artifact is an L2 definition of an indicator (in a spreadsheet)
* The main process is to create an L3 Measure artifact
* To define the Measure, there's a subprocess where the L3 author adds population and stratifiers, by consulting the cqf-measures-guidance.
Expand All @@ -46,13 +45,16 @@ The relations are represented by arrows
* The output of this is the L3 library that is referenced by the Measure resource


<img src="./l3_process_indicator.png" style="width:50%"/>
<br clear="all"/>


### Artifact Authoring Processes

The diagrams capture the essence of transforming an L2 input into the corresponding L3 artifacts through processes. These processes can use different tooling or technologies; however the criteria for output and for process are defined.


### Data Object Details with PlantUML

To describe the content L3 authors are supposed to produce, the key content of the output artifacts is modeled with PlantUML diagrams. This discloses some of the intended structure, relationships, and attributes of the L3 artifacts.

To describe the content L3 authors are supposed to produce, the key content of the output artifacts is modeled with PlantUML diagrams. This diagram summarizes the data that is part of an object definition. For example, For a ValueSet, the L3 author is required to have a status, a name, an identifier and a URL...

2 changes: 1 addition & 1 deletion input/pagecontent/gov_overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SMART Guidelines L3 artifacts can be shared. This means that they can be maintained and possibly reused and referenced across Guidelines.
SMART Guidelines artifacts are meant to be interoperable and shared. This means that they can be maintained and possibly reused and referenced across Guidelines.

The authoring process currently identifies some artifacts that are subject to "common" governance i.e. being maintained not within one single guideline, but as possibly reusable artifacts:

Expand Down

0 comments on commit 70ec0bc

Please sign in to comment.