@ampath/esm-reports-app 1.0.0-next.8 → 1.0.0-next.80

package/src/registers/presumptive-tb/presumptive-tb-register.scss

@@ -0,0 +1,262 @@
+@use '@carbon/layout';
+@use '@openmrs/esm-styleguide/src/vars' as *;
+
+/* The Presumptive TB Register (MOH/REG/DNTLDP/02) as A3 landscape pages, drawn
+   in the units the paper is measured in (mm, pt) so a page is one sheet, as
+   on page 4 of the form: the green-headed ruled table, and beneath it on the
+   last page the page summary and the code tables. Heights are fixed so a page
+   never spills over: 15 cases on a full page, 9 with the summary on the last. */
+
+/* On screen a page is the printable area only, A3 landscape less its 8mm
+   margins: the card around it gives the margin, and `usePageScale` is told
+   this width. */
+$page-w: 420mm - 2 * 8mm;
+$page-h: 297mm - 2 * 8mm;
+
+$ink: #000;
+$rule: 0.6pt solid #404040;
+$green: #70ad47; // the letter row and the code tables' headings
+$green-light: #e2efd9; // the column headings
+$green-code: #d8e4bc; // the lab result code cells
+
+$letters-h: 5.9mm;
+$heading-1: 20.6mm; // to the foot of "Nationality", "Write the Investigation…"
+$heading-2: 24mm; // to the foot of "Type of Sample", the investigation names
+$heading-3: 18.5mm;
+$line-h: 6.75mm; // half a case's row: each case takes two lines
+
+/* The card the pages sit in, drawn like the filter card above it */
+.reportFrame {
+  margin: layout.$spacing-05 0 layout.$spacing-07;
+  padding: layout.$spacing-05;
+  background-color: $ui-02;
+  border: 1px solid $ui-03;
+}
+
+/* Holds the fixed-width pages without making the app scroll sideways */
+.viewport {
+  display: flex;
+  flex-direction: column;
+  gap: layout.$spacing-09;
+  overflow-x: auto;
+}
+
+.page {
+  display: flex;
+  flex-direction: column;
+  flex: none;
+  box-sizing: border-box;
+  width: $page-w;
+  height: $page-h;
+  margin: 0 auto;
+  color: $ink;
+  font-family: Arial, Helvetica, sans-serif;
+  font-size: 7.5pt;
+  line-height: 1.2;
+  background-color: #fff;
+  /* set by `usePageScale` from the measured container width, floored at 1 */
+  zoom: var(--page-zoom, 1);
+}
+
+.register {
+  width: 100%;
+  table-layout: fixed;
+  border-collapse: collapse;
+
+  th,
+  td {
+    padding: 0.6mm 0.9mm;
+    overflow: hidden;
+    border: $rule;
+  }
+
+  th {
+    font-weight: 400;
+    text-align: center;
+    vertical-align: top;
+    background-color: $green-light;
+  }
+
+  td {
+    vertical-align: middle;
+  }
+}
+
+/* A, B, C … across the top, white on green */
+.letters th {
+  height: $letters-h;
+  padding: 0;
+  font-size: 8pt;
+  font-weight: 700;
+  color: #fff;
+  vertical-align: middle;
+  background-color: $green;
+}
+
+.heading1 th {
+  height: $heading-1;
+}
+
+.heading2 th {
+  height: $heading-2;
+}
+
+.heading3 th {
+  height: $heading-3;
+}
+
+/* the investigation and registration headings start at the left, as printed */
+.leftHeading {
+  text-align: left !important;
+}
+
+/* A case: two ruled lines, the split columns holding an upper and a lower entry */
+.upperLine td,
+.lowerLine td {
+  height: $line-h;
+  white-space: nowrap;
+}
+
+.left {
+  text-align: left;
+}
+
+.centre {
+  text-align: center;
+}
+
+/* names, addresses and remarks may take both lines of the row, never more */
+/* National ID and CR number (CR + 13 digits + check digit): small enough to fit G on one line */
+.idCell {
+  font-size: 5.5pt;
+  white-space: nowrap;
+}
+
+.clamp {
+  display: -webkit-box;
+  overflow: hidden;
+  white-space: normal;
+  -webkit-box-orient: vertical;
+  -webkit-line-clamp: 2;
+}
+
+/* sample type over the date it was collected, in one cell of the row */
+.stacked {
+  display: block;
+  white-space: nowrap;
+}
+
+/* Beneath the table on the last page: the page summary and the code tables,
+   spaced across the sheet as on the form */
+
+.footer {
+  display: flex;
+  align-items: flex-start;
+  justify-content: space-between;
+  margin-top: 6mm;
+}
+
+.pageSummary {
+  width: 62mm;
+
+  h5 {
+    margin: 0 0 3mm;
+    font-size: 8pt;
+    font-weight: 700;
+  }
+
+  p {
+    margin: 0 0 3.2mm;
+    font-size: 7.5pt;
+    line-height: 1.9;
+  }
+
+  strong {
+    font-weight: 700;
+  }
+}
+
+/* the figure written on the line */
+.blank {
+  display: inline-block;
+  min-width: 20mm;
+  padding: 0 1mm;
+  font-weight: 700;
+  text-align: center;
+  border-bottom: 0.6pt solid $ink;
+}
+
+.codeTable {
+  border-collapse: collapse;
+  font-size: 7pt;
+
+  th,
+  td {
+    height: 5.9mm;
+    padding: 0 1.4mm;
+    text-align: left;
+    vertical-align: middle;
+    border: $rule;
+  }
+
+  thead th {
+    font-weight: 700;
+    color: #fff;
+    background-color: $green;
+  }
+}
+
+.results {
+  width: 51mm;
+
+  thead th {
+    font-size: 8pt;
+    text-align: center;
+  }
+
+  td {
+    width: 50%;
+    font-size: 7.5pt;
+  }
+}
+
+.labCodes {
+  width: 153mm;
+
+  thead th:first-child {
+    width: 18mm;
+    text-align: center;
+  }
+
+  thead th:nth-child(2) {
+    text-align: center;
+  }
+
+  td:first-child {
+    background-color: $green-code;
+  }
+
+  td:nth-child(2) {
+    width: 27mm;
+  }
+}
+
+.referredBy {
+  width: 66mm;
+
+  td:last-child {
+    width: 13mm;
+  }
+}
+
+.investigations {
+  width: 33mm;
+}
+
+.pageFoot {
+  display: flex;
+  justify-content: space-between;
+  margin-top: auto;
+  padding-top: 1.5mm;
+  font-size: 7.5pt;
+}

