Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

The Appointment Scheduling feature will be available from release 0.90. This page is currently work in progress.


Creating a service:

For creating a new Service, only ‘Service Name’ is mandatory.

  1. Service Name: It is mandatory and should unique. You will be notified with message if a service with the same name(case insensitive) already exists. 



  2. Description: You can add description to the service.
  3. Duration of service: It is the consultation time required to offer the service to a patient. It is in minutes. Negative values are not allowed. 
  4. Start Time & End time: The working hours for a service. Service is available on all days of the week, if no availability is defined. Start time must be less than end time. If it is wrong time sequence, you will be notified with a message



  5. Max Load: This indicates the maximum number of appointments that can be booked for a service. Negative values are not allowed 
  6. Speciality: This field is configurable. By default it is shown. you can show/hide this by setting “enableSpecialities” to true/false.

    "enableSpecialities": true

    To add a speciality we can run the following query.

    INSERT INTO appointment_speciality (name, date_created, creator, uuid) VALUES ('Cardiology', NOW(), 1, UUID());
  7. Location:  All locations tagged with ‘Appointment Location’ appears in this dropdown.
    To tag a location as Appointment Location: In openmrs,
    Administration -> ManageLocations -> Select a location -> Check ‘Appointment Location’ -> Save location.



  8. Label Colour:
  9. Service Types: 
  10. Service availability: If you define a service availability it overrides the service level startTime, endTime and MaxLoad and service is only available on selected days within mentioned timings.
    Start Time & End time: working hours for a service on selected days of that availability.Start time must be less than end time. If it is wrong time sequence, you will be notified with a message.
    Max Load: This indicates the maximum number of appointments that can be booked for a service availability. Negative values are not allowed. 
    Days: By default week starts from MONDAY. You can configure the start day of week by assigning a number ranging from [1-7] which indicates [SUNDAY-SATURDAY] to“startOfWeek” in config file.
    Ex: If you configure,

    "startOfWeek": 4

    Display names of the days in a week are internationalized. 

    "SUNDAY": "Su",
    "MONDAY": "Mo",
    "TUESDAY": "Tu",
    "WEDNESDAY": "We",
    "THURSDAY": "Th",
    "FRIDAY": "Fr",
    "SATURDAY": "Sa"


    Add a new availability:
    For adding a new availability Start time, End time and at least one day must be selected to get the ‘Add’ button enabled. After it got added, it will be in non-editable mode. You can see two buttons to edit and delete.



    To delete an availability:

    Click on delete button, it will ask for confirmation. If you click on ok, that particular availability will be deleted. If you hit cancel, it will stay as is.
    To edit an availability:
    Click on edit button, which enables that availability to make changes.

    Multiple availabilities can be tied to one service. All the availabilities are displayed in order they got added. 


When you try to navigate with unsaved changes, a dialog box will be shown to confirm or cancel the navigation.

If you click on Don't save , you will be navigated to the target page and all changes will be lost. If you click on Stay on page, all changes persist and you will be on the same page. 

  • No labels