feat: improve medication enrichment lookup

Squash merge PR #475
This commit is contained in:
Daniel Volz
2026-03-25 07:03:08 +01:00
committed by GitHub
parent 5382669ffe
commit 8e2d7e74d2
18 changed files with 3594 additions and 168 deletions
@@ -75,6 +75,24 @@ const strengthOptionSchema = {
},
} as const;
const packageOptionSchema = {
type: "object",
properties: {
label: { type: "string" },
description: { type: "string" },
packageType: { type: "string", enum: ["blister", "bottle", "tube", "liquid_container"] },
packCount: { type: "integer", minimum: 1 },
blistersPerPack: { type: "integer", minimum: 1, nullable: true },
pillsPerBlister: { type: "integer", minimum: 1, nullable: true },
totalPills: { type: "integer", minimum: 0, nullable: true },
looseTablets: { type: "integer", minimum: 0, nullable: true },
packageAmountValue: { type: "integer", minimum: 1, nullable: true },
packageAmountUnit: {
anyOf: [{ type: "string", enum: ["ml", "g"] }, { type: "null" }],
},
},
} as const;
const searchResponseSchema = {
type: "object",
properties: {
@@ -95,6 +113,7 @@ const searchResponseSchema = {
genericStatus: { type: "string", enum: ["generic", "original", "unknown"] },
authorisationDate: { type: "string", nullable: true },
source: { type: "string", enum: ["ema", "rxnorm", "openfda"] },
packageOptions: { type: "array", items: packageOptionSchema },
},
},
},
@@ -127,6 +146,7 @@ const enrichResponseSchema = {
anyOf: [{ type: "string", enum: ["capsule", "tablet", "liquid", "topical"] }, { type: "null" }],
},
strengthOptions: { type: "array", items: strengthOptionSchema },
packageOptions: { type: "array", items: packageOptionSchema },
},
},
meta: {
+206 -3
View File
@@ -1,4 +1,5 @@
import type { FastifyBaseLogger } from "fastify";
import type { PackageType } from "../utils/package-profiles.js";
const EMA_MEDICINES_URL =
"https://www.ema.europa.eu/en/documents/report/medicines-output-medicines_json-report_en.json";
@@ -40,6 +41,7 @@ export type MedicationEnrichmentSearchResult = {
genericStatus: "generic" | "original" | "unknown";
authorisationDate: string | null;
source: MedicationEnrichmentSearchSource;
packageOptions: MedicationEnrichmentPackageOption[];
};
export type MedicationEnrichmentStrengthOption = {
@@ -48,6 +50,19 @@ export type MedicationEnrichmentStrengthOption = {
doseUnit: "mg" | "g" | "mcg" | "ml" | "IU" | "units" | "drops" | "puffs" | null;
};
export type MedicationEnrichmentPackageOption = {
label: string;
description: string;
packageType: PackageType;
packCount: number;
blistersPerPack: number | null;
pillsPerBlister: number | null;
totalPills: number | null;
looseTablets: number | null;
packageAmountValue: number | null;
packageAmountUnit: "ml" | "g" | null;
};
export type MedicationEnrichmentSearchResponse = {
query: string;
normalizedQuery: string;
@@ -77,6 +92,7 @@ export type MedicationEnrichmentEnrichResponse = {
genericName: string | null;
medicationForm: "capsule" | "tablet" | "liquid" | "topical" | null;
strengthOptions: MedicationEnrichmentStrengthOption[];
packageOptions: MedicationEnrichmentPackageOption[];
};
meta: {
rxNormMatched: boolean;
@@ -161,6 +177,12 @@ type OpenFdaProduct = {
dosage_form?: string;
marketing_start_date?: string;
active_ingredients?: OpenFdaActiveIngredient[];
packaging?: OpenFdaPackaging[];
};
type OpenFdaPackaging = {
description?: string;
package_ndc?: string;
};
type OpenFdaResponse = {
@@ -172,6 +194,14 @@ type OpenFdaEnrichment = {
genericName: string | null;
strengthOptions: MedicationEnrichmentStrengthOption[];
medicationForm: "capsule" | "tablet" | "liquid" | "topical" | null;
packageOptions: MedicationEnrichmentPackageOption[];
};
type ParsedOpenFdaPackagingSegment = {
quantity: number;
itemText: string;
containerCount: number;
containerText: string;
};
const defaultLogger: MedicationEnrichmentLogger = {
@@ -436,6 +466,7 @@ function compareSearchResults(
right: MedicationEnrichmentSearchResult & { score: number }
): number {
return (
right.packageOptions.length - left.packageOptions.length ||
getSearchSourcePriority(left.source) - getSearchSourcePriority(right.source) ||
right.score - left.score ||
left.name.localeCompare(right.name)
@@ -474,6 +505,7 @@ function collectEmaSearchResults(
genericStatus: entry.genericStatus,
authorisationDate: entry.authorisationDate,
source: "ema",
packageOptions: [],
score: bestMatch.score,
});
}
@@ -623,6 +655,7 @@ function buildRxNormSearchResult(property: RxNormDrugConceptProperty): Medicatio
genericStatus: "unknown",
authorisationDate: null,
source: "rxnorm",
packageOptions: [],
};
}
@@ -749,6 +782,165 @@ function normalizeOpenFdaName(value: unknown): string | null {
.trim();
}
function normalizeOpenFdaPackagingText(value: string): string {
return value
.toUpperCase()
.replace(/[^A-Z0-9]+/g, " ")
.replace(/\s+/g, " ")
.trim();
}
function parseOpenFdaPackagingSegment(segment: string): ParsedOpenFdaPackagingSegment | null {
const sanitized = sanitizeText(segment);
if (!sanitized) return null;
const match = /^(\d+(?:[.,]\d+)?)\s+(.+?)\s+in\s+(\d+(?:[.,]\d+)?)\s+(.+)$/i.exec(sanitized);
if (!match) return null;
const quantity = Number(match[1].replace(",", "."));
const containerCount = Number(match[3].replace(",", "."));
if (!Number.isFinite(quantity) || quantity <= 0 || !Number.isFinite(containerCount) || containerCount <= 0) {
return null;
}
return {
quantity,
itemText: match[2].trim(),
containerCount,
containerText: match[4].trim(),
};
}
function isOpenFdaBlisterLikeContainer(containerText: string): boolean {
const normalized = normalizeOpenFdaPackagingText(containerText);
return (
normalized.includes("BLISTER") ||
normalized.includes("POUCH") ||
normalized.includes("STRIP") ||
normalized.includes("SACHET")
);
}
function isOpenFdaBottleLikeContainer(containerText: string): boolean {
const normalized = normalizeOpenFdaPackagingText(containerText);
return normalized.includes("BOTTLE") || normalized.includes("JAR") || normalized.includes("VIAL");
}
function isOpenFdaSolidUnit(itemText: string): boolean {
const normalized = normalizeOpenFdaPackagingText(itemText);
return (
normalized.includes("TABLET") ||
normalized.includes("CAPSULE") ||
normalized.includes("CAPLET") ||
normalized.includes("SOFTGEL") ||
normalized.includes("LOZENGE")
);
}
function getOpenFdaAmountUnit(itemText: string): "ml" | "g" | null {
const normalized = normalizeOpenFdaPackagingText(itemText);
if (normalized.includes("ML")) return "ml";
if (normalized === "G" || normalized.startsWith("G ") || normalized.includes("GRAM")) return "g";
return null;
}
function toPositiveInteger(value: number): number | null {
if (!Number.isFinite(value) || value <= 0) return null;
return Math.round(value);
}
function uniquePackageOptions(options: MedicationEnrichmentPackageOption[]): MedicationEnrichmentPackageOption[] {
const byKey = new Map<string, MedicationEnrichmentPackageOption>();
for (const option of options) {
const key = JSON.stringify([
option.description,
option.packageType,
option.packCount,
option.blistersPerPack,
option.pillsPerBlister,
option.totalPills,
option.packageAmountValue,
option.packageAmountUnit,
]);
if (!byKey.has(key)) {
byKey.set(key, option);
}
}
return [...byKey.values()];
}
function buildOpenFdaPackageOptions(product: OpenFdaProduct): MedicationEnrichmentPackageOption[] {
return uniquePackageOptions(
(product.packaging ?? [])
.map((entry): MedicationEnrichmentPackageOption | null => {
const description = sanitizeText(entry.description);
if (!description) return null;
const segments = description.split(/\s*\/\s*/).filter((value) => value.trim().length > 0);
const outerSegment = segments.length > 1 ? parseOpenFdaPackagingSegment(segments[0] ?? "") : null;
const primarySegment = parseOpenFdaPackagingSegment(segments[segments.length - 1] ?? "");
if (!primarySegment) return null;
const packCount = toPositiveInteger(outerSegment?.quantity ?? 1) ?? 1;
const packageAmountUnit = getOpenFdaAmountUnit(primarySegment.itemText);
if (packageAmountUnit) {
const packageAmountValue = toPositiveInteger(primarySegment.quantity);
if (packageAmountValue === null) return null;
const totalAmount = packCount * packageAmountValue;
return {
label: description,
description,
packageType: packageAmountUnit === "g" ? "tube" : "liquid_container",
packCount,
blistersPerPack: null,
pillsPerBlister: null,
totalPills: totalAmount,
looseTablets: totalAmount,
packageAmountValue,
packageAmountUnit,
} satisfies MedicationEnrichmentPackageOption;
}
if (!isOpenFdaSolidUnit(primarySegment.itemText)) return null;
const pillsPerUnit = toPositiveInteger(primarySegment.quantity);
if (pillsPerUnit === null) return null;
if (isOpenFdaBlisterLikeContainer(primarySegment.containerText)) {
return {
label: description,
description,
packageType: "blister",
packCount: 1,
blistersPerPack: packCount,
pillsPerBlister: pillsPerUnit,
totalPills: packCount * pillsPerUnit,
looseTablets: 0,
packageAmountValue: null,
packageAmountUnit: null,
} satisfies MedicationEnrichmentPackageOption;
}
if (isOpenFdaBottleLikeContainer(primarySegment.containerText) || outerSegment === null) {
const totalPills = packCount * pillsPerUnit;
return {
label: description,
description,
packageType: "bottle",
packCount,
blistersPerPack: null,
pillsPerBlister: null,
totalPills,
looseTablets: totalPills,
packageAmountValue: null,
packageAmountUnit: null,
} satisfies MedicationEnrichmentPackageOption;
}
return null;
})
.filter((value): value is MedicationEnrichmentPackageOption => value !== null)
);
}
function buildOpenFdaSearchResult(product: OpenFdaProduct): MedicationEnrichmentSearchResult | null {
const code = sanitizeText(product.product_ndc) ?? sanitizeText(product.product_id);
const name = normalizeOpenFdaName(product.brand_name) ?? normalizeOpenFdaName(product.generic_name);
@@ -773,6 +965,7 @@ function buildOpenFdaSearchResult(product: OpenFdaProduct): MedicationEnrichment
genericStatus: "unknown",
authorisationDate: parseCompactDate(product.marketing_start_date),
source: "openfda",
packageOptions: buildOpenFdaPackageOptions(product),
};
}
@@ -852,6 +1045,7 @@ function buildOpenFdaEnrichment(product: OpenFdaProduct): OpenFdaEnrichment | nu
genericName,
strengthOptions: buildOpenFdaStrengthOptions(product),
medicationForm: product.dosage_form ? deriveMedicationFormFromName(product.dosage_form) : null,
packageOptions: buildOpenFdaPackageOptions(product),
};
}
@@ -1034,7 +1228,9 @@ export async function enrichMedicationSelection(
);
openFdaMatched =
openFdaEnrichment !== null &&
(openFdaEnrichment.medicationForm !== null || openFdaEnrichment.strengthOptions.length > 0);
(openFdaEnrichment.medicationForm !== null ||
openFdaEnrichment.strengthOptions.length > 0 ||
openFdaEnrichment.packageOptions.length > 0);
} catch (error) {
partial = true;
note = note ?? "Returned EMA enrichment without secondary-source suggestions.";
@@ -1061,6 +1257,7 @@ export async function enrichMedicationSelection(
rxNormEnrichment?.strengthOptions ?? [],
openFdaEnrichment?.strengthOptions ?? []
),
packageOptions: openFdaEnrichment?.packageOptions ?? [],
},
meta: {
rxNormMatched,
@@ -1099,7 +1296,9 @@ export async function enrichMedicationSelection(
openFdaEnrichment = await fetchOpenFdaEnrichmentByQuery(selection.genericName ?? selection.name);
openFdaMatched =
openFdaEnrichment !== null &&
(openFdaEnrichment.medicationForm !== null || openFdaEnrichment.strengthOptions.length > 0);
(openFdaEnrichment.medicationForm !== null ||
openFdaEnrichment.strengthOptions.length > 0 ||
openFdaEnrichment.packageOptions.length > 0);
} catch (error) {
partial = true;
note = note ?? "Returned RxNorm enrichment without openFDA suggestions.";
@@ -1126,6 +1325,7 @@ export async function enrichMedicationSelection(
rxNormEnrichment?.strengthOptions ?? [],
openFdaEnrichment?.strengthOptions ?? []
),
packageOptions: openFdaEnrichment?.packageOptions ?? [],
},
meta: {
rxNormMatched,
@@ -1164,7 +1364,9 @@ export async function enrichMedicationSelection(
openFdaEnrichment = buildOpenFdaEnrichment(product);
openFdaMatched =
openFdaEnrichment !== null &&
(openFdaEnrichment.medicationForm !== null || openFdaEnrichment.strengthOptions.length > 0);
(openFdaEnrichment.medicationForm !== null ||
openFdaEnrichment.strengthOptions.length > 0 ||
openFdaEnrichment.packageOptions.length > 0);
const openFdaGeneric = openFdaEnrichment?.genericName ?? request.genericName ?? request.name;
try {
@@ -1197,6 +1399,7 @@ export async function enrichMedicationSelection(
rxNormEnrichment?.strengthOptions ?? [],
openFdaEnrichment?.strengthOptions ?? []
),
packageOptions: openFdaEnrichment?.packageOptions ?? [],
},
meta: {
rxNormMatched,
+172 -5
View File
@@ -176,6 +176,7 @@ describe("medication enrichment", () => {
generic_name: "Semaglutide",
dosage_form: "Tablet",
marketing_start_date: "20240101",
packaging: [{ description: "2 blisters in 1 carton / 10 tablets in 1 blister" }],
},
],
})
@@ -203,9 +204,23 @@ describe("medication enrichment", () => {
}),
])
);
expect(response.results.find((result) => result.code === "00011-1111")?.packageOptions).toEqual([
{
label: "2 blisters in 1 carton / 10 tablets in 1 blister",
description: "2 blisters in 1 carton / 10 tablets in 1 blister",
packageType: "blister",
packCount: 1,
blistersPerPack: 2,
pillsPerBlister: 10,
totalPills: 20,
looseTablets: 0,
packageAmountValue: null,
packageAmountUnit: null,
},
]);
});
it("prioritizes RxNorm first, then openFDA, and keeps EMA last", async () => {
it("prioritizes results with package sizes before source-only matches", async () => {
const { searchMedicationEnrichment } = await import("../services/medication-enrichment.js");
fetchMock.mockImplementation((url: string) => {
@@ -242,6 +257,7 @@ describe("medication enrichment", () => {
generic_name: "Acetylsalicylic acid",
dosage_form: "Tablet",
marketing_start_date: "20240101",
packaging: [{ description: "2 blisters in 1 carton / 10 tablets in 1 blister" }],
},
],
})
@@ -255,19 +271,72 @@ describe("medication enrichment", () => {
expect(response.hasMore).toBe(false);
expect(response.results).toHaveLength(3);
expect(response.results[0]).toMatchObject({
code: "1191",
source: "rxnorm",
});
expect(response.results[1]).toMatchObject({
code: "00011-1111",
source: "openfda",
});
expect(response.results[1]).toMatchObject({
code: "1191",
source: "rxnorm",
});
expect(response.results[2]).toMatchObject({
code: "EMA-ASPIRIN",
source: "ema",
});
});
it("sorts richer package hits ahead of package-bearing results with fewer options", async () => {
const { searchMedicationEnrichment } = await import("../services/medication-enrichment.js");
fetchMock.mockImplementation((url: string) => {
if (url.includes("medicines-output-medicines_json-report_en.json")) {
return Promise.resolve(jsonResponse([createEmaRow()]));
}
if (url.includes("/drugs.json?name=")) {
return Promise.resolve(jsonResponse({ drugGroup: { conceptGroup: [] } }));
}
if (url.includes("api.fda.gov/drug/ndc.json")) {
return Promise.resolve(
jsonResponse({
results: [
{
product_ndc: "00011-1111",
brand_name: "Ibuprofen Max",
generic_name: "Ibuprofen",
dosage_form: "Tablet",
marketing_start_date: "20240101",
packaging: [{ description: "60 tablets in 1 bottle" }, { description: "120 tablets in 1 bottle" }],
},
{
product_ndc: "00022-2222",
brand_name: "Ibuprofen Compact",
generic_name: "Ibuprofen",
dosage_form: "Tablet",
marketing_start_date: "20240101",
packaging: [{ description: "20 tablets in 1 blister" }],
},
],
})
);
}
return Promise.reject(new Error(`Unexpected URL: ${url}`));
});
const response = await searchMedicationEnrichment("Ibuprofen", 3);
expect(response.results.slice(0, 2)).toMatchObject([
{
code: "00011-1111",
source: "openfda",
},
{
code: "00022-2222",
source: "openfda",
},
]);
expect(response.results[0].packageOptions).toHaveLength(2);
expect(response.results[1].packageOptions).toHaveLength(1);
});
it("validates malformed search requests", async () => {
const app = await buildApp();
@@ -346,6 +415,89 @@ describe("medication enrichment", () => {
await app.close();
});
it("includes package suggestions from openFDA fallback in route responses", async () => {
const app = await buildApp();
fetchMock.mockImplementation((url: string) => {
if (url.includes("medicines-output-medicines_json-report_en.json")) {
return Promise.resolve(
jsonResponse([
createEmaRow({
name_of_medicine: "Tylenol 500 mg tablets",
international_non_proprietary_name_common_name: "Acetaminophen",
active_substance: "Acetaminophen",
ema_product_number: "EMA-TYLENOL",
}),
])
);
}
if (url.includes("/rxcui.json?name=acetaminophen&search=2")) {
return Promise.resolve(jsonResponse({ idGroup: {} }));
}
if (url.includes("api.fda.gov/drug/ndc.json")) {
return Promise.resolve(
jsonResponse({
results: [
{
product_ndc: "00011-1111",
brand_name: "Tylenol",
generic_name: "Acetaminophen",
dosage_form: "Tablet",
active_ingredients: [{ name: "Acetaminophen", strength: "500 mg" }],
packaging: [{ description: "30 tablets in 1 bottle" }],
},
],
})
);
}
return Promise.reject(new Error(`Unexpected URL: ${url}`));
});
const response = await app.inject({
method: "POST",
url: "/medication-enrichment/enrich",
payload: {
query: "Paracetamol",
name: "Tylenol 500 mg tablets",
genericName: "Acetaminophen",
},
});
expect(response.statusCode).toBe(200);
expect(response.json()).toMatchObject({
selection: {
name: "Tylenol 500 mg tablets",
genericName: "Acetaminophen",
source: "ema+openfda",
},
suggestions: {
medicationForm: "tablet",
strengthOptions: [{ label: "500 mg", pillWeightMg: 500, doseUnit: "mg" }],
packageOptions: [
{
label: "30 tablets in 1 bottle",
description: "30 tablets in 1 bottle",
packageType: "bottle",
packCount: 1,
blistersPerPack: null,
pillsPerBlister: null,
totalPills: 30,
looseTablets: 30,
packageAmountValue: null,
packageAmountUnit: null,
},
],
},
meta: {
rxNormMatched: false,
openFdaMatched: true,
partial: false,
note: null,
},
});
await app.close();
});
it("keeps incomplete-coverage messaging honest when RxNorm enrichment fails", async () => {
const { enrichMedicationSelection } = await import("../services/medication-enrichment.js");
@@ -459,6 +611,7 @@ describe("medication enrichment", () => {
generic_name: "Ibuprofen",
dosage_form: "Tablet",
active_ingredients: [{ name: "Ibuprofen", strength: "200 mg" }],
packaging: [{ description: "100 mL in 1 bottle" }],
},
],
})
@@ -506,6 +659,20 @@ describe("medication enrichment", () => {
{ label: "200 mg", pillWeightMg: 200, doseUnit: "mg" },
{ label: "400 mg", pillWeightMg: 400, doseUnit: "mg" },
],
packageOptions: [
{
label: "100 mL in 1 bottle",
description: "100 mL in 1 bottle",
packageType: "liquid_container",
packCount: 1,
blistersPerPack: null,
pillsPerBlister: null,
totalPills: 100,
looseTablets: 100,
packageAmountValue: 100,
packageAmountUnit: "ml",
},
],
},
meta: {
rxNormMatched: true,