@ampath/esm-dha-workflow-app 4.0.0-next.4 → 4.0.0-next.41

package/src/registry/types/index.ts

@@ -0,0 +1,309 @@
+import { type Location, type Patient } from '@openmrs/esm-framework';
+
+export type IdentifierType = 'National ID' | 'Alien ID' | 'Passport' | 'Mandate Number' | 'Refugee ID';
+
+export const IDENTIFIER_TYPES: IdentifierType[] = [
+  'National ID',
+  'Alien ID',
+  'Passport',
+  'Mandate Number',
+  'Refugee ID',
+];
+
+export enum OtpStatus {
+  Draft = 'DRAFT',
+  Sent = 'SENT',
+  Verified = 'VERIFIED',
+}
+
+export interface ValidateCustomOtpResponse {
+  message: string;
+  isValid?: boolean;
+}
+
+export type ClientRegistrySearchRequest = {
+  identificationNumber: string | number;
+  identificationType: string;
+  locationUuid: string;
+};
+
+export interface RequestCustomOtpResponse {
+  message: string;
+  sessionId: string;
+  maskedPhone: string;
+}
+
+export interface ValidateHieCustomOtpDto {
+  sessionId: string;
+  otp: number | string;
+  locationUuid: string;
+}
+
+export interface ValidateCustomOtpResponse {
+  message: string;
+  isValid?: boolean;
+}
+
+export type RequestCustomOtpDto = {
+  identificationNumber: string | number;
+  identificationType: string;
+  locationUuid: string;
+};
+
+export interface RequestCustomOtpResponse {
+  message: string;
+  sessionId: string;
+  maskedPhone: string;
+}
+
+export interface ValidateHieCustomOtpDto {
+  sessionId: string;
+  otp: number | string;
+  locationUuid: string;
+}
+
+export enum HieIdentificationType {
+  NationalID = 'National ID',
+  SHANumber = 'SHA Number',
+  HouseholdNumber = 'Household Number',
+  RefugeeID = 'Refugee ID',
+  AlienID = 'Alien ID',
+  MandateNumber = 'Mandate Number',
+  Cr = 'id',
+  TemporaryDependantID = 'Temporary Dependant ID',
+  BirthCertificate = 'Birth Certificate',
+}
+
+export interface HieIdentifications {
+  identification_number: string;
+  identification_type: HieIdentificationType;
+}
+
+export interface HieDependant {
+  date_added: string;
+  relationship: string;
+  total: number;
+  result: HieClient[];
+}
+
+export interface AlternateContact {
+  contact_type: string;
+  contact_id: string;
+  contact_name: string;
+  relationship: string;
+  remarks: string;
+}
+
+export interface HieClient {
+  resourceType: string;
+  id: string;
+  meta: {
+    versionId: string;
+    creationTime: string;
+    lastUpdated: string;
+    source: string;
+  };
+  originSystem: {
+    system: string;
+    record_id: string;
+  };
+  title: string;
+  first_name: string;
+  middle_name: string;
+  last_name: string;
+  gender: string;
+  date_of_birth: string;
+  place_of_birth: string;
+  person_with_disability: number;
+  citizenship: string;
+  kra_pin: string;
+  preferred_primary_care_network: string;
+  employment_type: string;
+  domestic_worker_type: string;
+  civil_status: string;
+  identification_type: HieIdentificationType;
+  identification_number: string;
+  other_identifications: HieIdentifications[];
+  dependants: HieDependant[];
+  is_alive: number;
+  deceased_datetime: string;
+  phone: string;
+  biometrics_verified: number;
+  biometrics_score: number;
+  email: string;
+  country: string;
+  county: string;
+  sub_county: string;
+  ward: string;
+  village_estate: string;
+  building_house_no: string;
+  latitude: string;
+  longitude: string;
+  province_state_country: string;
+  zip_code: string;
+  identification_residence: string;
+  employer_name: string;
+  employer_pin: string;
+  disability_category: string;
+  disability_subcategory: string;
+  disability_cause: string;
+  in_lawful_custody: string;
+  admission_remand_number: string;
+  document_uploads: any[];
+  alternative_contacts: AlternateContact[];
+  gross_income: number;
+  gross_income_currency: string;
+  postal_address: string;
+  estimated_contribution: number;
+  estimated_annual_contribution: number;
+  city: string;
+  id_serial: string;
+  learning_institution_code: string;
+  learning_institution_name: string;
+  grade_level: string;
+  admission_number: string;
+  expected_year_of_graduation: string;
+  unconfirmed_dependants: HieDependant[];
+  is_agent: number;
+  agent_id: string;
+}
+
+export type PatientSearchResponse = {
+  results: Patient[];
+  totalCount: number;
+};
+
+export type QueuePriority = {
+  uuid: string;
+  display: string;
+};
+export type QueueStatus = {
+  uuid: string;
+  display: string;
+};
+export type ServiceQueue = {
+  uuid: string;
+  display: string;
+  name: string;
+  description: string;
+  service: {
+    uuid: string;
+    display: string;
+  };
+  allowedPriorities: QueuePriority[];
+  allowedStatuses: QueueStatus[];
+  location: Location;
+};
+
+export type ServiceQueueApiResponse = {
+  results: ServiceQueue[];
+};
+
+export type QueueEntryDto = {
+  visit: {
+    uuid: string;
+  };
+  queueEntry: {
+    status: {
+      uuid: string;
+    };
+    priority: {
+      uuid: string;
+    };
+    queue: {
+      uuid: string;
+    };
+    patient: {
+      uuid: string;
+    };
+    startedAt: string;
+    sortWeight: number;
+  };
+};
+
+export type CreateVisitDto = {
+  visitType: string;
+  location: string;
+  startDatetime: null | string;
+  stopDatetime: null | string;
+  patient: string;
+};
+
+export type EndVisitDto = {
+  stopDatetime: string;
+};
+
+export interface GlobalError {
+  code: string;
+  message: string;
+}
+
+export interface AmrsErrorResponse {
+  message: string;
+  error: {
+    error: {
+      message: string;
+      code: string;
+      globalErrors?: GlobalError[];
+      fieldErrors?: any;
+    };
+  };
+}
+
+export interface CreatePersonDto {
+  gender?: string;
+  birthdate?: string;
+  dead?: boolean;
+  deathDate?: string;
+  names?: {
+    givenName?: string;
+    middleName?: string;
+    familyName?: string;
+  }[];
+  addresses?: {
+    country?: string;
+    address1?: string;
+    address2?: string;
+    address4?: string;
+    address7?: string;
+    address10?: string;
+    countyDistrict?: string;
+    stateProvince?: string;
+    cityVillage?: string;
+    longitude?: string;
+    latitude?: string;
+  }[];
+  attributes?: {
+    value: string | number;
+    attributeType: string;
+  }[];
+}
+
+export type CreatePatientDto = {
+  person: CreatePersonDto;
+  identifiers?: any;
+};
+
+export type QueueEntryResult = {
+  name: string;
+  queue_entry_id: number;
+  priority_comment: string;
+  wait_time_in_min: number;
+  queue_entry_uuid: string;
+  service_uuid: string;
+  location_id: number;
+  location: string;
+  service: number;
+  queue_id: number;
+  queue_room: string;
+  priority: string;
+  patient_id: number;
+  visit_id: number;
+  patient_uuid: string;
+  family_name: string;
+  given_name: string;
+  middle_name: string;
+  status: string;
+  visit_uuid: string;
+  queue_coming_from: string;
+};

