@kenyaemr/esm-patient-registration-app 4.3.0

package/src/patient-registration/validation/patient-registration-validation.tsx

@@ -0,0 +1,46 @@
+import * as Yup from 'yup';
+import mapValues from 'lodash/mapValues';
+import { FormValues } from '../patient-registration-types';
+
+export const validationSchema = Yup.object({
+  givenName: Yup.string().required('givenNameRequired'),
+  familyName: Yup.string().required('familyNameRequired'),
+  additionalGivenName: Yup.string().when('addNameInLocalLanguage', {
+    is: true,
+    then: Yup.string().required('givenNameRequired'),
+    otherwise: Yup.string().notRequired(),
+  }),
+  additionalFamilyName: Yup.string().when('addNameInLocalLanguage', {
+    is: true,
+    then: Yup.string().required('familyNameRequired'),
+    otherwise: Yup.string().notRequired(),
+  }),
+  gender: Yup.string().oneOf(['Male', 'Female', 'Other', 'Unknown'], 'genderUnspecified').required('genderRequired'),
+  birthdate: Yup.date().when('birthdateEstimated', {
+    is: false,
+    then: Yup.date().required('birthdayRequired').max(Date(), 'birthdayNotInTheFuture').nullable(),
+    otherwise: Yup.date().nullable(),
+  }),
+  yearsEstimated: Yup.number().when('birthdateEstimated', {
+    is: true,
+    then: Yup.number().required('yearsEstimateRequired').min(0, 'negativeYears'),
+    otherwise: Yup.number().nullable(),
+  }),
+  monthsEstimated: Yup.number().min(0, 'negativeMonths'),
+  deathDate: Yup.date().max(Date(), 'deathdayNotInTheFuture').nullable(),
+  email: Yup.string().optional().email('invalidEmail'),
+  identifiers: Yup.lazy((obj: FormValues['identifiers']) =>
+    Yup.object(
+      mapValues(obj, () =>
+        Yup.object({
+          required: Yup.bool(),
+          identifierValue: Yup.string().when('required', {
+            is: true,
+            then: Yup.string().required('identifierValueRequired'),
+            otherwise: Yup.string().notRequired(),
+          }),
+        }),
+      ),
+    ),
+  ),
+});

package/src/patient-verification/assets/counties.json