package/src/registers/presumptive-tb/presumptive-tb.component.tsx

@@ -0,0 +1,92 @@
+import React, { useRef, useState } from 'react';
+import { useSession } from '@openmrs/esm-framework';
+
+import { ReportFiltersComponent, type ReportPeriod, useRestorePeriod } from '../../common/report-filters';
+import { downloadSheetsPdf } from '../../common/report-page';
+import { showReportError } from '../../common/report-error';
+import { ReportSkeleton } from '../../common/report-skeleton';
+import { getPresumptiveTb } from '../../resources/presumptive-tb.resource';
+import { registerFileName } from '../register-file-name';
+import { ReportPlaceholder, useGeneratedLocation } from '../../common/report-placeholder';
+import PresumptiveTbRegister from './presumptive-tb-register.component';
+import { type PresumptiveTbRow } from './presumptive-tb.types';
+import styles from './presumptive-tb-register.scss';
+
+/**
+ * Presumptive TB Register (MOH/REG/DNTLDP/02), opened from the landing page's
+ * Registers tab, with the reports' filter bar.
+ *
+ * The cases are the TB encounters (331) in the period, for the whole facility,
+ * already in the register's columns (/presumptive-tb-register).
+ */
+const PresumptiveTbRegisterPage: React.FC = () => {
+  const [rows, setRows] = useState<PresumptiveTbRow[] | null>(null);
+  const [isLoading, setIsLoading] = useState(false);
+  const [period, setPeriod] = useState<{ startDate: string; endDate: string }>({ startDate: '', endDate: '' });
+
+  const session = useSession();
+  const locationUuids = session?.sessionLocation?.uuid ?? '';
+  /* Only a register for the current location counts */
+  const { isForCurrentLocation, hasLocationChanged, markGenerated } = useGeneratedLocation('presumptiveTbLocation');
+  const isGenerated = rows !== null && isForCurrentLocation;
+
+  const generate = async ({ startDate, endDate }: ReportPeriod) => {
+    setIsLoading(true);
+    setPeriod({ startDate, endDate });
+    try {
+      setRows((await getPresumptiveTb({ locationUuids, startDate, endDate })) as PresumptiveTbRow[]);
+      markGenerated(locationUuids);
+    } catch (error) {
+      showReportError('the Presumptive TB register', error);
+    } finally {
+      setIsLoading(false);
+    }
+  };
+
+  useRestorePeriod(generate);
+
+  /* Download PDF saves every page of the register as an A3 landscape page,
+     made from copies, so the pages on screen are left as they are */
+  const sheetsRef = useRef<HTMLDivElement>(null);
+  const downloadPdf = async () => {
+    const pages = Array.from(sheetsRef.current?.querySelectorAll<HTMLElement>('[data-register-page]') ?? []);
+    const name = registerFileName('Presumptive-TB-Register', session?.sessionLocation?.display ?? '', period);
+    /* styled by its own stylesheets in Arial only, and may run to many pages */
+    await downloadSheetsPdf(pages, name, {
+      paperSize: 'a3',
+      orientation: 'landscape',
+      stylesheetsOnly: true,
+      image: 'jpeg',
+    });
+  };
+
+  return (
+    <>
+      <ReportFiltersComponent
+        reportName="Presumptive TB Register"
+        mode="both"
+        onGenerate={generate}
+        isLoading={isLoading}
+        isReportGenerated={isGenerated}
+        generatedPeriod={period}
+        defaultTab="custom"
+        backLink={{ label: 'All registers', to: '/?tab=registers' }}
+        onDownloadPdf={downloadPdf}
+      />
+      {isLoading && <ReportSkeleton />}
+      {!isLoading && !isGenerated && (
+        <ReportPlaceholder
+          reportName="Presumptive TB Register"
+          isLocationChanged={rows !== null && hasLocationChanged}
+        />
+      )}
+      {!isLoading && isGenerated && (
+        <div className={styles.reportFrame} ref={sheetsRef}>
+          <PresumptiveTbRegister rows={rows} />
+        </div>
+      )}
+    </>
+  );
+};
+
+export default PresumptiveTbRegisterPage;