package/src/registry/utils/error-handler.ts

@@ -0,0 +1,37 @@
+import { type AmrsErrorResponse } from '../types';
+
+export function generateErrorMessage(error: any): string[] {
+  const errors: string[] = [];
+  return errors;
+}
+
+export function getErrorMessages(error: AmrsErrorResponse) {
+  const errors = [];
+  if (error && error.error) {
+    if (error.error.error) {
+      const globalErrors = error.error.error.globalErrors || null;
+      if (globalErrors) {
+        for (const err of globalErrors) {
+          errors.push(err.message);
+        }
+      }
+    } else if (error.error) {
+      if (error.error['globalErrors']) {
+        const globalErrors = error.error['globalErrors'] || null;
+        if (globalErrors) {
+          for (const err of globalErrors) {
+            errors.push(err.message);
+          }
+        }
+      } else if (error.error['message']) {
+        errors.push(error.error['message']);
+      }
+    } else {
+      errors.push(
+        error.error.error.message ||
+          'An error occurred while creating the patient. Please try again or contact support',
+      );
+    }
+  }
+  return errors;
+}

package/src/registry/utils/format-dependant-display-data.ts

@@ -0,0 +1,8 @@
+import { type HieClient } from '../types';
+import { maskExceptFirstAndLast } from './mask-data';
+
+export function formatDependantDisplayData(dependant: HieClient, relationship: string): string {
+  const stringData = `${dependant.first_name} ${maskExceptFirstAndLast(dependant.middle_name)} (${dependant.gender}) (DOB: ${dependant.date_of_birth}) (${relationship}) (CR: ${dependant.id})`;
+
+  return stringData;
+}

package/src/registry/utils/hie-adapter.ts