@@ -0,0 +1,236 @@
+[
+    {
+        "name": "Mombasa",
+        "code": 1,
+        "capital": "Mombasa City"
+    },
+    {
+        "name": "Kwale",
+        "code": 2,
+        "capital": "Kwale"
+    },
+    {
+        "name": "Kilifi",
+        "code": 3,
+        "capital": "Kilifi"
+    },
+    {
+        "name": "Tana River",
+        "code": 4,
+        "capital": "Hola"
+    },
+    {
+        "name": "Lamu",
+        "code": 5,
+        "capital": "Lamu"
+    },
+    {
+        "name": "Taita taveta",
+        "code": 6,
+        "capital": "Voi"
+    },
+    {
+        "name": "Garissa",
+        "code": 7,
+        "capital": "Garissa"
+    },
+    {
+        "name": "Wajir",
+        "code": 8,
+        "capital": "Wajir"
+    },
+    {
+        "name": "Mandera",
+        "code": 9,
+        "capital": "Mandera"
+    },
+    {
+        "name": "Marsabit",
+        "code": 10,
+        "capital": "Marsabit"
+    },
+    {
+        "name": "Isiolo",
+        "code": 11,
+        "capital": "Isiolo"
+    },
+    {
+        "name": "Meru",
+        "code": 12,
+        "capital": "Meru"
+    },
+    {
+        "name": "Tharaka nithi",
+        "code": 13,
+        "capital": "Chuka"
+    },
+    {
+        "name": "Embu",
+        "code": 14,
+        "capital": "Embu"
+    },
+    {
+        "name": "Kitui",
+        "code": 15,
+        "capital": "Kitui"
+    },
+    {
+        "name": "Machakos",
+        "code": 16,
+        "capital": "Machakos"
+    },
+    {
+        "name": "Makueni",
+        "code": 17,
+        "capital": "Wote"
+    },
+    {
+        "name": "Nyandarua",
+        "code": 18,
+        "capital": "Ol Kalou"
+    },
+    {
+        "name": "Nyeri",
+        "code": 19,
+        "capital": "Nyeri"
+    },
+    {
+        "name": "Kirinyaga",
+        "code": 20,
+        "capital": "Kerugoya/Kutus"
+    },
+    {
+        "name": "Murang'a",
+        "code": 21,
+        "capital": "Murang'a"
+    },
+    {
+        "name": "Kiambu",
+        "code": 22,
+        "capital": "Kiambu"
+    },
+    {
+        "name": "Turkana",
+        "code": 23,
+        "capital": "Lodwar"
+    },
+    {
+        "name": "West pokot",
+        "code": 24,
+        "capital": "Kapenguria"
+    },
+    {
+        "name": "Samburu",
+        "code": 25,
+        "capital": "Maralal"
+    },
+    {
+        "name": "Trans nzoia",
+        "code": 26,
+        "capital": "Kitale"
+    },
+    {
+        "name": "Uasin gishu",
+        "code": 27,
+        "capital": "Eldoret"
+    },
+    {
+        "name": "Elgeyo marakwet",
+        "code": 28,
+        "capital": "Iten"
+    },
+    {
+        "name": "Nandi",
+        "code": 29,
+        "capital": "Kapsabet"
+    },
+    {
+        "name": "Baringo",
+        "code": 30,
+        "capital": "Kabarnet"
+    },
+    {
+        "name": "Laikipia",
+        "code": 31,
+        "capital": "Rumuruti"
+    },
+    {
+        "name": "Nakuru",
+        "code": 32,
+        "capital": "Nakuru"
+    },
+    {
+        "name": "Narok",
+        "code": 33,
+        "capital": "Narok"
+    },
+    {
+        "name": "Kajiado",
+        "code": 34
+    },
+    {
+        "name": "Kericho",
+        "code": 35,
+        "capital": "Kericho"
+    },
+    {
+        "name": "Bomet",
+        "code": 36,
+        "capital": "Bomet"
+    },
+    {
+        "name": "Kakamega",
+        "code": 37,
+        "capital": "Kakamega"
+    },
+    {
+        "name": "Vihiga",
+        "code": 38,
+        "capital": "Vihiga"
+    },
+    {
+        "name": "Bungoma",
+        "code": 39,
+        "capital": "Bungoma"
+    },
+    {
+        "name": "Busia",
+        "code": 40,
+        "capital": "Busia"
+    },
+    {
+        "name": "Siaya",
+        "code": 41,
+        "capital": "Siaya"
+    },
+    {
+        "name": "Kisumu",
+        "code": 42,
+        "capital": "Kisumu"
+    },
+    {
+        "name": "Homa bay",
+        "code": 43,
+        "capital": "Homa Bay"
+    },
+    {
+        "name": "Migori",
+        "code": 44,
+        "capital": "Migori"
+    },
+    {
+        "name": "Kisii",
+        "code": 45,
+        "capital": "Kisii"
+    },
+    {
+        "name": "Nyamira",
+        "code": 46,
+        "capital": "Nyamira"
+    },
+    {
+        "name": "Nairobi",
+        "code": 47,
+        "capital": "Nairobi City"
+    }
+]

package/src/patient-verification/assets/verification-assets.ts

@@ -0,0 +1,11 @@
+export const countries = [
+  { name: 'Kenya', initials: 'KE' },
+  { name: 'Uganda', initials: 'UG' },
+  { name: 'Tanzania', initials: 'TZ' },
+];
+
+export const verificationIdentifierTypes = [
+  { name: 'National ID', value: 'national-id' },
+  { name: 'Passport', value: 'passport' },
+  { name: 'Birth certificate number', value: 'birth-certificate-number' },
+];

package/src/patient-verification/patient-verification-hook.tsx

