@pih/esm-audit-app 2.1.1-pre.144 → 2.1.1-pre.151

package/dist/pih-esm-audit-app.js.buildmanifest.json

@@ -21,7 +21,7 @@
       "auxiliaryFiles": [
         "115.js.map"
       ],
-      "hash": "91fcdd326c84f41f",
+      "hash": "9b41c7e832a25bd9",
       "childrenByOrder": {}
     },
     {
@@ -29,9 +29,9 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "size": 3364,
+      "size": 5110,
       "sizes": {
-        "javascript": 3364
+        "javascript": 5110
       },
       "names": [],
       "idHints": [],
@@ -45,7 +45,7 @@
       "auxiliaryFiles": [
         "117.js.map"
       ],
-      "hash": "8b233dccf540208a",
+      "hash": "0882b3e8a79e8e83",
       "childrenByOrder": {}
     },
     {
@@ -73,7 +73,7 @@
       "auxiliaryFiles": [
         "pih-esm-audit-app.js.map"
       ],
-      "hash": "04e926524843a4d0",
+      "hash": "023ea685c1be22f5",
       "childrenByOrder": {}
     },
     {
@@ -155,23 +155,26 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "size": 168384,
+      "reason": "split chunk (cache group: defaultVendors)",
+      "size": 1408999,
       "sizes": {
-        "javascript": 168384
+        "javascript": 1408999
       },
       "names": [],
-      "idHints": [],
+      "idHints": [
+        "vendors"
+      ],
       "runtime": [
         "@pih/esm-audit-app",
         "main"
       ],
       "files": [
-        "446.js"
+        "455.js"
       ],
       "auxiliaryFiles": [
-        "446.js.map"
+        "455.js.map"
       ],
-      "hash": "2260bb51ed561074",
+      "hash": "5342a8efbabac44a",
       "childrenByOrder": {}
     },
     {
@@ -179,26 +182,23 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "reason": "split chunk (cache group: defaultVendors)",
-      "size": 1408999,
+      "size": 7103,
       "sizes": {
-        "javascript": 1408999
+        "javascript": 7103
       },
       "names": [],
-      "idHints": [
-        "vendors"
-      ],
+      "idHints": [],
       "runtime": [
         "@pih/esm-audit-app",
         "main"
       ],
       "files": [
-        "455.js"
+        "466.js"
       ],
       "auxiliaryFiles": [
-        "455.js.map"
+        "466.js.map"
       ],
-      "hash": "5342a8efbabac44a",
+      "hash": "c30f3521edea15c4",
       "childrenByOrder": {}
     },
     {
@@ -206,9 +206,9 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "size": 7103,
+      "size": 6134,
       "sizes": {
-        "javascript": 7103
+        "javascript": 6134
       },
       "names": [],
       "idHints": [],
@@ -217,12 +217,12 @@
         "main"
       ],
       "files": [
-        "466.js"
+        "508.js"
       ],
       "auxiliaryFiles": [
-        "466.js.map"
+        "508.js.map"
       ],
-      "hash": "c30f3521edea15c4",
+      "hash": "3b9069416bf40695",
       "childrenByOrder": {}
     },
     {
@@ -230,9 +230,9 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "size": 3879,
+      "size": 250106,
       "sizes": {
-        "javascript": 3879
+        "javascript": 250106
       },
       "names": [],
       "idHints": [],
@@ -241,12 +241,12 @@
         "main"
       ],
       "files": [
-        "508.js"
+        "514.js"
       ],
       "auxiliaryFiles": [
-        "508.js.map"
+        "514.js.map"
       ],