@@ -0,0 +1,56 @@
+import { type HieIdentifications, type HieClient } from '../types';
+
+const clientDatailsFields = [
+  'id',
+  'other_identifications',
+  'first_name',
+  'middle_name',
+  'last_name',
+  'gender',
+  'date_of_birth',
+  'is_alive',
+  'deceased_datetime',
+  'phone',
+  'email',
+  'civil_status',
+  'place_of_birth',
+  'citizenship',
+  'country',
+  'county',
+  'sub_county',
+  'ward',
+  'village_estate',
+  'longitude',
+  'latitude',
+  'identification_type',
+];
+
+export function generateHieClientDetails(hieClient: HieClient) {
+  let data = {};
+  Object.keys(hieClient)
+    .filter((key) => {
+      return clientDatailsFields.includes(key);
+    })
+    .forEach((key) => {
+      if (key === 'other_identifications') {
+        const otherIds = generateOtherIdentifications(hieClient[key]);
+        data = {
+          ...data,
+          ...otherIds,
+        };
+      } else if (key === 'identification_type') {
+        data[hieClient['identification_type']] = hieClient.identification_number;
+      } else {
+        const value = hieClient[key];
+        data[key] = value;
+      }
+    });
+  return data;
+}
+function generateOtherIdentifications(hieIdentifications: HieIdentifications[]) {
+  const other = {};
+  hieIdentifications.forEach((id) => {
+    other[id.identification_type] = id.identification_number;
+  });
+  return other;
+}

package/src/registry/utils/hie-client-adapter.ts

