From 392e46906845cd559a7af04dbe42fd373affc5de Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Fri, 17 May 2024 10:07:31 +0200
Subject: [PATCH] [bugfix] Changed examples in terms dictionary to yaml and
 better explained user how to use  a dict.

---
 schemas/TermsDictionary.yaml | 50 ++++++++++++++----------------------
 1 file changed, 19 insertions(+), 31 deletions(-)

diff --git a/schemas/TermsDictionary.yaml b/schemas/TermsDictionary.yaml
index 631a638..fd047be 100644
--- a/schemas/TermsDictionary.yaml
+++ b/schemas/TermsDictionary.yaml
@@ -1,6 +1,6 @@
 description: |-
-  Provides definitions of codes used in the rest of this response.
-  
+  Provides definitions of codes used in the rest of this response. Only codes used in the response messages are added to the dictionary. For example: if the response doesn't enclose measurements, then these are not in the dictionary. If the response holds feat codes 12001 and 12004, but not 12011, then the dictionary holds 12001 and 12004, but not 12011.
+
   Always sent first.
 type: object
 properties:
@@ -13,24 +13,19 @@ properties:
       value of such a measurement can be looked up in the `nhgAnswers` entry.
     type: object
     additionalProperties: true
-    example: |-
-      {
-        "DMHBTZ": {
-          "num": 2206,
-          "text": "hoofdbehandelaar diabetes",
-          "nhgVal": true
-        }
-      }
+    example: 
+      "DMHBTZ":
+        "num": 2206
+        "text": "hoofdbehandelaar diabetes"
+        "nhgVal": true
   nhgAnswers:
     description: |-
       Enumerated NHG answers (the answer to any measurements with `"nhgVal": true`) can be looked up here.
     type: object
     additionalProperties: true
-    example: |-
-      {
-        "48": "Huisarts",
-        "49": "Specialist"
-      }
+    example: 
+      "48": "Huisarts"
+      "49": "Specialist"
   icpcs:
     description: |-
       Represents diagnoses and medical conditions, based on the ICPC1.1-NL standard. Keys in this object represent ICPC codes, always
@@ -39,25 +34,18 @@ properties:
       containing the dutch human readable name of the class (the letter).
     type: object
     additionalProperties: true
-    example: |-
-      {
-        "T90.02": {
-          "text": "Diabetes mellitus type 2",
-          "classText": "Endocriene klieren/metabol./voeding"
-        }
-      }
+    example:
+      "T90.02":
+        "text": "Diabetes mellitus type 2"
+        "classText": "Endocriene klieren/metabol./voeding"
   atcs:
     description: |-
       Represents medications, mapping ATC codes to value objects containing one k/v pair: `"text"` to a dutch human readable
       description of the medication. The ATC codes may represent groups of medications (less than 7 characters).
     type: object
     additionalProperties: true
-    example: |-
-      {
-        "A02AB": {
-          "text": "Aluminiumverbindingen"
-        },
-        "A11GA01": {
-          "text": "Ascorbinezuur"
-        }
-      }
\ No newline at end of file
+    example:
+      "A02AB":
+        "text": "Aluminiumverbindingen"
+      "A11GA01":
+        "text": "Ascorbinezuur"