org.openmrs

Class FreeTextDosingInstructions

java.lang.Object

org.openmrs.FreeTextDosingInstructions

All Implemented Interfaces:

DosingInstructions

public class FreeTextDosingInstructions
extends java.lang.Object
implements DosingInstructions

Since:

1.10

Constructor Summary

Constructors

Constructor and Description
FreeTextDosingInstructions()

Method Summary

Modifier and Type	Method and Description
java.util.Date	getAutoExpireDate(DrugOrder order) Implementations of this interface may be able to infer the auto-expiration date from other fields on the DrugOrder.
DosingInstructions	getDosingInstructions(DrugOrder order) Get dosing instructions from order
java.lang.String	getDosingInstructionsAsString(java.util.Locale locale) Get human-readable version of dosing instructions for a particular locale All dosing instructions can be localized, so the result, especially any free text may remain in the original language.
java.lang.String	getInstructions()
void	setDosingInstructions(DrugOrder order) Serialize dosing instructions into order
void	setInstructions(java.lang.String instructions)
void	validate(DrugOrder order, org.springframework.validation.Errors errors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreeTextDosingInstructions

public FreeTextDosingInstructions()

Method Detail

getDosingInstructionsAsString

public java.lang.String getDosingInstructionsAsString(java.util.Locale locale)

Description copied from interface: DosingInstructions

Get human-readable version of dosing instructions for a particular locale All dosing instructions can be localized, so the result, especially any free text may remain in the original language. In general, it's expect that most implementations will write orders in a single language and then want to translate instructions to the patient's preferred language when printing orders for the patient. In all other cases, it will want to call this method with the user's locale (i.e., context.getLocale()).

Specified by:

getDosingInstructionsAsString in interface DosingInstructions

Returns:

localized drug instructions string

See Also:

DosingInstructions.getDosingInstructions(DrugOrder)

setDosingInstructions

public void setDosingInstructions(DrugOrder order)

Description copied from interface: DosingInstructions

Serialize dosing instructions into order

Specified by:

setDosingInstructions in interface DosingInstructions

Parameters:

order - DrugOrder to set dosing instructions

See Also:

DosingInstructions.setDosingInstructions(DrugOrder)

getDosingInstructions

public DosingInstructions getDosingInstructions(DrugOrder order)
                                         throws APIException

Description copied from interface: DosingInstructions

Get dosing instructions from order

Specified by:

getDosingInstructions in interface DosingInstructions

Parameters:

order - DrugOrder to get dosing instructions

Returns:

DosingInstructions created from DrugOrder

Throws:

APIException

See Also:

DosingInstructions.getDosingInstructions(DrugOrder)

validate

public void validate(DrugOrder order,
                     org.springframework.validation.Errors errors)

Specified by:

validate in interface DosingInstructions

getAutoExpireDate

public java.util.Date getAutoExpireDate(DrugOrder order)

Description copied from interface: DosingInstructions

Implementations of this interface may be able to infer the auto-expiration date from other fields on the DrugOrder. If the expiration date cannot be determined, then this method may return null (i.e., null means duration of order is unknown). In general, if a drug order has non-zero refills, the auto-expiration date should not be set (even if it has a known duration).

Specified by:

getAutoExpireDate in interface DosingInstructions

getInstructions

public java.lang.String getInstructions()

setInstructions

public void setInstructions(java.lang.String instructions)