@@ -0,0 +1,309 @@
+import { IdentifierTypesUuids } from '../../resources/identifier-types';
+import { CivilStatusUids } from '../../shared/constants/civil-status';
+import { PersonAttributeTypeUuids } from '../../shared/constants/person-attributes';
+import {
+  type AlternateContact,
+  type CreatePersonDto,
+  type HieClient,
+  type HieIdentifications,
+  HieIdentificationType,
+} from '../types';
+
+const clientDatailsFields = [
+  'id',
+  'other_identifications',
+  'first_name',
+  'middle_name',
+  'last_name',
+  'gender',
+  'date_of_birth',
+  'is_alive',
+  'deceased_datetime',
+  'phone',
+  'email',
+  'civil_status',
+  'place_of_birth',
+  'citizenship',
+  'country',
+  'county',
+  'sub_county',
+  'ward',
+  'village_estate',
+  'longitude',
+  'latitude',
+  'identification_type',
+];
+
+const nameFields = ['first_name', 'middle_name', 'last_name'];
+const otherPersonFields = ['gender', 'date_of_birth', 'is_alive', 'deceased_datetime'];
+const attributeFields = ['phone', 'email', 'civil_status', 'place_of_birth', 'citizenship'];
+const addressFields = ['country', 'county', 'sub_county', 'ward', 'village_estate', 'longitude', 'latitude'];
+const otherFields = ['gender', 'date_of_birth'];
+const identifierFields = [
+  HieIdentificationType.Cr,
+  HieIdentificationType.SHANumber,
+  HieIdentificationType.HouseholdNumber,
+  HieIdentificationType.RefugeeID,
+  HieIdentificationType.MandateNumber,
+  HieIdentificationType.AlienID,
+  HieIdentificationType.NationalID,
+  HieIdentificationType.TemporaryDependantID,
+];
+const hieAmrsSyncFields = [
+  ...identifierFields,
+  ...nameFields,
+  ...otherPersonFields,
+  ...attributeFields,
+  ...addressFields,
+];
+
+export function generateHieClientDetails(hieClient: HieClient) {
+  let data = {};
+  Object.keys(hieClient)
+    .filter((key) => {
+      return clientDatailsFields.includes(key);
+    })
+    .forEach((key) => {
+      if (key === 'other_identifications') {
+        const otherIds = generateOtherIdentifications(hieClient[key]);
+        data = {
+          ...data,
+          ...otherIds,
+        };
+      } else if (key === 'identification_type') {
+        data[hieClient['identification_type']] = hieClient.identification_number;
+      } else {
+        const value = hieClient[key];
+        data[key] = value;
+      }
+    });
+  return data;
+}
+function generateOtherIdentifications(hieIdentifications: HieIdentifications[]) {
+  const other = {};
+  hieIdentifications.forEach((id) => {
+    other[id.identification_type] = id.identification_number;
+  });
+  return other;
+}
+
+export function generateAmrsPersonPayload(hieClient: HieClient): CreatePersonDto {
+  const createPersonPayload: CreatePersonDto = {};
+  const namesAttribute = {};
+  const addresses = {};
+  let attributes = [];
+  hieAmrsSyncFields.forEach((d) => {
+    if (d === 'first_name') {
+      namesAttribute['givenName'] = hieClient.first_name;
+    }
+    if (d === 'middle_name') {
+      namesAttribute['middleName'] = hieClient.middle_name;
+    }
+    if (d === 'last_name') {
+      namesAttribute['familyName'] = hieClient.last_name;
+    }
+    if (d === 'gender') {
+      createPersonPayload['gender'] = hieClient.gender === 'Male' ? 'M' : 'F';
+    }
+    if (d === 'date_of_birth') {
+      createPersonPayload['birthdate'] = hieClient.date_of_birth;
+      createPersonPayload['birthdateEstimated'] = false;
+    }
+    if (d === 'is_alive') {
+      createPersonPayload['dead'] = hieClient.is_alive === 0 ? true : false;
+    }
+    if (d === 'deceased_datetime') {
+      if (hieClient.deceased_datetime.length > 0) {
+        createPersonPayload['deathDate'] = hieClient.deceased_datetime;
+      }
+    }
+    if (d === 'country' && hieClient.country.length > 0) {
+      addresses['country'] = hieClient.country;
+      addresses['address1'] = hieClient.country;
+    }
+    if (d === 'place_of_birth' && hieClient.place_of_birth.length > 0) {
+      addresses['address10'] = hieClient.place_of_birth;
+    }
+    if (d === 'county' && hieClient.county.length > 0) {
+      addresses['countyDistrict'] = hieClient.county;
+    }
+    if (d === 'sub_county' && hieClient.sub_county.length > 0) {
+      addresses['address2'] = hieClient.sub_county;
+      addresses['stateProvince'] = hieClient.sub_county;
+    }
+    if (d === 'ward' && hieClient.sub_county.length > 0) {
+      addresses['address7'] = hieClient.sub_county;
+      addresses['address4'] = hieClient.sub_county;
+    }
+    if (d === 'village_estate' && hieClient.village_estate.length > 0) {
+      addresses['cityVillage'] = hieClient.village_estate;
+    }
+    if (d === 'longitude' && hieClient.longitude.length > 0) {
+      addresses['longitude'] = hieClient.longitude;
+    }
+    if (d === 'latitude' && hieClient.latitude.length > 0) {
+      addresses['latitude'] = hieClient.latitude;
+    }
+    if (d === 'place_of_birth' && hieClient.place_of_birth.length > 0) {
+      attributes.push({
+        value: hieClient.place_of_birth,
+        attributeType: PersonAttributeTypeUuids.PLACE_OF_BIRTH_UUID,
+      });
+    }
+    if (d === 'phone' && hieClient.phone.length > 0) {
+      attributes.push({
+        value: hieClient.phone,
+        attributeType: PersonAttributeTypeUuids.CONTACT_PHONE_NUMBER_UUID,
+      });
+    }
+    if (d === 'email' && hieClient.email.length > 0) {
+      attributes.push({
+        value: hieClient.email,
+        attributeType: PersonAttributeTypeUuids.CONTACT_EMAIL_ADDRESS_UUID,
+      });
+    }
+    if (d === 'civil_status' && hieClient.civil_status.length > 0) {
+      attributes.push({
+        value: getAmrsConceptUuidFromField(hieClient.civil_status),
+        attributeType: PersonAttributeTypeUuids.CIVIL_STATUS_UUID,
+      });
+    }
+    if (d === 'id' && hieClient.id) {
+      attributes.push({
+        value: hieClient.id,
+        attributeType: PersonAttributeTypeUuids.CLIENT_REGISTRY_ID_UUID,
+      });
+    }
+    if (d === 'citizenship' && hieClient.citizenship) {
+      attributes.push({
+        value: hieClient.citizenship,
+        attributeType: PersonAttributeTypeUuids.CITIZENSHIP_UUID,
+      });
+    }
+  });
+  // Add next of kin details
+  const nextOfKinAndAlternativeAttributes = generateNextOfKinAndAlternateContactDetails(hieClient.alternative_contacts);
+  attributes = [...attributes, ...nextOfKinAndAlternativeAttributes];
+  if (Object.keys(namesAttribute).length > 0) {
+    createPersonPayload['names'] = [namesAttribute];
+  }
+  if (Object.keys(addresses).length > 0) {
+    createPersonPayload['addresses'] = [addresses];
+  }
+  if (attributes.length > 0) {
+    createPersonPayload['attributes'] = attributes;
+  }
+  return createPersonPayload;
+}
+function generateNextOfKinAndAlternateContactDetails(alternativeContacts: AlternateContact[]) {
+  const attributes = [];
+  const alterNativeClientContact = alternativeContacts.find((a) => {
+    return a.relationship === 'Alternative Phone Number';
+  });
+  const nextOfKinContact = alternativeContacts.find((a) => {
+    return a.remarks === 'Next Of Kin';
+  });
+  if (alterNativeClientContact) {
+    if (alterNativeClientContact.contact_type === 'Phone') {
+      attributes.push({
+        value: alterNativeClientContact.contact_id,
+        attributeType: PersonAttributeTypeUuids.ALTERNATIVE_CONTACT_PHONE_NUMBER_UUID,
+      });
+    }
+  }
+  if (nextOfKinContact) {
+    if (nextOfKinContact.contact_type === 'Phone') {
+      attributes.push({
+        value: nextOfKinContact.contact_id,
+        attributeType: PersonAttributeTypeUuids.NEXT_OF_KIN_CONTACT_PHONE_NUMBER_UUID,
+      });
+    }
+    attributes.push({
+      value: nextOfKinContact.relationship,
+      attributeType: PersonAttributeTypeUuids.NEXT_OF_KIN_RELATIONSHIP_UUID,
+    });
+    attributes.push({
+      value: nextOfKinContact.contact_name,
+      attributeType: PersonAttributeTypeUuids.NEXT_OF_KIN_NAME_UUID,
+    });
+  }
+  return attributes;
+}
+function getAmrsConceptUuidFromField(fieldName: string): string {
+  let conceptUuid = '';
+  switch (fieldName) {
+    case 'Divorced':
+      conceptUuid = CivilStatusUids.DIVORCED_UUID;
+      break;
+    case 'Married':
+      conceptUuid = CivilStatusUids.MARRIED_UUID;
+      break;
+    case 'Single':
+      conceptUuid = CivilStatusUids.SINGLE_UUID;
+      break;
+    default:
+      conceptUuid = CivilStatusUids.NOT_APPLICABLE_UUID;
+  }
+  return conceptUuid;
+}
+export function generateAmrsCreatePatientIdentifiersPayload(hieClient: HieClient, identifierLocation: string) {
+  const identifiers = [];
+  // add CR number
+  identifiers.push({
+    identifierType: getAmrsIdentifierTypeUuid(HieIdentificationType.Cr),
+    identifier: hieClient.id,
+    location: identifierLocation,
+  });
+
+  // add main identifier
+  identifiers.push({
+    identifierType: getAmrsIdentifierTypeUuid(hieClient.identification_type),
+    identifier: hieClient.identification_number,
+    location: identifierLocation,
+  });
+
+  // add other idenfications
+  hieClient.other_identifications.forEach((id) => {
+    identifiers.push({
+      identifierType: getAmrsIdentifierTypeUuid(id.identification_type),
+      identifier: id.identification_number,
+      location: identifierLocation,
+    });
+  });
+
+  return identifiers;
+}
+
+export function getAmrsIdentifierTypeUuid(hieIdentifierName: string) {
+  let idTypeUuid;
+  switch (hieIdentifierName) {
+    case HieIdentificationType.NationalID:
+      idTypeUuid = IdentifierTypesUuids.NATIONAL_ID_UUID;
+      break;
+    case HieIdentificationType.HouseholdNumber:
+      idTypeUuid = IdentifierTypesUuids.HOUSE_HOLD_NUMBER_UUID;
+      break;
+    case HieIdentificationType.AlienID:
+      idTypeUuid = IdentifierTypesUuids.ALIEN_ID_UUID;
+      break;
+    case HieIdentificationType.SHANumber:
+      idTypeUuid = IdentifierTypesUuids.SHA_UUID;
+      break;
+    case HieIdentificationType.MandateNumber:
+      idTypeUuid = IdentifierTypesUuids.MANDATE_NUMBER_UUID;
+      break;
+    case HieIdentificationType.RefugeeID:
+      idTypeUuid = IdentifierTypesUuids.REFUGEE_ID_UUID;
+      break;
+    case HieIdentificationType.Cr:
+      idTypeUuid = IdentifierTypesUuids.CLIENT_REGISTRY_NO_UUID;
+      break;
+    case HieIdentificationType.BirthCertificate:
+      idTypeUuid = IdentifierTypesUuids.BIRTH_CERTIFICATE_NUMBER_UUID;
+      break;
+    case HieIdentificationType.TemporaryDependantID:
+      idTypeUuid = IdentifierTypesUuids.TEMPORARY_DEPENDANT_ID_UUID;
+      break;
+  }
+  return idTypeUuid;
+}