package/src/registers/presumptive-tb/presumptive-tb.types.ts

@@ -0,0 +1,88 @@
+import dayjs from 'dayjs';
+
+/**
+ * One presumptive TB case in the register, column by column as on the form
+ * (MOH/REG/DNTLDP/02, February 2023). Where a column holds two lines, the
+ * upper and lower are separate fields.
+ *
+ * These are the columns the ETL returns (/presumptive-tb-register), one row
+ * per TB encounter in the period.
+ */
+export interface PresumptiveTbRow {
+  /** (A) cumulative from the start of each year */
+  serial_number?: number | string | null;
+  /** (B) patient department number, e.g. CCC or OPD number */
+  department_number?: string | null;
+  /** (C) date registered as a presumed TB/DR-TB case */
+  date?: string | null;
+  /** (D) first, middle and last names */
+  full_name?: string | null;
+  /** (E) M, F or other */
+  sex?: string | null;
+  /** (F) completed years, or months for a child under one, e.g. `35 Yrs` or `8 Mo` */
+  age?: string | number | null;
+  /** (G) upper: national ID (identifier type 5) */
+  national_id?: string | null;
+  /** (G) lower: Client Registry number (identifier type 55), in place of UPI */
+  cr_number?: string | null;
+  /** (H) upper: nearest landmark */
+  physical_address?: string | null;
+  /** (H) lower */
+  phone_number?: string | null;
+  /** (I) PS, SR, CI, CP, CHV or ISP */
+  referred_by?: string | null;
+  /** (J) upper: Positive, Negative or Not Done, in full */
+  hiv_result?: string | null;
+  /** (J) lower */
+  hiv_test_date?: string | null;
+  /** (K) type of sample (code) */
+  sample_type?: string | null;
+  /** (K) date the sputum sample was collected */
+  sample_date?: string | null;
+  /** (L) upper: N, SG, AO or ND */
+  xray_result?: string | null;
+  /** (L) lower */
+  xray_date?: string | null;
+  /** (M) upper: other radiological test(s) and result */
+  other_radiology_result?: string | null;
+  /** (M) lower */
+  other_radiology_date?: string | null;
+  /** (N) upper: molecular / culture test(s) and result, e.g. MTB + RS */
+  molecular_result?: string | null;
+  /** (N) lower */
+  molecular_date?: string | null;
+  /** (O) upper: microscopy / TB LAMP result */
+  microscopy_result?: string | null;
+  /** (O) lower */
+  microscopy_date?: string | null;
+  /** (P) DSTB, DRTB or No TB */
+  outcome?: string | null;
+  /** (Q) upper: Yes or No */
+  started_tb_treatment?: string | null;
+  /** (Q) lower: sub-county TB registration number & start date */
+  tb_registration?: string | null;
+  /** (R) upper: Yes or No */
+  tpt_started?: string | null;
+  /** (R) lower: TPT sub-county register number & start date */
+  tpt_registration?: string | null;
+  remarks?: string | null;
+}
+
+/** Blank rather than "null" / "undefined" in a cell */
+export const text = (value: unknown) => (value === null || value === undefined ? '' : String(value));
+
+/** DD/MM/YYYY, as the form asks */
+export const formDate = (value: unknown) => (value ? dayjs(String(value)).format('DD/MM/YYYY') : '');
+
+/** Diagnosed with TB: drug-sensitive or drug-resistant */
+export const isDiagnosed = (row: PresumptiveTbRow) => ['DSTB', 'DRTB'].includes(text(row.outcome).toUpperCase());
+
+/** Investigated for TB: a sample collected or any investigation recorded */
+export const isInvestigated = (row: PresumptiveTbRow) =>
+  [row.sample_date, row.xray_result, row.other_radiology_result, row.molecular_result, row.microscopy_result].some(
+    (value) => text(value) !== '',
+  );
+
+/** A diagnosed case started on anti-TB treatment */
+export const isInitiated = (row: PresumptiveTbRow) =>
+  isDiagnosed(row) && /^y(es)?$/i.test(text(row.started_tb_treatment));

