@digihmis/esm-patient-registration-app 1.0.0

package/src/config-schema.ts

@@ -0,0 +1,511 @@
+import { ConfigSchema, Type, validator, validators } from '@openmrs/esm-framework';
+
+export interface FieldDefinition {
+  id: string;
+  type: string;
+  uuid?: string;
+  label: string;
+  validation: {
+    required: boolean;
+  };
+  customConceptAnswers?: Array<{
+    uuid: string;
+    label: string;
+  }>;
+}
+
+export const configSchema: ConfigSchema = {
+  registrationIcon: {
+    src: {
+      _type: Type.String,
+      _default: '/openmrs/spa/search.svg',
+      _description:
+        'The path or URL to the logo image. If set to an empty string, the default OpenMRS SVG sprite will be used.',
+      _validators: [validators.isUrl],
+    },
+  },
+  OpenmrsIdentifierTypeUuid: {
+    _type: Type.String,
+    _default: 'dfacd928-0370-4315-99d7-6ec1c9f7ae76',
+    _description: 'The UUID of the OpenMRS Identifier Type to be used as the main patient identifier.',
+  },
+  fieldConfigurations: {
+    _type: Type.Object,
+    _default: {},
+    _description: 'Configuration for various field settings',
+    causeOfDeath: {
+      _type: Type.Object,
+      _default: {
+        conceptUuid: '',
+        required: false,
+      },
+      _description: 'Configuration for cause of death field',
+      conceptUuid: {
+        _type: Type.String,
+        _default: '',
+        _description: 'Concept UUID for cause of death',
+      },
+      required: {
+        _type: Type.Boolean,
+        _default: false,
+        _description: 'Whether cause of death field is required',
+      },
+    },
+    gender: {
+      _type: Type.Array,
+      _default: [
+        {
+          value: 'male',
+          label: '',
+        },
+        {
+          value: 'female',
+          label: '',
+        },
+        {
+          value: 'other',
+          label: '',
+        },
+        {
+          value: 'unknown',
+          label: '',
+        },
+      ],
+      _description:
+        'The options for sex selection during patient registration. This is Administrative Gender as it is called by FHIR.',
+      _elements: {
+        value: {
+          _type: Type.String,
+          _description:
+            'Value that will be sent to the server. Limited to FHIR-supported values for Administrative Gender',
+          _validators: [validators.oneOf(['male', 'female', 'other', 'unknown'])],
+        },
+        label: {
+          _type: Type.String,
+          _default: '',
+          _description: 'The label displayed for the sex option, if it should be different from the value.',
+        },
+      },
+    },
+  },
+  freeTextFieldConceptUuid: {
+    _type: Type.String,
+    _default: '',
+    _description: 'Concept UUID for free text fields',
+  },
+  defaultPatientIdentifierTypes: {
+    _type: Type.Array,
+    _default: [],
+    _description: 'Default patient identifier types',
+    _elements: {
+      _type: Type.String,
+    },
+  },
+  registrationObs: {
+    _type: Type.Object,
+    _default: {
+      encounterTypeUuid: null,
+      encounterProviderRoleUuid: 'a0b03050-c99b-11e0-9572-0800200c9a66',
+      registrationFormUuid: null,
+    },
+    _description: 'Configuration for registration encounter observations',
+    encounterTypeUuid: {
+      _type: Type.String,
+      _default: null,
+      _description: 'UUID of the encounter type for registration observations',
+    },
+    encounterProviderRoleUuid: {
+      _type: Type.UUID,
+      _default: 'a0b03050-c99b-11e0-9572-0800200c9a66',
+      _description: "The provider role to use for the registration encounter. Default is 'Unknown'.",
+    },
+    registrationFormUuid: {
+      _type: Type.String,
+      _default: null,
+      _description: 'UUID of the registration form to use',
+    },
+  },
+  name: {
+    displayMiddleName: { _type: Type.Boolean, _default: true },
+    defaultUnknownGivenName: {
+      _type: Type.String,
+      _default: 'UNKNOWN',
+      _description: 'The given/first name to record for unidentified patients.',
+    },
+    defaultUnknownFamilyName: {
+      _type: Type.String,
+      _default: 'UNKNOWN',
+      _description: 'The family/last name to record for unidentified patients.',
+    },
+    displayCapturePhoto: {
+      _type: Type.Boolean,
+      _default: true,
+      _description: 'Whether to display capture patient photo slot on name field',
+    },
+    displayReverseFieldOrder: {
+      _type: Type.Boolean,
+      _default: false,
+      _description: "Whether to display the name fields in the order 'Family name' -> 'Middle name' -> 'First name'",
+    },
+  },
+  fieldDefinitions: {
+    _type: Type.Array,
+    _default: [
+      {
+        id: 'maritalStatus',
+        type: 'obs',
+        uuid: '1054AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+        label: 'Marital status',
+        validation: {
+          required: false,
+        },
+        customConceptAnswers: [
+          {
+            uuid: '159715AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Married polygamous',
+          },
+          {
+            uuid: '5555AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Married monogamous',
+          },
+          {
+            uuid: '1058AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Divorced',
+          },
+          {
+            uuid: '1059AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Widowed',
+          },
+          {
+            uuid: '1060AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Cohabiting',
+          },
+          {
+            uuid: '1057AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Single',
+          },
+        ],
+      },
+      {
+        id: 'patientVisitType',
+        type: 'obs',
+        uuid: '164181AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+        label: 'Patient Visit Type',
+        validation: {
+          required: false,
+        },
+        customConceptAnswers: [
+          {
+            uuid: '164180AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'New patient',
+          },
+          {
+            uuid: '5555AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+            label: 'Revisit patient',
+          },
+        ],
+      },
+    ],
+    _description: 'Field definitions for form fields',
+    _elements: {
+      id: {
+        _type: Type.String,
+        _description: 'Unique identifier for the field',
+      },
+      type: {
+        _type: Type.String,
+        _description: 'Type of field (obs, person, etc.)',
+      },
+      uuid: {
+        _type: Type.String,
+        _default: '',
+        _description: 'Concept UUID for the field',
+      },
+      label: {
+        _type: Type.String,
+        _description: 'Label for the field',
+      },
+      validation: {
+        _type: Type.Object,
+        _description: 'Validation rules for the field',
+        required: {
+          _type: Type.Boolean,
+          _default: false,
+          _description: 'Whether the field is required',
+        },
+      },
+      customConceptAnswers: {
+        _type: Type.Array,
+        _default: [],
+        _description: 'Custom concept answers for the field',
+        _elements: {
+          uuid: {
+            _type: Type.String,
+            _description: 'Concept UUID for the answer',
+          },
+          label: {
+            _type: Type.String,
+            _description: 'Display label for the answer',
+          },
+        },
+      },
+    },
+  },
+  visitAttributeTypes: {
+    _type: Type.Array,
+    _default: [],
+    _description: 'Visit attribute types configuration',
+    _elements: {
+      displayInThePatientBanner: {
+        _type: Type.Boolean,
+        _default: false,
+        _description: 'Whether to display in the patient banner',
+      },
+      required: {
+        _type: Type.Boolean,
+        _default: false,
+        _description: 'Whether the visit attribute is required',
+      },
+      showWhenExpression: {
+        _type: Type.String,
+        _default: '',
+        _description: 'Expression to determine when to show the attribute',
+      },
+      uuid: {
+        _type: Type.String,
+        _description: 'UUID of the visit attribute type',
+      },
+    },
+  },
+  restrictByVisitLocationTag: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to restrict visits by location tag',
+  },
+  disableChangingVisitLocation: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to disable changing visit location',
+  },
+  showRecommendedVisitTypeTab: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to show recommended visit type tab',
+  },
+  showExtraVisitAttributesSlot: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to show extra visit attributes slot',
+  },
+  visitTypeResourceUrl: {
+    _type: Type.String,
+    _default: '',
+    _description: 'URL for visit type resource',
+  },
+  offlineVisitTypeUuid: {
+    _type: Type.String,
+    _default: '',
+    _description: 'UUID for offline visit type',
+  },
+  showUpcomingAppointments: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to show upcoming appointments',
+  },
+  showVisitLocationField: {
+    _type: Type.Boolean,
+    _default: false,
+    _description: 'Whether to show visit location field during registration',
+  },
+  defaultFacilityUrl: {
+    _type: Type.String,
+    _default: '',
+    _description: 'URL for fetching default facility',
+  },
+  visitQueueNumberAttributeUuid: {
+    _type: Type.String,
+    _default: '',
+    _description: 'UUID for visit queue number attribute',
+  },
+  allowedVisitTypeUuids: {
+    _type: Type.Array,
+    _default: [],
+    _description: 'List of allowed visit type UUIDs. If empty, all visit types are shown.',
+    _elements: {
+      _type: Type.String,
+    },
+  },
+  activeVisits: {
+    identifiers: {
+      _type: Type.Array,
+      _default: [],
+      _description: 'Customizable list of identifiers to display on active visits table',
+      _elements: {
+        header: {
+          key: {
+            _type: Type.String,
+            _default: '',
+            _description: 'Key to be used for translation purposes.',
+          },
+          default: {
+            _type: Type.String,
+            _default: '',
+            _description: 'Default text to be displayed if no translation is found.',
+          },
+        },
+        identifierName: {
+          _type: Type.String,
+          _default: '',
+          _description: 'Name of the desired identifier to filter data returned from the visit resource.',
+        },
+      },
+    },
+    attributes: {
+      _type: Type.Array,
+      _default: [],
+      _description: 'Customizable list of person attributes to display on active visits table',
+      _elements: {
+        display: {
+          _type: Type.String,
+          _description: 'Display name of the attribute type',
+        },
+        header: {
+          key: {
+            _type: Type.String,
+            _default: '',
+            _description: 'Key to be used for translation purposes.',
+          },
+          default: {
+            _type: Type.String,
+            _default: '',
+            _description: 'Default text to be displayed if no translation is found.',
+          },
+        },
+      },
+    },
+    pageSize: {
+      _type: Type.Number,
+      _default: 10,
+      _description: 'Count of active visits to be shown in a single page.',
+      _validators: [validator((v: unknown) => typeof v === 'number' && v > 0, 'Must be greater than zero')],
+    },
+    pageSizes: {
+      _type: Type.Array,
+      _default: [10, 20, 50],
+      _description: 'Customizable page sizes that user can choose',
+      _elements: {
+        _type: Type.Number,
+        _description: 'Number of entries to be displayed on the active visits table.',
+        _validators: [validator((v: unknown) => typeof v === 'number' && v > 0, 'Must be greater than zero')],
+      },
+    },
+    obs: {
+      _type: Type.Array,
+      _default: [],
+      _description: 'Array of observation concept UUIDs to be displayed on the active visits table.',
+      _elements: {
+        _type: Type.UUID,
+        _description: 'UUID of an observation concept.',
+      },
+    },
+  },
+};
+
+export interface Gender {
+  label?: string;
+  value: string;
+}
+
+export interface RegistrationConfig {
+  fieldConfigurations: {
+    causeOfDeath: {
+      conceptUuid: string;
+      required: boolean;
+    };
+    gender: Array<Gender>;
+  };
+  freeTextFieldConceptUuid: string;
+  name: {
+    displayMiddleName: boolean;
+    defaultUnknownGivenName: string;
+    defaultUnknownFamilyName: string;
+    displayCapturePhoto: boolean;
+    displayReverseFieldOrder: boolean;
+  };
+  defaultPatientIdentifierTypes: Array<string>;
+  registrationObs: {
+    encounterTypeUuid: string | null;
+    encounterProviderRoleUuid: string;
+    registrationFormUuid: string | null;
+  };
+  fieldDefinitions: FieldDefinition[];
+  visitAttributeTypes: Array<{
+    displayInThePatientBanner: boolean;
+    required: boolean;
+    showWhenExpression?: string;
+    uuid: string;
+  }>;
+  restrictByVisitLocationTag?: boolean;
+  disableChangingVisitLocation?: boolean;
+  showRecommendedVisitTypeTab?: boolean;
+  showExtraVisitAttributesSlot: boolean;
+  visitTypeResourceUrl?: string;
+  offlineVisitTypeUuid?: string;
+  showUpcomingAppointments: boolean;
+  showVisitLocationField: boolean;
+  defaultFacilityUrl: string;
+  visitQueueNumberAttributeUuid: string;
+  allowedVisitTypeUuids: Array<string>;
+}
+
+export type ConfigObject = {
+  registrationIcon: {
+    src: string;
+  };
+  OpenmrsIdentifierTypeUuid: string;
+};
+
+export interface ChartConfig {
+  visitAttributeTypes: Array<{
+    displayInThePatientBanner: boolean;
+    required: boolean;
+    showWhenExpression?: string;
+    uuid: string;
+  }>;
+  restrictByVisitLocationTag: boolean;
+  disableChangingVisitLocation: boolean;
+  showRecommendedVisitTypeTab: boolean;
+  showExtraVisitAttributesSlot: boolean;
+  visitTypeResourceUrl: string;
+  offlineVisitTypeUuid: string;
+  showUpcomingAppointments: boolean;
+  showVisitLocationField: boolean;
+  defaultFacilityUrl: string;
+  fieldDefinitions: FieldDefinition[];
+}
+
+export interface ActiveVisitsConfigSchema {
+  activeVisits: {
+    pageSize: Number;
+    pageSizes: Array<Number>;
+    identifiers: Array<IdentifiersDefinition>;
+    obs: Array<string>;
+    attributes: Array<AttributeDefinition>;
+  };
+}
+
+export interface IdentifiersDefinition {
+  header: {
+    key: string;
+    default: string;
+  };
+  identifierName: string;
+}
+
+export interface AttributeDefinition {
+  display: string;
+  header: {
+    key: string;
+    default: string;
+  };
+}

package/src/constant.ts

@@ -0,0 +1,6 @@
+import { omrsOfflineCachingStrategyHttpHeaderName, type OmrsOfflineHttpHeaders } from '@openmrs/esm-framework';
+
+export const cacheForOfflineHeaders: OmrsOfflineHttpHeaders = {
+  [omrsOfflineCachingStrategyHttpHeaderName]: 'network-first',
+};
+export const patientRegistration = 'patient-registration';

package/src/constants/index.ts

@@ -0,0 +1 @@
+export const baseSpaPath = `${window.spaBase}/home/registration`;

package/src/dashboard.meta.ts

@@ -0,0 +1,8 @@
+import { SearchLocateMirror } from '@carbon/react/icons';
+
+export const dashboardMeta = {
+  name: '',
+  slot: 'registration-dashboard-slot',
+  title: 'search',
+  icon: SearchLocateMirror,
+};

package/src/declarations.d.ts

@@ -0,0 +1,6 @@
+declare module '@carbon/react';
+declare module '*.css';
+declare module '*.scss';
+declare module '*.png';
+
+declare type SideNavProps = object;