@gefyra/diffyr6-cli 1.1.3 → 1.2.0

package/README.md

@@ -107,6 +107,19 @@ fhir-r6-migrate --version
 fhir-r6-migrate --help
 ```
 
+**Managing Multiple IGs in Parallel**
+
+The `--config` parameter enables you to manage multiple implementation guides simultaneously. To do this, create separate config files for each IG and adjust the `workdir` field to point to different directories. All other paths (like `resourcesDir`, `resourcesR6Dir`, `compareDir`, and `outputDir`) can remain the same across configs, as they will be resolved relative to each specific `workdir`.
+
+Example:
+```bash
+# IG 1 configuration (config-basisprofil.json with "workdir": "./igs/basisprofil")
+fhir-r6-migrate --config config-basisprofil.json
+
+# IG 2 configuration (config-medikation.json with "workdir": "./igs/medikation") 
+fhir-r6-migrate --config config-medikation.json
+```
+
 ### Programmatic Usage
 
 ```javascript
@@ -301,10 +314,18 @@ The package includes a default set of rules for common migration issues. You can
 
 The impact score is calculated by summing the `value` field from all rule matches across all differences found.
 
+**Purpose:**
+
+The score is designed to **estimate the effort required for analysis**, not the effort required for the migration itself. Each finding represents a structural difference that requires review and evaluation to determine its implications for your implementation.
+
+**Why there are no zero scores:**
+
+Every detected element receives a score value, even for seemingly minor differences. This reflects the principle that each finding deserves at least a moment of attention during the analysis phase. Even small structural changes may have unexpected consequences that need to be evaluated in the context of your specific use case.
+
 **Interpretation:**
-- **0-50**: Low impact - minor differences, straightforward adaptation
-- **51-150**: Medium impact - moderate structural changes requiring attention
-- **151+**: High impact - significant breaking changes and redesign needed
+- **0-50**: Low analysis effort - minor differences, straightforward review
+- **51-150**: Medium analysis effort - moderate structural changes requiring careful attention
+- **151+**: High analysis effort - significant differences requiring thorough evaluation and planning
 
 ## Output
 

package/config/default-rules.json

@@ -45,8 +45,8 @@
           "template": "For element {{Name}}, the cardinality changed in R6 and it had an MS in R4: {{Comments}}"
         },
         {
-          "name": "Element type changed in R6",
-          "description": "The data type of an element has changed between R4 and R6. This may require data transformation during migration. Note that changes from 'string' to 'id' are not included in this rule.",
+          "name": "Element type changed in R6 at Must-Support",
+          "description": "The data type of an element has changed between R4 and R6. This may require data transformation during migration.",
           "rank": 15,
           "value": 10,
           "conditions": [
@@ -67,8 +67,13 @@
             },
             {
               "column": "L Type",
-              "operator": "!equals",
+              "operator": "!typeSubsetOf",
               "valueColumn": "R Type"
+            },
+            {
+              "column": "L Flags",
+              "operator": "contains",
+              "value": "This element must be supported"
             }
           ],
           "template": "The element type switched in R6 at element {{Name}} from {{L Type}} to {{R Type}}"
@@ -77,12 +82,17 @@
           "name": "Element removed in R6",
           "description": "An element from R4 no longer exists in R6. Data in this element may need to be migrated to another element or discarded.",
           "rank": 50,
-          "value": 2,
+          "value": 0,
           "conditions": [
             {
               "column": "Comments",
               "operator": "equals",
               "value": "Removed this element"
+            },
+            {
+              "column": "L Flags",
+              "operator": "!contains",
+              "value": "This element must be supported"
             }
           ],
           "template": "The element {{Name}} exists in R4 but was removed in R6."
@@ -110,7 +120,7 @@
           "name": "Element added in R6",
           "description": "A new optional element has been added in R6. This is usually unproblematic and offers new possibilities for data modeling.",
           "rank": 60,
-          "value": 2,
+          "value": 1,
           "conditions": [
             {
               "column": "Comments",
@@ -124,16 +134,50 @@
           "name": "Change in cardinality",
           "description": "The cardinality of an element has changed. Check whether this affects your implementation.",
           "rank": 40,
-          "value": 5,
+          "value": 0,
           "conditions": [
             {
               "column": "Comments",
               "operator": "contains",
               "value": "cardinalities differ"
+            },
+            {
+              "column": "L Flags",
+              "operator": "!contains",
+              "value": "This element must be supported"
             }
           ],
           "template": "For element {{Name}}, the cardinality changed in R6: {{Comments}}"
         },
+        {
+          "name": "Element type changed in R6",
+          "description": "The data type of an element has changed between R4 and R6. This may require data transformation during migration.",
+          "rank": 40,
+          "value": 0,
+          "conditions": [
+            {
+              "column": "R Type",
+              "operator": "!equals",
+              "value": "id"
+            },
+            {
+              "column": "L Type",
+              "operator": "!equals",
+              "value": ""
+            },
+            {
+              "column": "R Type",
+              "operator": "!equals",
+              "value": ""
+            },
+            {
+              "column": "L Type",
+              "operator": "!typeSubsetOf",
+              "valueColumn": "R Type"
+            }
+          ],
+          "template": "The element type switched in R6 at element {{Name}} from {{L Type}} to {{R Type}}"
+        },
         {
           "name": "R5 Preadoption Extensions",
           "description": "This profile uses R5 Preadoption Extensions that are not fully supported in R4-only contexts. Additional configuration may be needed for compatibility.",