@@ -0,0 +1,156 @@
+import { FetchResponse, openmrsFetch, showNotification, showToast } from '@openmrs/esm-framework';
+import { ConceptAnswers, ConceptResponse, FormValues } from '../patient-registration/patient-registration-types';
+import { generateNUPIPayload, handleClientRegistryResponse } from './patient-verification-utils';
+import useSWR from 'swr';
+import useSWRImmutable from 'swr/immutable';
+
+export function searchClientRegistry(identifierType: string, searchTerm: string, token: string) {
+  const url = `https://afyakenyaapi.health.go.ke/partners/registry/search/KE/${identifierType}/${searchTerm}`;
+  return fetch(url, { headers: { Authorization: `Bearer ${token}` } }).then((r) => r.json());
+}
+
+export function savePatientToClientRegistry(formValues: FormValues) {
+  const createdRegistryPatient = generateNUPIPayload(formValues);
+  return fetch(`https://afyakenyaapi.health.go.ke/partners/registry`, {
+    headers: { Authorization: `Bearer ${formValues.token}`, 'Content-Type': 'application/json' },
+    method: 'POST',
+    body: JSON.stringify(createdRegistryPatient),
+  });
+}
+
+export async function handleSavePatientToClientRegistry(
+  formValues: FormValues,
+  setValues: (values: FormValues, shouldValidate?: boolean) => void,
+  inEditMode: boolean,
+) {
+  const mode = inEditMode ? 'edit' : 'new';
+  switch (mode) {
+    case 'edit': {
+      try {
+        const searchResponse = await searchClientRegistry(
+          'national-id',
+          formValues.identifiers['nationalId'].identifierValue,
+          formValues.token,
+        );
+
+        // if client does not exists post client to registry
+        if (searchResponse?.clientExists === false) {
+          postToRegistry(formValues, setValues);
+        }
+      } catch (error) {
+        showToast({
+          title: 'Client registry error',
+          description: `${error}`,
+          millis: 10000,
+          kind: 'error',
+          critical: true,
+        });
+      }
+      return;
+    }
+    case 'new': {
+      postToRegistry(formValues, setValues);
+    }
+  }
+}
+
+export function useConceptAnswers(conceptUuid: string): { data: Array<ConceptAnswers>; isLoading: boolean } {
+  const { data, error, isLoading } = useSWR<FetchResponse<ConceptResponse>, Error>(
+    `/ws/rest/v1/concept/${conceptUuid}`,
+    openmrsFetch,
+  );
+  if (error) {
+    showToast({
+      title: error.name,
+      description: error.message,
+      kind: 'error',
+    });
+  }
+  return { data: data?.data?.answers ?? [], isLoading };
+}
+
+const urlencoded = new URLSearchParams();
+urlencoded.append('client_id', 'palladium.partner.client');
+urlencoded.append('client_secret', '28f95b2a');
+urlencoded.append('grant_type', 'client_credentials');
+urlencoded.append('scope', 'DHP.Gateway DHP.Partners');
+
+const swrFetcher = async (url) => {
+  const res = await fetch(url, {
+    method: 'POST',
+    body: urlencoded,
+    redirect: 'follow',
+  });
+
+  // If the status code is not in the range 200-299,
+  // we still try to parse and throw it.
+  if (!res.ok) {
+    const error = new Error('An error occurred while fetching the data.') as any;
+    // Attach extra info to the error object.
+    error.info = await res.json();
+    error.status = res.status;
+    throw error;
+  }
+
+  return res.json();
+};
+
+export function useGlobalProperties() {
+  const { data, isLoading, error } = useSWRImmutable(
+    `https://afyakenyaidentityapi.health.go.ke/connect/token`,
+    swrFetcher,
+    { refreshInterval: 864000 },
+  );
+  return { data: data, isLoading, error };
+}
+
+async function postToRegistry(
+  formValues: FormValues,
+  setValues: (values: FormValues, shouldValidate?: boolean) => void,
+) {
+  try {
+    const clientRegistryResponse = await savePatientToClientRegistry(formValues);
+    if (clientRegistryResponse.ok) {
+      const savedValues = await clientRegistryResponse.json();
+      const nupiIdentifier = {
+        ['nationalUniquePatientIdentifier']: {
+          identifierTypeUuid: 'f85081e2-b4be-4e48-b3a4-7994b69bb101',
+          identifierName: 'National Unique patient identifier',
+          identifierValue: savedValues['clientNumber'],
+          initialValue: savedValues['clientNumber'],
+          identifierUuid: undefined,
+          selectedSource: { uuid: '', name: '' },
+          preferred: false,
+          required: false,
+        },
+      };
+      setValues({ ...formValues, identifiers: { ...formValues.identifiers, ...nupiIdentifier } });
+      showToast({
+        title: 'Posted patient to client registry successfully',
+        description: `The patient has been saved to client registry`,
+        kind: 'success',
+      });
+    } else {
+      const responseError = await clientRegistryResponse.json();
+      const errorMessage = Object.values(responseError.errors ?? {})
+        .map((error: any) => error.join())
+        .toString();
+      setValues({
+        ...formValues,
+        attributes: {
+          ...formValues.attributes,
+          ['869f623a-f78e-4ace-9202-0bed481822f5']: 'Failed validation',
+          ['752a0331-5293-4aa5-bf46-4d51aaf2cdc5']: 'Failed',
+        },
+      });
+      showNotification({
+        title: responseError.title,
+        description: errorMessage,
+        kind: 'warning',
+        millis: 150000,
+      });
+    }
+  } catch (error) {
+    showNotification({ kind: 'error', title: 'NUPI Post failed', description: JSON.stringify(error) });
+  }
+}

