add the readme file and fix a rule set bug

gematik · Aug 23, 2024 · 61a6a0e · 61a6a0e
1 parent 4cd6302
commit 61a6a0e
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 52 deletions.
diff --git a/API-Examples/FSH-Files/README.md b/API-Examples/FSH-Files/README.md
@@ -0,0 +1,23 @@
+# Documentation Guide
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Instructions](#instructions)
+  - [Generating the Examples](#generating-the-examples)
+  - [Updating or Adding Examples](#updating-or-adding-examples)
+
+## Introduction
+This folder contains the FSH files and a script to recreate the examples for the API documentation of a specific Workflow Package profile.
+
+## Instructions
+### Generating the Examples
+Follow these steps to produce the examples for the specified version:
+1. Update the version parameters in the `Versioning.fsh` file.
+2. Run the `main.sh` script.
+3. The examples will be generated in the `output` folder.
+
+### Updating or Adding Examples
+The examples are located in the `/input/fsh/examples` folder, with subfolders corresponding to the various pages. These FSH files can be modified, and new ones can be added.
+
+- Any examples that need to remain as JSON files and not be converted to XML files should be added to the `/scripts/process_files.sh` script.
+- Any non-FSH files added to the input folders will be copied as-is to the corresponding subfolder in the `output` folder. This is useful for non-FHIR examples that are also being displayed.
diff --git a/API-Examples/FSH-Files/fsh-generated/fsh-index.json b/API-Examples/FSH-Files/fsh-generated/fsh-index.json
@@ -45,15 +45,15 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_abrufen\\07_request_taskCloseMultiple.fsh",
     "startLine": 1,
-    "endLine": 10
+    "endLine": 9
   },
   {
     "outputFile": "Bundle-erp-abrufen-09-response-taskClose.json",
     "fshName": "erp-abrufen-09-response-taskClose",
     "fshType": "Instance",
     "fshFile": "examples\\erp_abrufen\\09_response_taskClose.fsh",
     "startLine": 1,
-    "endLine": 22
+    "endLine": 21
   },
   {
     "outputFile": "Bundle-erp-abrufen-10-response-taskGet.json",
@@ -261,55 +261,55 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\01_request_PostPatientToPharmacy.fsh",
     "startLine": 1,
-    "endLine": 28
+    "endLine": 27
   },
   {
     "outputFile": "Communication-erp-communication-02-response-PostPatientToPharmacy.json",
     "fshName": "erp-communication-02-response-PostPatientToPharmacy",
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\02_response_PostPatientToPharmacy.fsh",
     "startLine": 1,
-    "endLine": 33
+    "endLine": 32
   },
   {
     "outputFile": "Communication-erp-communication-03-request-PostPharmacyToPatient.json",
     "fshName": "erp-communication-03-request-PostPharmacyToPatient",
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\03_request_PostPharmacyToPatient.fsh",
     "startLine": 1,
-    "endLine": 10
+    "endLine": 9
   },
   {
     "outputFile": "Communication-erp-communication-04-response-PostPharmacyToPatient.json",
     "fshName": "erp-communication-04-response-PostPharmacyToPatient",
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\04_response_PostPharmacyToPatient.fsh",
     "startLine": 1,
-    "endLine": 15
+    "endLine": 14
   },
   {
     "outputFile": "Communication-erp-communication-05-request-RezeptZuweisen.json",
     "fshName": "erp-communication-05-request-RezeptZuweisen",
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\05_request_RezeptZuweisen.fsh",
     "startLine": 1,
-    "endLine": 10
+    "endLine": 9
   },
   {
     "outputFile": "Communication-erp-communication-06-response-RezeptZuweisen.json",
     "fshName": "erp-communication-06-response-RezeptZuweisen",
     "fshType": "Instance",
     "fshFile": "examples\\erp_communication\\06_response_RezeptZuweisen.fsh",
     "startLine": 1,
-    "endLine": 15
+    "endLine": 14
   },
   {
     "outputFile": "Communication-erp-diga-03-communication-zuweisung-diga.json",
     "fshName": "erp-diga-03-communication-zuweisung-diga",
     "fshType": "Instance",
     "fshFile": "examples\\erp_diga\\03_communication_zuweisung_diga.fsh",
     "startLine": 1,
-    "endLine": 15
+    "endLine": 14
   },
   {
     "outputFile": "Consent-erp-consent-01-request-PostConsent.json",
@@ -333,31 +333,31 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_eml_epa_notes\\03_Medication-Medication-Rezeptur.fsh",
     "startLine": 1,
-    "endLine": 29
+    "endLine": 28
   },
   {
     "outputFile": "Medication-erp-eml-epa-notes-04-Medication-Medication-Kombipackung.json",
     "fshName": "erp-eml-epa-notes-04-Medication-Medication-Kombipackung",
     "fshType": "Instance",
     "fshFile": "examples\\erp_eml_epa_notes\\04_Medication-Medication-Kombipackung.fsh",
     "startLine": 1,
-    "endLine": 19
+    "endLine": 18
   },
   {
     "outputFile": "MedicationDispense-erp-abrufen-06-request-taskClose.json",
     "fshName": "erp-abrufen-06-request-taskClose",
     "fshType": "Instance",
     "fshFile": "examples\\erp_abrufen\\06_request_taskClose.fsh",
     "startLine": 1,
-    "endLine": 17
+    "endLine": 16
   },
   {
     "outputFile": "MedicationDispense-erp-abrufen-08-response-taskDispense.json",
     "fshName": "erp-abrufen-08-response-taskDispense",
     "fshType": "Instance",
     "fshFile": "examples\\erp_abrufen\\08_response_taskDispense.fsh",
     "startLine": 1,
-    "endLine": 17
+    "endLine": 16
   },
   {
     "outputFile": "MedicationDispense-erp-diga-04-medication-dispense-diga.json",
@@ -373,7 +373,7 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_diga\\06_medication_dispense_diga.fsh",
     "startLine": 1,
-    "endLine": 18
+    "endLine": 17
   },
   {
     "outputFile": "OperationOutcome-erp-statuscodes-01-example-operationOutcome-validation.json",
@@ -405,15 +405,15 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_eml_epa_notes\\01_Parameters-ExampleCloseInputParameters.fsh",
     "startLine": 1,
-    "endLine": 42
+    "endLine": 40
   },
   {
     "outputFile": "Parameters-erp-eml-epa-notes-02-Parameters-ExampleInputMultipleDispenses.json",
     "fshName": "erp-eml-epa-notes-02-Parameters-ExampleInputMultipleDispenses",
     "fshType": "Instance",
     "fshFile": "examples\\erp_eml_epa_notes\\02_Parameters-ExampleDispenseInputParametersMultipleMedicationDispenses.fsh",
     "startLine": 1,
-    "endLine": 83
+    "endLine": 82
   },
   {
     "outputFile": "Parameters-erp-steuerung-durch-le-01-request-taskCreate169.json",
@@ -453,38 +453,38 @@
     "fshType": "Instance",
     "fshFile": "examples\\erp_bereitstellen\\01_response_taskCreate.fsh",
     "startLine": 1,
-    "endLine": 22
+    "endLine": 21
   },
   {
     "outputFile": "Task-erp-bereitstellen-05-response-taskActivate.json",
     "fshName": "erp-bereitstellen-05-response-taskActivate",
     "fshType": "Instance",
     "fshFile": "examples\\erp_bereitstellen\\05_response_taskActivate.fsh",
     "startLine": 1,
-    "endLine": 31
+    "endLine": 30
   },
   {
     "outputFile": "Task-erp-diga-01-task-162-create.json",
     "fshName": "erp-diga-01-task-162-create",
     "fshType": "Instance",
     "fshFile": "examples\\erp_diga\\01_task_162_create.fsh",
     "startLine": 1,
-    "endLine": 21
+    "endLine": 20
   },
   {
     "outputFile": "Task-erp-steuerung-durch-le-02-response-taskCreate169.json",
     "fshName": "erp-steuerung-durch-le-02-response-taskCreate169",
     "fshType": "Instance",
     "fshFile": "examples\\erp_steuerung_durch_le\\02_response_taskCreate169.fsh",
     "startLine": 1,
-    "endLine": 24
+    "endLine": 23
   },
   {
     "outputFile": "Task-erp-steuerung-durch-le-04-response-taskActivate.json",
     "fshName": "erp-steuerung-durch-le-04-response-taskActivate",
     "fshType": "Instance",
     "fshFile": "examples\\erp_steuerung_durch_le\\04_response_taskActivate.fsh",
     "startLine": 1,
-    "endLine": 26
+    "endLine": 25
   }
 ]