@openmrs/esm-appointments-app

Appointments front-end module for OpenMRS 3.x (O3).

Installation

npm install @openmrs/esm-appointments-app

Usage

This module can be consumed by other OpenMRS 3.x applications in several ways:

1. As a Module Federation Remote

// In your app's webpack config
const ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');

module.exports = {
  plugins: [
    new ModuleFederationPlugin({
      remotes: {
        '@openmrs/esm-appointments-app': 'appointments@http://localhost:8080/remoteEntry.js',
      },
    }),
  ],
};

2. Importing Specific Components

// Import the main appointments dashboard
import { appointmentsDashboard } from '@openmrs/esm-appointments-app/appointments-dashboard';

// Import the appointments form workspace
import { appointmentsFormWorkspace } from '@openmrs/esm-appointments-app/appointments-form-workspace';

// Import patient appointments components
import { patientAppointmentsOverview } from '@openmrs/esm-appointments-app/patient-appointments-overview';

3. Using the Root Component

import { root } from '@openmrs/esm-appointments-app/root';

4. Available Exports

The module exports the following components and functions:

• root - Main root component
• appointmentsDashboard - Appointments dashboard component
• homeAppointments - Home appointments component
• appointmentsList - Appointments list component
• earlyAppointments - Early appointments component
• metricsCardScheduledAppointments - Scheduled appointments metrics card
• metricsCardHighestVolumeService - Highest volume service metrics card
• metricsCardProvidersBooked - Providers booked metrics card
• searchPatient - Patient search component
• patientAppointmentsOverview - Patient appointments overview
• patientUpcomingAppointmentsWidget - Patient upcoming appointments widget
• cancelAppointmentModal - Cancel appointment modal
• appointmentsFormWorkspace - Appointments form workspace
• endAppointmentModal - End appointment modal
• homeAppointmentsTile - Home appointments tile

Configuration

The module supports various configuration options through the OpenMRS configuration system:

// Example configuration
{
  "@openmrs/esm-appointments-app": {
    "allowAllDayAppointments": true,
    "appointmentStatuses": ["Requested", "Scheduled", "CheckedIn", "Completed", "Cancelled", "Missed"],
    "appointmentTypes": ["Scheduled"],
    "checkInButton": {
      "enabled": true,
      "showIfActiveVisit": false
    }
  }
}

Development

Build

# Production build
npm run build

# Development build
npm run build:dev

# Clean build
npm run build:clean

# Build with analysis
npm run build:analyze

Development Server

npm start

Dependencies

Peer Dependencies

• @openmrs/esm-framework: 6.x
• @openmrs/esm-patient-common-lib: 10.x
• react: 18.x
• react-dom: 18.x
• react-i18next: 11.x
• react-router-dom: 6.x
• swr: 2.x

Dependencies

• @carbon/react: ^1.83.0
• @hookform/resolvers: ^3.9.1
• classnames: ^2.3.2
• formik: ^2.2.9
• lodash-es: ^4.17.15
• react-hook-form: ^7.54.0
• xlsx: ^0.18.5
• yup: ^0.32.11
• zod: ^3.24.1

License

MPL-2.0