package/src/registers/register-catalog.ts

@@ -0,0 +1,202 @@
+import { Activity, Chemistry, Medication, Microscope, Stethoscope, TaskView } from '@carbon/react/icons';
+
+import { type ReportCategory } from '../dashboard/report-catalog';
+
+/**
+ * The registers listed on the landing page's Registers tab, grouped as the
+ * reports are. Each opens on its own route (root.component.tsx) with the same
+ * filter bar as the reports, opening on a custom range of today
+ * (`defaultTab="custom"`), where the reports open on last month.
+ */
+export const registerCategories: ReportCategory[] = [
+  {
+    id: 'hiv-testing',
+    title: 'HIV Testing Services & Pre-Exposure Prophylaxis',
+    description: 'HTS and PrEP daily registers',
+    tone: 'violet',
+    reports: [
+      {
+        code: 'MOH 362',
+        name: 'HTS lab, referral & linkage',
+        description: 'Clients tested for HIV, their test kits and results, and referral and linkage to care.',
+        path: '/moh-362',
+        icon: Microscope,
+        keywords: ['hts', 'hiv testing', 'lab', 'referral', 'linkage', 'kits'],
+      },
+      {
+        code: 'MOH 267',
+        name: 'PrEP daily activity',
+        description: 'PrEP visits: clients new, continuing or restarting, their PrEP method, HIV results and STIs.',
+        path: '/moh-267',
+        icon: Medication,
+        keywords: ['prep', 'pre-exposure', 'prophylaxis', 'daily activity', 'dar', 'sti'],
+      },
+    ],
+  },
+  {
+    id: 'tb',
+    title: 'Tuberculosis',
+    description: 'TB case finding registers',
+    tone: 'teal',
+    reports: [
+      {
+        code: 'MOH/REG/DNTLDP/02',
+        name: 'Presumptive TB',
+        description:
+          'Presumptive TB cases, their investigations and results, and whether started on TB treatment or TPT.',
+        path: '/presumptive-tb',
+        icon: Stethoscope,
+        keywords: ['tb', 'tuberculosis', 'presumptive', 'acf', 'case finding', 'sputum', 'genexpert', 'tpt'],
+      },
+      {
+        code: 'TB4',
+        name: 'Notification & treatment',
+        description:
+          'Drug-sensitive TB patients notified: diagnosis, investigations, treatment, follow-up and outcome.',
+        path: '/tb4',
+        icon: TaskView,
+        keywords: ['tb', 'tb4', 'tuberculosis', 'dstb', 'notification', 'treatment', 'outcome', 'smear', 'culture'],
+      },
+    ],
+  },
+  {
+    id: 'diabetes-and-hypertension',
+    title: 'Diabetes and Hypertension services',
+    description: 'Diabetes and Hypertension comprehensive care',
+    tone: 'violet',
+    reports: [
+      {
+        code: 'MOH 222',
+        name: 'Diabetes and Hypertension Comprehensive Care Daily Register',
+        description: 'Diabetes and Hypertension Comprehensive Care Daily Register',
+        path: '/moh-222',
+        icon: Activity,
+        keywords: ['cdm', 'ncd', 'diabetes', 'hypertetion'],
+      },
+      {
+        code: 'MOH 270',
+        name: 'Diabetes & Hypertension Comprehensive Care Permanent register',
+        description: 'Diabetes & Hypertension Comprehensive Care Permanent register',
+        path: '/moh-270',
+        icon: Activity,
+        keywords: ['cdm', 'ncd', 'diabetes', 'hypertetion'],
+      },
+    ],
+  },
+  {
+    id: 'laboratory',
+    title: 'Laboratory',
+    description: 'Laboratory specimen and testing registers',
+    tone: 'blue',
+    reports: [
+      {
+        code: 'MOH 240',
+        name: 'Laboratory (LAB) Register',
+        description:
+          'Specimens collected and analysed by the laboratory: investigations, results, billing and referral.',
+        path: '/moh-240-register',
+        icon: Chemistry,
+        keywords: ['lab', 'laboratory', 'specimen', 'results', 'malaria', 'referral'],
+      },
+      {
+        code: 'TB LAB',
+        name: 'TB Laboratory Register',
+        description:
+          'TB specimens tested: microscopy (AFB), TB-LAMP, LF-LAM and GeneXpert/Truenat results with turnaround.',
+        path: '/tb-lab-register',
+        icon: Chemistry,
+        keywords: ['tb', 'tuberculosis', 'afb', 'microscopy', 'sputum', 'genexpert', 'truenat', 'lamp', 'tat'],
+      },
+    ],
+  },
+  {
+    id: 'cancer-screening',
+    title: 'Cancer Screening services',
+    description: 'Cancer Screening Summary',
+    tone: 'violet',
+    reports: [
+      {
+        code: 'MOH 412',
+        name: 'Cancer Screening Register',
+        description: 'Cancer Screening Register',
+        path: '/moh-412-register',
+        icon: Activity,
+        keywords: ['cancer', 'cervical', 'screening'],
+      },
+    ],
+  },
+  {
+    id: 'MOH 711',
+    title: 'MOH 711',
+    description: 'MOH 711 Summary',
+    tone: 'violet',
+    reports: [
+      {
+        code: 'MOH 405',
+        name: 'MOH 405 Register',
+        description: 'MOH 405 Register',
+        path: '/moh-405-register',
+        icon: Activity,
+        keywords: ['anc'],
+      },
+      {
+        code: 'MOH 406',
+        name: 'MOH 406 Register',
+        description: 'MOH 406 Register',
+        path: '/moh-406-register',
+        icon: Activity,
+        keywords: ['pnc'],
+      },
+      {
+        code: 'MOH 333',
+        name: 'MOH 333 Register',
+        description: 'MOH 333 Register',
+        path: '/moh-333-register',
+        icon: Activity,
+        keywords: ['anc'],
+      },
+      {
+        code: 'MOH 407',
+        name: 'MOH 407 Register',
+        description: 'Child Health and Nutrition Register',
+        path: '/moh-407-register',
+        icon: Activity,
+        keywords: ['child health', 'nutrition', 'chanis'],
+      },
+      {
+        code: 'MOH 512',
+        name: 'MOH 512 Register',
+        description: 'MOH 512 Register',
+        path: '/moh-512-register',
+        icon: Activity,
+        keywords: ['family', 'planning'],
+      },
+    ],
+  },
+  {
+    id: 'MOH 710',
+    title: 'MOH 710',
+    description: 'MOH 710',
+    tone: 'violet',
+    reports: [
+      {
+        code: 'MOH 510',
+        name: 'Immunization Register',
+        description: 'Immunization Register',
+        path: '/moh-510-register',
+        icon: Activity,
+        keywords: ['immunization'],
+      },
+      {
+        code: 'MOH 413',
+        name: 'HPV Register',
+        description: 'HPV Register',
+        path: '/moh-413-register',
+        icon: Activity,
+        keywords: ['hpv'],
+      },
+    ],
+  },
+];
+
+export const totalRegisterCount = registerCategories.reduce((count, category) => count + category.reports.length, 0);

package/src/registers/register-file-name.ts

@@ -0,0 +1,18 @@
+import dayjs from 'dayjs';
+
+/**
+ * A register's PDF file name: its code, the facility and the period, e.g.
+ * `MOH-267_Kesses_2026-09.pdf` for a whole month, or
+ * `MOH-267_Kesses_2026-10-01_to_2026-10-28.pdf` for any other range.
+ */
+export function registerFileName(code: string, facility: string, period: { startDate: string; endDate: string }) {
+  const start = dayjs(period.startDate);
+  const end = dayjs(period.endDate);
+  const isWholeMonth = start.isSame(start.startOf('month'), 'day') && end.isSame(start.endOf('month'), 'day');
+  const range = isWholeMonth ? start.format('YYYY-MM') : `${start.format('YYYY-MM-DD')}_to_${end.format('YYYY-MM-DD')}`;
+  const name = [code, facility, period.startDate ? range : '']
+    .filter(Boolean)
+    .join('_')
+    .replace(/[^a-z0-9_-]+/gi, '-');
+  return `${name}.pdf`;
+}