org.openmrs.api.handler

Interface EncounterVisitHandler

All Known Implementing Classes:

BaseEncounterVisitHandler, ExistingOrNewVisitAssignmentHandler, ExistingVisitAssignmentHandler, NoVisitAssignmentHandler

public interface EncounterVisitHandler

This is the contract for different ways to determine if an Encounter should be part of an Active visit. An admin can decide how they want their Encounters automatically assigned to Visits by choosing different handlers.

Since:

1.9

See Also:

EncounterService#getVisitAssignmentHandlers()

Method Summary

Modifier and Type	Method and Description
void	beforeCreateEncounter(Encounter encounter) Implementations of this method should look at the given encounter and choose whether or not it should be assigned to a Visit that is already open or if it should be part of a new visit.
java.lang.String	getDisplayName()
java.lang.String	getDisplayName(java.util.Locale locale)

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns:

a displayable string so that users can pick between different assignment handlers

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)

Parameters:

locale - optional locale to specify. If none is passed, Context.getLocale() should be used

Returns:

a displayable string so that users can pick between different assignment handlers

beforeCreateEncounter

void beforeCreateEncounter(Encounter encounter)

Implementations of this method should look at the given encounter and choose whether or not it should be assigned to a Visit that is already open or if it should be part of a new visit.

The decision of what to do is up to the handler, but it should call Encounter.setVisit(Visit) with the outcome. The visit assigned to the encounter will be persisted to the database after this method is returned, so the handler is not required to save it.

Parameters:

encounter - the new unsaved encounter in question of whether to assign to a visit