-      "hash": "e05374f843e2bf5a",
+      "hash": "d648c72c6a3e4231",
       "childrenByOrder": {}
     },
     {
@@ -474,7 +474,7 @@
       "auxiliaryFiles": [
         "main.js.map"
       ],
-      "hash": "d57eba330529428c",
+      "hash": "b4eb44e7a939436c",
       "childrenByOrder": {}
     },
     {
@@ -482,9 +482,9 @@
       "rendered": true,
       "initial": false,
       "entry": false,
-      "size": 3773,
+      "size": 5812,
       "sizes": {
-        "javascript": 3773
+        "javascript": 5812
       },
       "names": [],
       "idHints": [],
@@ -498,7 +498,7 @@
       "auxiliaryFiles": [
         "912.js.map"
       ],
-      "hash": "0d0036fbbb3a7739",
+      "hash": "40f746c2367391da",
       "childrenByOrder": {}
     },
     {

package/dist/routes.json

@@ -1 +1 @@
-{"$schema":"https://json.openmrs.org/routes.schema.json","extensions":[{"name":"audit-dashboard-link","slot":"homepage-dashboard-slot","component":"auditDashboardLink","meta":{"name":"audit","slot":"audit-dashboard-slot","title":"Audit"}},{"name":"audit-dashboard","slot":"audit-dashboard-slot","component":"root"}],"version":"2.1.1-pre.144"}
+{"$schema":"https://json.openmrs.org/routes.schema.json","extensions":[{"name":"audit-dashboard-link","slot":"homepage-dashboard-slot","component":"auditDashboardLink","meta":{"name":"audit","slot":"audit-dashboard-slot","title":"Audit"}},{"name":"audit-dashboard","slot":"audit-dashboard-slot","component":"root"}],"version":"2.1.1-pre.151"}

package/locales/en/translation.json

@@ -0,0 +1,118 @@
+{
+  "searchBy": "Search by",
+  "patients": "Patients",
+  "users": "Users",
+  "providers": "Providers",
+  "auditTrail": "Audit trail",
+  "encounterAudit": "Encounter audit",
+  "encounterNotFound": "That encounter could not be found.",
+  "patient": "Patient",
+  "identifier": "Identifier",
+  "encounterDate": "Encounter date",
+  "location": "Location",
+  "visit": "Visit",
+  "encounterType": "Encounter type",
+  "form": "Form",
+  "createdBy": "Created by",
+  "changedBy": "Changed by",
+  "deletedBy": "Deleted by",
+  "deletionReason": "Reason for deletion",
+  "encounter": "Encounter",
+  "deleted": "Deleted",
+  "encounterDeletedSubtitle": "This encounter has been deleted. Its observations are shown as they were left.",
+  "encounterDeleted": "Deleted encounter",
+  "encounterSummary": "Encounter summary",
+  "noProviders": "No providers are recorded for this encounter.",
+  "role": "Role",
+  "providerName": "Provider name",
+  "backToEncounters": "Back to encounters",
+  "allEncounterTypes": "All encounter types",
+  "encounterDateRange": "Encounter date range",
+  "clearFilters": "Clear filters",
+  "edited": "Edited",
+  "editedLegend": "the value was changed after it was first recorded",
+  "addedLater": "Added later",
+  "addedLaterLegend": "recorded after the encounter itself was created",
+  "deletedLegend": "removed from the encounter",
+  "previousValue": "Previous value",
+  "previousValueLegend": "the value that an edit replaced",
+  "observations": "Observations",
+  "showDeletedObs": "Show deleted observations",
+  "showConceptDescriptions": "Show concept descriptions",
+  "noObservations": "This encounter has no observations.",
+  "questionConcept": "Question concept",
+  "value": "Value",
+  "change": "Change",
+  "recordedBy": "Recorded by",
+  "wasPreviously": "was {{value}}",
+  "changedByUser": "Changed by {{user}}",
+  "encounterCreatedAction": "Created encounter",
+  "encounterChangedAction": "Changed encounter",
+  "encounterDeletedAction": "Deleted encounter",
+  "obsRecordedAction": "Recorded observation",
+  "obsEditedAction": "Edited observation",
+  "obsDeletedAction": "Deleted observation",
+  "recordActivity": "Patient activity",
+  "readingObservations": "Reading observations from {{read}} of {{total}} encounters…",
+  "noActivity": "There is no recorded activity to show.",
+  "whoTouchedThisRecord": "Who modified this patient record",
+  "user": "User",
+  "encountersCreated": "Encounters created",
+  "obsRecordedCount": "Observations recorded",
+  "obsEditedCount": "Observations edited",
+  "obsDeletedCount": "Observations deleted",
+  "firstActivity": "First activity",
+  "lastActivity": "Last activity",
+  "showOnlyThisUser": "Show only this user's activity",
+  "unknownUser": "Unknown user",
+  "activityLog": "Activity log",
+  "showEveryone": "Show everyone",
+  "when": "When",
+  "action": "Action",
+  "detail": "Detail",
+  "encounters": "Encounters",
+  "noEncountersMatchFilters": "No encounters match these filters.",
+  "noEncountersFound": "This patient has no encounters to audit.",
+  "provider": "Provider",
+  "status": "Status",
+  "backToPatientSearch": "Back to patient search",
+  "includeDeletedEncounters": "Include deleted encounters",
+  "cannotIncludeDeletedEncounters": "Deleted encounters can only be listed for a patient who has an identifier.",
+  "deletedEncountersUnavailable": "Deleted encounters unavailable",
+  "auditViews": "Audit views",
+  "searchForPatient": "Search for a patient by name or identifier",
+  "searchToBegin": "Enter a patient name or identifier to begin auditing their records.",
+  "patientSearchResults": "Patient search results",
+  "noPatientsFound": "No patients match \"{{searchTerm}}\".",
+  "patientName": "Patient name",
+  "gender": "Gender",
+  "age": "Age",
+  "birthdate": "Date of birth",
+  "backToProviderSearch": "Back to provider search",
+  "providerEncountersScope": "These are the encounters this provider is recorded on, which is not the same as the ones they entered or changed — the last column names who did that, and the Users tab searches by it.",
+  "recordedAsProvider": "Recorded as provider",
+  "noProviderEncountersMatch": "No encounters for this provider match these filters.",
+  "noProviderEncounters": "This provider is not recorded on any encounters.",
+  "searchForProvider": "Search for a provider by name or identifier",
+  "searchProviderToBegin": "Enter a provider name or identifier to see the encounters they are recorded on.",
+  "providerSearchResults": "Provider search results",
+  "noProvidersFound": "No providers match \"{{searchTerm}}\".",
+  "backToUserSearch": "Back to user search",
+  "changedBetween": "Changed between",
+  "readingUserObservations": "Read {{obsRead}} observations so far…",
+  "noUserEncountersMatch": "This user did not change any observations matching these filters.",
+  "noUserEncounters": "This user has not recorded or deleted any observations.",
+  "userScanStoppedEarly": "Stopped after reading {{obsRead}} observation changes without filling the page. Narrow the date range to search further back.",
+  "partialUserScan": "Part of the trail",
+  "lastChanged": "Last changed",
+  "lookingForMoreEncounters": "Looking for more encounters…",
+  "encounterRange": "Encounters {{from}}–{{to}}",
+  "searchForUser": "Search for a user by name or username",
+  "searchUserToBegin": "Enter a name or username to see the encounters that user has modified.",
+  "userSearchResults": "User search results",
+  "noUsersFound": "No users match \"{{searchTerm}}\".",
+  "name": "Name",
+  "username": "Username",
+  "retired": "Retired",
+  "audit": ""
+}

package/locales/fr/translation.json

@@ -0,0 +1,118 @@
+{
+  "searchBy": "Search by",
+  "patients": "Patients",
+  "users": "Users",
+  "providers": "Providers",
+  "auditTrail": "Audit trail",
+  "encounterAudit": "Encounter audit",
+  "encounterNotFound": "That encounter could not be found.",
+  "patient": "Patient",
+  "identifier": "Identifier",
+  "encounterDate": "Encounter date",
+  "location": "Location",
+  "visit": "Visit",
+  "encounterType": "Encounter type",
+  "form": "Form",
+  "createdBy": "Created by",
+  "changedBy": "Changed by",
+  "deletedBy": "Deleted by",
+  "deletionReason": "Reason for deletion",
+  "encounter": "Encounter",
+  "deleted": "Deleted",
+  "encounterDeletedSubtitle": "This encounter has been deleted. Its observations are shown as they were left.",
+  "encounterDeleted": "Deleted encounter",
+  "encounterSummary": "Encounter summary",
+  "noProviders": "No providers are recorded for this encounter.",
+  "role": "Role",
+  "providerName": "Provider name",
+  "backToEncounters": "Back to encounters",
+  "allEncounterTypes": "All encounter types",
+  "encounterDateRange": "Encounter date range",
+  "clearFilters": "Clear filters",
+  "edited": "Edited",
+  "editedLegend": "the value was changed after it was first recorded",
+  "addedLater": "Added later",
+  "addedLaterLegend": "recorded after the encounter itself was created",
+  "deletedLegend": "removed from the encounter",
+  "previousValue": "Previous value",
+  "previousValueLegend": "the value that an edit replaced",
+  "observations": "Observations",
+  "showDeletedObs": "Show deleted observations",
+  "showConceptDescriptions": "Show concept descriptions",
+  "noObservations": "This encounter has no observations.",
+  "questionConcept": "Question concept",
+  "value": "Value",
+  "change": "Change",
+  "recordedBy": "Recorded by",
+  "wasPreviously": "was {{value}}",
+  "changedByUser": "Changed by {{user}}",
+  "encounterCreatedAction": "Created encounter",
+  "encounterChangedAction": "Changed encounter",
+  "encounterDeletedAction": "Deleted encounter",
+  "obsRecordedAction": "Recorded observation",
+  "obsEditedAction": "Edited observation",
+  "obsDeletedAction": "Deleted observation",
+  "recordActivity": "Patient activity",
+  "readingObservations": "Reading observations from {{read}} of {{total}} encounters…",
+  "noActivity": "There is no recorded activity to show.",
+  "whoTouchedThisRecord": "Who modified this patient record",
+  "user": "User",
+  "encountersCreated": "Encounters created",
+  "obsRecordedCount": "Observations recorded",
+  "obsEditedCount": "Observations edited",
+  "obsDeletedCount": "Observations deleted",
+  "firstActivity": "First activity",
+  "lastActivity": "Last activity",
+  "showOnlyThisUser": "Show only this user's activity",
+  "unknownUser": "Unknown user",
+  "activityLog": "Activity log",
+  "showEveryone": "Show everyone",
+  "when": "When",
+  "action": "Action",
+  "detail": "Detail",
+  "encounters": "Encounters",
+  "noEncountersMatchFilters": "No encounters match these filters.",
+  "noEncountersFound": "This patient has no encounters to audit.",
+  "provider": "Provider",
+  "status": "Status",
+  "backToPatientSearch": "Back to patient search",
+  "includeDeletedEncounters": "Include deleted encounters",
+  "cannotIncludeDeletedEncounters": "Deleted encounters can only be listed for a patient who has an identifier.",
+  "deletedEncountersUnavailable": "Deleted encounters unavailable",
+  "auditViews": "Audit views",
+  "searchForPatient": "Search for a patient by name or identifier",
+  "searchToBegin": "Enter a patient name or identifier to begin auditing their records.",
+  "patientSearchResults": "Patient search results",
+  "noPatientsFound": "No patients match \"{{searchTerm}}\".",
+  "patientName": "Patient name",
+  "gender": "Gender",
+  "age": "Age",
+  "birthdate": "Date of birth",
+  "backToProviderSearch": "Back to provider search",
+  "providerEncountersScope": "These are the encounters this provider is recorded on, which is not the same as the ones they entered or changed — the last column names who did that, and the Users tab searches by it.",
+  "recordedAsProvider": "Recorded as provider",
+  "noProviderEncountersMatch": "No encounters for this provider match these filters.",
+  "noProviderEncounters": "This provider is not recorded on any encounters.",
+  "searchForProvider": "Search for a provider by name or identifier",
+  "searchProviderToBegin": "Enter a provider name or identifier to see the encounters they are recorded on.",
+  "providerSearchResults": "Provider search results",
+  "noProvidersFound": "No providers match \"{{searchTerm}}\".",
+  "backToUserSearch": "Back to user search",
+  "changedBetween": "Changed between",
+  "readingUserObservations": "Read {{obsRead}} observations so far…",
+  "noUserEncountersMatch": "This user did not change any observations matching these filters.",
+  "noUserEncounters": "This user has not recorded or deleted any observations.",
+  "userScanStoppedEarly": "Stopped after reading {{obsRead}} observation changes without filling the page. Narrow the date range to search further back.",
+  "partialUserScan": "Part of the trail",
+  "lastChanged": "Last changed",
+  "lookingForMoreEncounters": "Looking for more encounters…",
+  "encounterRange": "Encounters {{from}}–{{to}}",
+  "searchForUser": "Search for a user by name or username",
+  "searchUserToBegin": "Enter a name or username to see the encounters that user has modified.",
+  "userSearchResults": "User search results",
+  "noUsersFound": "No users match \"{{searchTerm}}\".",
+  "name": "Name",
+  "username": "Username",
+  "retired": "Retired",
+  "audit": ""
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pih/esm-audit-app",
-  "version": "2.1.1-pre.144",
+  "version": "2.1.1-pre.151",
   "description": "An audit trail for patient encounters and observations in the PIH EMR",
   "browser": "dist/pih-esm-audit-app.js",
   "main": "src/index.ts",

package/src/audit/audit-search.component.tsx

@@ -0,0 +1,58 @@
+import React from 'react';
+import { useTranslation } from 'react-i18next';
+import { Tab, TabList, TabPanel, TabPanels, Tabs } from '@carbon/react';
+import PatientSearch from './patient-search.component';
+import ProviderSearch from './provider-search.component';
+import UserSearch from './user-search.component';
+import styles from './audit.scss';
+
+export type AuditSearchTab = 'patients' | 'users' | 'providers';
+
+export const auditSearchTabs: Array<AuditSearchTab> = ['patients', 'users', 'providers'];
+
+interface AuditSearchProps {
+  tab: AuditSearchTab;
+  onSelectTab(tab: AuditSearchTab): void;
+  onSelectPatient(patientUuid: string): void;
+  onSelectUser(userUuid: string): void;
+  onSelectProvider(providerUuid: string): void;
+}
+
+/**
+ * Where the audit trail starts: find the record to audit — by the patient it belongs to, by the
+ * user who changed it, or by a provider recorded on it.
+ */
+export default function AuditSearch({
+  tab,
+  onSelectTab,
+  onSelectPatient,
+  onSelectUser,
+  onSelectProvider,
+}: AuditSearchProps) {
+  const { t } = useTranslation();
+
+  return (
+    <div className={styles.section}>
+      <Tabs
+        onChange={({ selectedIndex }) => onSelectTab(auditSearchTabs[selectedIndex])}
+        selectedIndex={Math.max(0, auditSearchTabs.indexOf(tab))}>
+        <TabList aria-label={t('searchBy', 'Search by')}>
+          <Tab>{t('patients', 'Patients')}</Tab>
+          <Tab>{t('users', 'Users')}</Tab>
+          <Tab>{t('providers', 'Providers')}</Tab>
+        </TabList>
+        <TabPanels>
+          <TabPanel>
+            <PatientSearch onSelectPatient={onSelectPatient} />
+          </TabPanel>
+          <TabPanel>
+            <UserSearch onSelectUser={onSelectUser} />
+          </TabPanel>
+          <TabPanel>
+            <ProviderSearch onSelectProvider={onSelectProvider} />
+          </TabPanel>
+        </TabPanels>
+      </Tabs>
+    </div>
+  );
+}

package/src/audit/audit.component.tsx

@@ -2,42 +2,65 @@ import React, { useCallback } from 'react';
 import { useSearchParams } from 'react-router-dom';
 import { useTranslation } from 'react-i18next';
 import { PageHeader, PageHeaderContent, PatientSearchPictogram } from '@openmrs/esm-framework';
+import AuditSearch, { type AuditSearchTab, auditSearchTabs } from './audit-search.component';
 import EncounterAudit from './encounter-audit.component';
 import PatientRecord, { type PatientRecordView, patientRecordViews } from './patient-record.component';
-import PatientSearch from './patient-search.component';
+import ProviderEncounters from './provider-encounters.component';
+import UserEncounters from './user-encounters.component';
 import styles from './audit.scss';
 
+interface AuditLocation {
+  patient?: string;
+  user?: string;
+  provider?: string;
+  encounter?: string;
+  view?: PatientRecordView;
+  search?: AuditSearchTab;
+}
+
+const locationParams: Array<keyof AuditLocation> = ['patient', 'user', 'provider', 'encounter', 'view', 'search'];
+
 /**
- * The audit trail is a three step drill-down — find a patient, pick one of their encounters, then
- * read what was entered, changed and deleted on it. The current step is held in the query string
- * so that a particular encounter's audit trail can be linked to and so that the browser's back
- * button walks back up the drill-down.
+ * The audit trail is a drill-down — find the record, pick one of its encounters, then read what
+ * was entered, changed and deleted on it. Where it is drilled down to is held in the query
+ * string, so a particular encounter's audit trail can be linked to and so that the browser's back
+ * button walks back up.
  */
 export default function Audit() {
   const { t } = useTranslation();
   const [searchParams, setSearchParams] = useSearchParams();
   const patientUuid = searchParams.get('patient');
+  const userUuid = searchParams.get('user');
+  const providerUuid = searchParams.get('provider');
   const encounterUuid = searchParams.get('encounter');
-  const view = searchParams.get('view');
-  const patientRecordView: PatientRecordView = patientRecordViews.includes(view as PatientRecordView)
-    ? (view as PatientRecordView)
-    : 'encounters';
+
+  const oneOf = <T,>(allowed: Array<T>, value: string | null, fallback: T): T =>
+    allowed.includes(value as T) ? (value as T) : fallback;
+  const patientRecordView = oneOf(patientRecordViews, searchParams.get('view'), 'encounters');
+  const searchTab = oneOf(auditSearchTabs, searchParams.get('search'), 'patients');
 
   const goTo = useCallback(
-    (next: { patient?: string; encounter?: string; view?: PatientRecordView }) => {
+    (next: AuditLocation) => {
       const params = new URLSearchParams(searchParams);
-      params.delete('patient');
-      params.delete('encounter');
-      params.delete('view');
+      locationParams.forEach((param) => params.delete(param));
       if (next.patient) {
         params.set('patient', next.patient);
       }
+      if (next.user) {
+        params.set('user', next.user);
+      }
+      if (next.provider) {
+        params.set('provider', next.provider);
+      }
       if (next.encounter) {
         params.set('encounter', next.encounter);
       }
       if (next.view && next.view !== 'encounters') {
         params.set('view', next.view);
       }
+      if (next.search && next.search !== 'patients') {
+        params.set('search', next.search);
+      }
       setSearchParams(params);
     },
     [searchParams, setSearchParams],
@@ -51,18 +74,42 @@ export default function Audit() {
       {encounterUuid ? (
         <EncounterAudit
           encounterUuid={encounterUuid}
-          onBackToEncounters={(uuid) => goTo({ patient: uuid ?? patientUuid, view: patientRecordView })}
+          onBackToEncounters={(uuid) =>
+            userUuid
+              ? goTo({ user: userUuid })
+              : providerUuid
+                ? goTo({ provider: providerUuid })
+                : goTo({ patient: uuid ?? patientUuid, view: patientRecordView })
+          }
+        />
+      ) : userUuid ? (
+        <UserEncounters
+          onBackToSearch={() => goTo({ search: 'users' })}
+          onSelectEncounter={(uuid) => goTo({ user: userUuid, encounter: uuid })}
+          userUuid={userUuid}
+        />
+      ) : providerUuid ? (
+        <ProviderEncounters
+          onBackToSearch={() => goTo({ search: 'providers' })}
+          onSelectEncounter={(uuid) => goTo({ provider: providerUuid, encounter: uuid })}
+          providerUuid={providerUuid}
         />
       ) : patientUuid ? (
         <PatientRecord
-          onBackToSearch={() => goTo({})}
+          onBackToSearch={() => goTo({ search: 'patients' })}
           onSelectEncounter={(uuid) => goTo({ patient: patientUuid, encounter: uuid, view: patientRecordView })}
           onSelectView={(nextView) => goTo({ patient: patientUuid, view: nextView })}
           patientUuid={patientUuid}
           view={patientRecordView}
         />
       ) : (
-        <PatientSearch onSelectPatient={(uuid) => goTo({ patient: uuid })} />
+        <AuditSearch
+          onSelectPatient={(uuid) => goTo({ patient: uuid })}
+          onSelectProvider={(uuid) => goTo({ provider: uuid })}
+          onSelectTab={(tab) => goTo({ search: tab })}
+          onSelectUser={(uuid) => goTo({ user: uuid })}
+          tab={searchTab}
+        />
       )}
     </div>
   );