343 - Fixed the ValueSets Code: ">" for Markdown Table (#3204)

* 343 - Fixed the ValueSets Code: ">" for Markdown Table Code: ">" in common.valuesets table hl70078 is the blockquote markdown control character. We need to user ">" (html code symbol for ">" instead. * Added Unit Test case for checking the > (special character for >)
CDCgov · Dec 9, 2021 · b22bf3e · b22bf3e
1 parent c69a983
commit b22bf3e
Show file tree

Hide file tree

Showing 31 changed files with 62 additions and 30 deletions.
diff --git a/prime-router/docs/schema_documentation/az-az-covid-19-hl7.md b/prime-router/docs/schema_documentation/az-az-covid-19-hl7.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/co-co-covid-19-redox.md b/prime-router/docs/schema_documentation/co-co-covid-19-redox.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/covid-19-gaen.md b/prime-router/docs/schema_documentation/covid-19-gaen.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/covid-19-redox.md b/prime-router/docs/schema_documentation/covid-19-redox.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/covid-19.md b/prime-router/docs/schema_documentation/covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/direct-careevolution-covid-19.md b/prime-router/docs/schema_documentation/direct-careevolution-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/direct-hca-covid-19.md b/prime-router/docs/schema_documentation/direct-hca-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/fl-fl-covid-19.md b/prime-router/docs/schema_documentation/fl-fl-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/gu-gu-covid-19.md b/prime-router/docs/schema_documentation/gu-gu-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/hl7-hl7-ingest-covid-19.md b/prime-router/docs/schema_documentation/hl7-hl7-ingest-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/hl7-lifepoint-covid-19.md b/prime-router/docs/schema_documentation/hl7-lifepoint-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/hl7-prescryptive-covid-19.md b/prime-router/docs/schema_documentation/hl7-prescryptive-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/hl7-primary-covid-19.md b/prime-router/docs/schema_documentation/hl7-primary-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/hl7-test-covid-19.md b/prime-router/docs/schema_documentation/hl7-test-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/la-la-covid-19.md b/prime-router/docs/schema_documentation/la-la-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/mt-mt-covid-19.md b/prime-router/docs/schema_documentation/mt-mt-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/nd-nd-covid-19.md b/prime-router/docs/schema_documentation/nd-nd-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/nm-nm-covid-19.md b/prime-router/docs/schema_documentation/nm-nm-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/oh-oh-covid-19.md b/prime-router/docs/schema_documentation/oh-oh-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/or-or-covid-19-hl7.md b/prime-router/docs/schema_documentation/or-or-covid-19-hl7.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/pa-pa-covid-19-hl7.md b/prime-router/docs/schema_documentation/pa-pa-covid-19-hl7.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/pa-pa-covid-19-redox.md b/prime-router/docs/schema_documentation/pa-pa-covid-19-redox.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/primedatainput-pdi-covid-19.md b/prime-router/docs/schema_documentation/primedatainput-pdi-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/standard-standard-covid-19.md b/prime-router/docs/schema_documentation/standard-standard-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/strac-strac-covid-19.md b/prime-router/docs/schema_documentation/strac-strac-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/tpca-tpca-covid-19.md b/prime-router/docs/schema_documentation/tpca-tpca-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/tx-tx-covid-19.md b/prime-router/docs/schema_documentation/tx-tx-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/vt-vt-covid-19.md b/prime-router/docs/schema_documentation/vt-vt-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/docs/schema_documentation/waters-waters-covid-19.md b/prime-router/docs/schema_documentation/waters-waters-covid-19.md
@@ -17,7 +17,7 @@
 Code | Display
 ---- | -------
 A|Abnormal (applies to non-numeric results)
->|Above absolute high-off instrument scale
+&#62;|Above absolute high-off instrument scale
 H|Above high normal
 HH|Above upper panic limits
 AC|Anti-complementary substances present

diff --git a/prime-router/src/main/kotlin/DocumentationFactory.kt b/prime-router/src/main/kotlin/DocumentationFactory.kt
@@ -197,7 +197,8 @@ ${element.documentation}
             appendable.appendLine("---- | -------")
 
             values.forEach { vs ->
-                appendable.appendLine("${vs.code}|${vs.display}")
+                val code = if (vs.code == ">") "&#62;" else vs.code // This to solve the markdown blockquote '>'
+                appendable.appendLine("$code|${vs.display}")
             }
             appendable.appendLine("")
         }

diff --git a/prime-router/src/test/kotlin/DocumentationTests.kt b/prime-router/src/test/kotlin/DocumentationTests.kt
@@ -79,4 +79,35 @@ $documentation
         val actual = DocumentationFactory.getElementDocumentation(elemWithDocumentation)
         assertThat(actual).isEqualTo(expected)
     }
+
+    @Test
+    fun `test documentation for element with type CODE and valueSet table with special char`() {
+
+        val valueSetA = ValueSet(
+            "a",
+            ValueSet.SetSystem.HL7,
+            values = listOf(ValueSet.Value(">", "Above absolute high-off instrument scale"))
+        )
+
+        val elemWithTypeCode = Element(name = "a", type = Element.Type.CODE, valueSetRef = valueSetA)
+        val expected = """
+**Name**: a
+
+**Type**: CODE
+
+**PII**: No
+
+**Cardinality**: [0..1]
+
+**Value Sets**
+
+Code | Display
+---- | -------
+&#62;|Above absolute high-off instrument scale
+
+---
+"""
+        val actual = DocumentationFactory.getElementDocumentation(elemWithTypeCode)
+        assertThat(actual).isEqualTo(expected)
+    }
 }