package/src/patient-verification/patient-verification-utils.ts

@@ -0,0 +1,173 @@
+import { showModal } from '@openmrs/esm-framework';
+import { FormikProps } from 'formik';
+import { FormValues } from '../patient-registration/patient-registration-types';
+import { ClientRegistryPatient, RegistryPatient } from './verification-types';
+import counties from './assets/counties.json';
+
+export function handleClientRegistryResponse(
+  clientResponse: ClientRegistryPatient,
+  props: FormikProps<FormValues>,
+  searchTerm: string,
+) {
+  if (clientResponse?.clientExists === false) {
+    const nupiIdentifiers = {
+      ['nationalId']: {
+        initialValue: searchTerm,
+        identifierUuid: undefined,
+        selectedSource: { uuid: '', name: '' },
+        preferred: false,
+        required: false,
+        identifierTypeUuid: '49af6cdc-7968-4abb-bf46-de10d7f4859f',
+        identifierName: 'National ID',
+        identifierValue: searchTerm,
+      },
+    };
+    const dispose = showModal('empty-client-registry-modal', {
+      onConfirm: () => {
+        props.setValues({ ...props.values, identifiers: { ...props.values.identifiers, ...nupiIdentifiers } });
+        dispose();
+      },
+      close: () => dispose(),
+    });
+  }
+
+  if (clientResponse?.clientExists) {
+    const {
+      client: {
+        middleName,
+        lastName,
+        firstName,
+        contact,
+        country,
+        countyOfBirth,
+        residence,
+        identifications,
+        gender,
+        dateOfBirth,
+        isAlive,
+        clientNumber,
+        educationLevel,
+        occupation,
+        maritalStatus,
+      },
+    } = clientResponse;
+
+    const nupiIdentifiers = {
+      ['nationalId']: {
+        initialValue: identifications !== undefined && identifications[0]?.identificationNumber,
+        identifierUuid: undefined,
+        selectedSource: { uuid: '', name: '' },
+        preferred: false,
+        required: false,
+        identifierTypeUuid: '49af6cdc-7968-4abb-bf46-de10d7f4859f',
+        identifierName: 'National ID',
+        identifierValue: identifications !== undefined && identifications[0]?.identificationNumber,
+      },
+
+      ['nationalUniquePatientIdentifier']: {
+        identifierTypeUuid: 'f85081e2-b4be-4e48-b3a4-7994b69bb101',
+        identifierName: 'National Unique patient identifier',
+        identifierValue: clientNumber,
+        initialValue: clientNumber,
+        identifierUuid: undefined,
+        selectedSource: { uuid: '', name: '' },
+        preferred: false,
+        required: false,
+      },
+    };
+
+    const dispose = showModal('confirm-client-registry-modal', {
+      onConfirm: () => {
+        props.setValues({
+          ...props.values,
+          familyName: lastName,
+          middleName: middleName,
+          givenName: firstName,
+          gender: gender === 'male' ? 'Male' : 'Female',
+          birthdate: new Date(dateOfBirth),
+          isDead: !isAlive,
+          attributes: {
+            'b2c38640-2603-4629-aebd-3b54f33f1e3a': contact?.primaryPhone,
+            '94614350-84c8-41e0-ac29-86bc107069be': contact?.secondaryPhone,
+            'b8d0b331-1d2d-4a9a-b741-1816f498bdb6': contact?.emailAddress ?? '',
+          },
+          address: {
+            address1: residence?.address,
+            address2: '',
+            address4: residence?.ward,
+            cityVillage: residence?.village,
+            stateProvince: residence?.subCounty,
+            countyDistrict: counties.find((county) => county.code === parseInt(residence?.county))?.name,
+            country: 'Kenya',
+            postalCode: residence?.address,
+          },
+          identifiers: { ...props.values.identifiers, ...nupiIdentifiers },
+          obs: {
+            '1054AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA':
+              props.values.concepts.find((concept) => concept.display?.toLowerCase() === maritalStatus?.toLowerCase())
+                ?.uuid ?? '',
+            '1712AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA':
+              props.values.concepts.find((concept) => concept.display?.toLowerCase() === educationLevel?.toLowerCase())
+                ?.uuid ?? '',
+            '1542AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA':
+              props.values.concepts.find((concept) => concept.display?.toLowerCase() === occupation?.toLowerCase())
+                ?.uuid ?? '',
+          },
+        });
+        dispose();
+      },
+      close: () => dispose(),
+      patient: clientResponse.client,
+    });
+  }
+}
+
+export function generateNUPIPayload(formValues: FormValues): RegistryPatient {
+  const educationLevel = formValues.concepts.find(
+    (concept) => concept.uuid === formValues.obs['1712AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'],
+  );
+  const occupation = formValues.concepts.find(
+    (concept) => concept.uuid === formValues.obs['1542AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'],
+  );
+  const maritalStatus = formValues.concepts.find(
+    (concept) => concept.uuid === formValues.obs['1054AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'],
+  );
+
+  let createRegistryPatient: RegistryPatient = {
+    firstName: formValues?.givenName,
+    middleName: formValues?.middleName,
+    lastName: formValues?.familyName,
+    gender: formValues?.gender === 'Male' ? 'male' : 'female',
+    dateOfBirth: new Date(formValues.birthdate).toISOString(),
+    isAlive: !formValues.isDead,
+    residence: {
+      county: `0${counties.find((county) => county.name.includes(formValues.address['countyDistrict']))?.code}`,
+      subCounty: formValues.address['stateProvince']?.toLocaleLowerCase(),
+      ward: formValues.address['address4']?.toLocaleLowerCase(),
+      village: formValues.address['cityVillage'],
+      landmark: formValues.address['address2'],
+      address: formValues.address['postalCode'],
+    },
+    nextOfKins: [],
+    contact: {
+      primaryPhone: formValues.attributes['b2c38640-2603-4629-aebd-3b54f33f1e3a'],
+      secondaryPhone: formValues.attributes['94614350-84c8-41e0-ac29-86bc107069be'],
+      emailAddress: formValues.attributes['b8d0b331-1d2d-4a9a-b741-1816f498bdb6'],
+    },
+    country: 'KE',
+    countyOfBirth: `0${counties.find((county) => county.name.includes(formValues.address['countyDistrict']))?.code}`,
+    educationLevel: educationLevel?.display?.toLowerCase() ?? '',
+    religion: '',
+    occupation: occupation?.display?.toLowerCase() ?? '',
+    maritalStatus: maritalStatus?.display?.toLowerCase() ?? '',
+    originFacilityKmflCode: '',
+    nascopCCCNumber: '',
+    identifications: [
+      {
+        identificationType: 'national-id',
+        identificationNumber: formValues.identifiers['nationalId']?.identifierValue,
+      },
+    ],
+  };
+  return createRegistryPatient;
+}