@glion/annotate-profile-fields-code-systems 0.14.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rethink Health
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import type { Root } from "@glion/ast";
+import type { Plugin } from "unified";
+declare module "@glion/ast" {
+    interface FieldData {
+        /** Resolved UTG code system identity for this field's table reference. */
+        codeSystem?: {
+            id: string;
+            name: string;
+            title: string;
+        } | undefined;
+    }
+    interface FieldRepetitionData {
+        /** Resolved code entry for this repetition's primary value. */
+        code?: {
+            value: string;
+            display: string;
+            status: string;
+        } | undefined;
+    }
+}
+/**
+ * Unified plugin that annotates coded fields with their resolved UTG
+ * code system identity (on the field) and the display/status of each
+ * repetition's primary value (on the field-repetition).
+ *
+ * Per the HL7v2 spec, when a field has a table binding and a composite
+ * datatype (CWE/CNE), the table constrains CWE.1 — the first component's
+ * first subcomponent. This plugin reads that value from each repetition,
+ * resolves it against the UTG code system, and attaches:
+ * - `field.data.codeSystem` — code system identity (same for all reps)
+ * - `rep.data.code` — resolved value entry (different per rep)
+ *
+ * Requires the fields annotator to run first (preset guarantees ordering).
+ */
+export declare const hl7v2AnnotateProfileFieldsCodeSystems: Plugin<[], Root, Root>;
+export default hl7v2AnnotateProfileFieldsCodeSystems;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgB,IAAI,EAAE,MAAM,YAAY,CAAC;AAIrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAYtC,OAAO,QAAQ,YAAY,CAAC;IAC1B,UAAU,SAAS;QACjB,0EAA0E;QAC1E,UAAU,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC;KACtE;IACD,UAAU,mBAAmB;QAC3B,+DAA+D;QAC/D,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC;KACvE;CACF;AAUD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qCAAqC,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CA2EtE,CAAC;AAEJ,eAAe,qCAAqC,CAAC"}

package/dist/index.js

@@ -0,0 +1,75 @@
+import { profiles } from "@glion/profiles";
+import { SKIP, visit } from "@glion/util-visit";
+//#region src/index.ts
+/** Visit predicate: only visit field nodes that have a table reference. */
+function isCodedField(node) {
+	return node.type === "field" && typeof node.data?.table === "string";
+}
+/**
+* Convert a field profile table reference to a UTG code system ID.
+* Field profiles use "HL70001"; UTG code systems use "v2-0001".
+*/
+function tableIdToCodeSystemId(tableRef) {
+	return `v2-${tableRef.replace(/^HL7/, "")}`;
+}
+/**
+* Unified plugin that annotates coded fields with their resolved UTG
+* code system identity (on the field) and the display/status of each
+* repetition's primary value (on the field-repetition).
+*
+* Per the HL7v2 spec, when a field has a table binding and a composite
+* datatype (CWE/CNE), the table constrains CWE.1 — the first component's
+* first subcomponent. This plugin reads that value from each repetition,
+* resolves it against the UTG code system, and attaches:
+* - `field.data.codeSystem` — code system identity (same for all reps)
+* - `rep.data.code` — resolved value entry (different per rep)
+*
+* Requires the fields annotator to run first (preset guarantees ordering).
+*/
+const hl7v2AnnotateProfileFieldsCodeSystems = () => async (tree, file) => {
+	const tableRefs = /* @__PURE__ */ new Set();
+	visit(tree, isCodedField, (node) => {
+		tableRefs.add(node.data.table);
+	});
+	const codeSystems = /* @__PURE__ */ new Map();
+	const entries = [...tableRefs].map((ref) => [ref, tableIdToCodeSystemId(ref)]);
+	const results = await Promise.allSettled(entries.map(([, csId]) => profiles.codeSystems.load(csId)));
+	for (let i = 0; i < results.length; i++) {
+		const result = results[i];
+		const [tableRef] = entries[i];
+		if (result.status === "fulfilled") codeSystems.set(tableRef, result.value);
+		else if (!(result.reason instanceof Error) || !result.reason.message.startsWith("Unknown ")) {
+			const msg = file.message(`Failed to load code system for table '${tableRef}'`);
+			msg.source = "hl7v2-annotate-profile-fields-code-systems";
+			msg.cause = result.reason;
+		}
+	}
+	visit(tree, isCodedField, (node) => {
+		const table = node.data.table;
+		const csDef = codeSystems.get(table);
+		if (!csDef) return SKIP;
+		node.data.codeSystem = {
+			id: csDef.id,
+			name: csDef.name,
+			title: csDef.title
+		};
+		for (const rep of node.children) {
+			const primaryValue = rep.children[0]?.children[0]?.value;
+			if (!primaryValue) continue;
+			const entry = csDef.codes.get(primaryValue);
+			if (!entry) continue;
+			if (!rep.data) rep.data = {};
+			rep.data.code = {
+				value: primaryValue,
+				display: entry.display,
+				status: entry.status
+			};
+		}
+		return SKIP;
+	});
+	return tree;
+};
+//#endregion
+export { hl7v2AnnotateProfileFieldsCodeSystems as default, hl7v2AnnotateProfileFieldsCodeSystems };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { Field, Nodes, Root } from \"@glion/ast\";\nimport type { CodeSystemDefinition } from \"@glion/profiles\";\nimport { profiles } from \"@glion/profiles\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport type { Plugin } from \"unified\";\nimport type { VFile } from \"vfile\";\n\n/** Visit predicate: only visit field nodes that have a table reference. */\nfunction isCodedField(node: Nodes): node is Field {\n  return (\n    node.type === \"field\" &&\n    typeof (node.data as Record<string, unknown> | undefined)?.table ===\n      \"string\"\n  );\n}\n\ndeclare module \"@glion/ast\" {\n  interface FieldData {\n    /** Resolved UTG code system identity for this field's table reference. */\n    codeSystem?: { id: string; name: string; title: string } | undefined;\n  }\n  interface FieldRepetitionData {\n    /** Resolved code entry for this repetition's primary value. */\n    code?: { value: string; display: string; status: string } | undefined;\n  }\n}\n\n/**\n * Convert a field profile table reference to a UTG code system ID.\n * Field profiles use \"HL70001\"; UTG code systems use \"v2-0001\".\n */\nfunction tableIdToCodeSystemId(tableRef: string): string {\n  return `v2-${tableRef.replace(/^HL7/, \"\")}`;\n}\n\n/**\n * Unified plugin that annotates coded fields with their resolved UTG\n * code system identity (on the field) and the display/status of each\n * repetition's primary value (on the field-repetition).\n *\n * Per the HL7v2 spec, when a field has a table binding and a composite\n * datatype (CWE/CNE), the table constrains CWE.1 — the first component's\n * first subcomponent. This plugin reads that value from each repetition,\n * resolves it against the UTG code system, and attaches:\n * - `field.data.codeSystem` — code system identity (same for all reps)\n * - `rep.data.code` — resolved value entry (different per rep)\n *\n * Requires the fields annotator to run first (preset guarantees ordering).\n */\nexport const hl7v2AnnotateProfileFieldsCodeSystems: Plugin<[], Root, Root> =\n  () => async (tree: Root, file: VFile) => {\n    // Collect table references from field.data.table (set by fields annotator)\n    const tableRefs = new Set<string>();\n    visit(tree, isCodedField, (node) => {\n      tableRefs.add((node.data as Record<string, unknown>).table as string);\n    });\n\n    // Resolve UTG code systems in parallel\n    const codeSystems = new Map<string, CodeSystemDefinition>();\n    const entries = [...tableRefs].map(\n      (ref) => [ref, tableIdToCodeSystemId(ref)] as const\n    );\n    const results = await Promise.allSettled(\n      entries.map(([, csId]) => profiles.codeSystems.load(csId))\n    );\n\n    for (let i = 0; i < results.length; i++) {\n      const result = results[i]!;\n      const [tableRef] = entries[i]!;\n      if (result.status === \"fulfilled\") {\n        codeSystems.set(tableRef, result.value);\n      } else if (\n        !(result.reason instanceof Error) ||\n        !result.reason.message.startsWith(\"Unknown \")\n      ) {\n        const msg = file.message(\n          `Failed to load code system for table '${tableRef}'`\n        );\n        msg.source = \"hl7v2-annotate-profile-fields-code-systems\";\n        msg.cause = result.reason;\n      }\n    }\n\n    // Annotate: codeSystem on field, resolved code on each repetition\n    visit(tree, isCodedField, (node) => {\n      const table = (node.data as Record<string, unknown>).table as string;\n      const csDef = codeSystems.get(table);\n      if (!csDef) {\n        return SKIP;\n      }\n\n      // Code system identity on the field (same for all repetitions)\n      (node.data as Record<string, unknown>).codeSystem = {\n        id: csDef.id,\n        name: csDef.name,\n        title: csDef.title,\n      };\n\n      // Resolved value on each repetition\n      for (const rep of node.children) {\n        const primaryValue = rep.children[0]?.children[0]?.value;\n        if (!primaryValue) {\n          continue;\n        }\n\n        const entry = csDef.codes.get(primaryValue);\n        if (!entry) {\n          continue;\n        }\n\n        if (!rep.data) {\n          rep.data = {};\n        }\n        rep.data.code = {\n          value: primaryValue,\n          display: entry.display,\n          status: entry.status,\n        };\n      }\n\n      return SKIP;\n    });\n\n    return tree;\n  };\n\nexport default hl7v2AnnotateProfileFieldsCodeSystems;\n"],"mappings":";;;;AAQA,SAAS,aAAa,MAA4B;AAChD,QACE,KAAK,SAAS,WACd,OAAQ,KAAK,MAA8C,UACzD;;;;;;AAmBN,SAAS,sBAAsB,UAA0B;AACvD,QAAO,MAAM,SAAS,QAAQ,QAAQ,GAAG;;;;;;;;;;;;;;;;AAiB3C,MAAa,8CACL,OAAO,MAAY,SAAgB;CAEvC,MAAM,4BAAY,IAAI,KAAa;AACnC,OAAM,MAAM,eAAe,SAAS;AAClC,YAAU,IAAK,KAAK,KAAiC,MAAgB;GACrE;CAGF,MAAM,8BAAc,IAAI,KAAmC;CAC3D,MAAM,UAAU,CAAC,GAAG,UAAU,CAAC,KAC5B,QAAQ,CAAC,KAAK,sBAAsB,IAAI,CAAC,CAC3C;CACD,MAAM,UAAU,MAAM,QAAQ,WAC5B,QAAQ,KAAK,GAAG,UAAU,SAAS,YAAY,KAAK,KAAK,CAAC,CAC3D;AAED,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;EACvC,MAAM,SAAS,QAAQ;EACvB,MAAM,CAAC,YAAY,QAAQ;AAC3B,MAAI,OAAO,WAAW,YACpB,aAAY,IAAI,UAAU,OAAO,MAAM;WAEvC,EAAE,OAAO,kBAAkB,UAC3B,CAAC,OAAO,OAAO,QAAQ,WAAW,WAAW,EAC7C;GACA,MAAM,MAAM,KAAK,QACf,yCAAyC,SAAS,GACnD;AACD,OAAI,SAAS;AACb,OAAI,QAAQ,OAAO;;;AAKvB,OAAM,MAAM,eAAe,SAAS;EAClC,MAAM,QAAS,KAAK,KAAiC;EACrD,MAAM,QAAQ,YAAY,IAAI,MAAM;AACpC,MAAI,CAAC,MACH,QAAO;AAIR,OAAK,KAAiC,aAAa;GAClD,IAAI,MAAM;GACV,MAAM,MAAM;GACZ,OAAO,MAAM;GACd;AAGD,OAAK,MAAM,OAAO,KAAK,UAAU;GAC/B,MAAM,eAAe,IAAI,SAAS,IAAI,SAAS,IAAI;AACnD,OAAI,CAAC,aACH;GAGF,MAAM,QAAQ,MAAM,MAAM,IAAI,aAAa;AAC3C,OAAI,CAAC,MACH;AAGF,OAAI,CAAC,IAAI,KACP,KAAI,OAAO,EAAE;AAEf,OAAI,KAAK,OAAO;IACd,OAAO;IACP,SAAS,MAAM;IACf,QAAQ,MAAM;IACf;;AAGH,SAAO;GACP;AAEF,QAAO"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@glion/annotate-profile-fields-code-systems",
+  "version": "0.14.1",
+  "description": "Unified plugin to annotate HL7v2 field-level coded values with UTG code system metadata",
+  "keywords": [
+    "annotate",
+    "code-system",
+    "health",
+    "healthcare",
+    "hl7",
+    "hl7v2",
+    "nodejs",
+    "plugin",
+    "profile",
+    "typescript",
+    "unified",
+    "utg"
+  ],
+  "homepage": "https://glion.dev",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "repository": "rethinkhealth/glion.git",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "unified": "11.0.5",
+    "vfile": "6.0.3",
+    "@glion/ast": "0.14.1",
+    "@glion/profiles": "0.14.1",
+    "@glion/util-visit": "0.14.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@vitest/coverage-v8": "4.1.2",
+    "tsdown": "0.21.7",
+    "typescript": "^5.9.3",
+    "vitest": "4.1.2",
+    "@glion/annotate-profile-fields": "0.14.1",
+    "@glion/annotate-profile-context": "0.14.1",
+    "@glion/tsconfig": "0.0.1",
+    "@glion/testing": "0.0.2",
+    "@glion/builder": "0.14.1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsdown && tsc --emitDeclarationOnly",
+    "check-types": "tsc --noEmit",
+    "bench": "vitest bench --run",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}