org.openmrs

Class DrugOrder

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.BaseCustomizableData<OrderAttribute>

org.openmrs.Order

org.openmrs.DrugOrder

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<OrderAttribute>, FormRecordable, OpenmrsData, OpenmrsObject, Voidable

public class DrugOrder
extends Order

DrugOrder

Version:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openmrs.Order

Order.Action, Order.FulfillerStatus, Order.Urgency

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
DrugOrder() default constructor
DrugOrder(Integer orderId) constructor with id

Method Summary

Modifier and Type	Method and Description
DrugOrder	cloneForDiscontinuing() Creates a discontinuation order for this order, sets the previousOrder and action fields, note that the discontinuation order needs to be saved for the discontinuation to take effect
DrugOrder	cloneForRevision() Creates a DrugOrder for revision from this order, sets the previousOrder, action field and other drug order fields.
protected DrugOrder	cloneForRevisionHelper(DrugOrder target)
DrugOrder	copy() Performs a shallow copy of this Order.
protected DrugOrder	copyHelper(DrugOrder target)
Boolean	getAsNeeded() Returns true/false whether the drug is a "pro re nata" drug
String	getAsNeededCondition()
String	getBrandName() Gets the brandName
Boolean	getDispenseAsWritten()
Double	getDose()
Concept	getDoseUnits() Gets the doseUnits of this drug order
String	getDosingInstructions() Gets the dosingInstructions
DosingInstructions	getDosingInstructionsInstance() Gets the dosingInstructions instance
Class<? extends DosingInstructions>	getDosingType() Gets the dosingType
Drug	getDrug() Gets the drug
String	getDrugNonCoded()
Integer	getDuration() Gets the duration of a Drug Order
Concept	getDurationUnits() Gets durationUnits of a Drug Order
OrderFrequency	getFrequency() Gets the frequency
Integer	getNumRefills() Gets numRefills
Double	getQuantity() Gets the quantity
Concept	getQuantityUnits()
Concept	getRoute() Gets the route
boolean	hasSameOrderableAs(Order otherOrder) Checks whether orderable of this drug order is same as other order
boolean	isDrugOrder()
boolean	isNonCodedDrug()
void	setAsNeeded(Boolean asNeeded)
void	setAsNeededCondition(String asNeededCondition)
void	setAutoExpireDateBasedOnDuration() Sets autoExpireDate based on duration.
void	setBrandName(String brandName) Sets the brandName
void	setDispenseAsWritten(Boolean dispenseAsWritten)
void	setDose(Double dose)
void	setDoseUnits(Concept doseUnits) Sets the doseUnits of this drug order
void	setDosing(DosingInstructions di) Set dosing instructions to drug order
void	setDosingInstructions(String dosingInstructions) Sets the dosingInstructions
void	setDosingType(Class<? extends DosingInstructions> dosingType) Sets the dosingType
void	setDrug(Drug drug) Sets the drug
void	setDrugNonCoded(String drugNonCoded)
void	setDuration(Integer duration) Sets the duration of a Drug Order
void	setDurationUnits(Concept durationUnits) Sets the durationUnits of a Drug Order
void	setFrequency(OrderFrequency frequency) Sets the frequency
void	setNumRefills(Integer numRefills) Sets numRefills
void	setQuantity(Double quantity) Sets the quantity
void	setQuantityUnits(Concept quantityUnits)
void	setRoute(Concept route) Sets the route
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.Order

cloneForRevisionHelper, copyHelper, getAccessionNumber, getAction, getAutoExpireDate, getCareSetting, getCommentToFulfiller, getConcept, getDateActivated, getDateStopped, getEffectiveStartDate, getEffectiveStopDate, getEncounter, getFormFieldNamespace, getFormFieldPath, getFormNamespaceAndPath, getFulfillerComment, getFulfillerStatus, getId, getInstructions, getOrderer, getOrderGroup, getOrderId, getOrderNumber, getOrderReason, getOrderReasonNonCoded, getOrderType, getPatient, getPreviousOrder, getScheduledDate, getSortWeight, getUrgency, isActivated, isActivated, isActive, isActive, isDiscontinued, isDiscontinuedRightNow, isExpired, isExpired, isStarted, isStarted, isType, setAccessionNumber, setAction, setAutoExpireDate, setCareSetting, setCommentToFulfiller, setConcept, setDateActivated, setEncounter, setFormField, setFormNamespaceAndPath, setFulfillerComment, setFulfillerStatus, setId, setInstructions, setOrderer, setOrderGroup, setOrderId, setOrderReason, setOrderReasonNonCoded, setOrderType, setPatient, setPreviousOrder, setScheduledDate, setSortWeight, setUrgency

Methods inherited from class org.openmrs.BaseCustomizableData

addAttribute, getActiveAttributes, getActiveAttributes, getAttributes, setAttribute, setAttributes

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DrugOrder

public DrugOrder()

default constructor

DrugOrder

public DrugOrder(Integer orderId)

constructor with id

Method Detail

copy

public DrugOrder copy()

Description copied from class: Order

Performs a shallow copy of this Order. Does NOT copy orderId.

Overrides:

copy in class Order

Returns:

a shallow copy of this Order Should copy all fields

See Also:

Should copy all drug order fields

copyHelper

protected DrugOrder copyHelper(DrugOrder target)

See Also:

Order.copyHelper(Order)

isDrugOrder

public boolean isDrugOrder()

getDoseUnits

public Concept getDoseUnits()

Gets the doseUnits of this drug order

Returns:

doseUnits

setDoseUnits

public void setDoseUnits(Concept doseUnits)

Sets the doseUnits of this drug order

Parameters:

doseUnits -

getFrequency

public OrderFrequency getFrequency()

Gets the frequency

Returns:

frequency

Since:

1.10 (signature changed)

setFrequency

public void setFrequency(OrderFrequency frequency)

Sets the frequency

Parameters:

frequency -

Since:

1.10 (signature changed)

getAsNeeded

public Boolean getAsNeeded()

Returns true/false whether the drug is a "pro re nata" drug

Returns:

Boolean

Since:

1.10

setAsNeeded

public void setAsNeeded(Boolean asNeeded)

Parameters:

asNeeded - the value to set

Since:

1.10

getQuantity

public Double getQuantity()

Gets the quantity

Returns:

quantity

setQuantity

public void setQuantity(Double quantity)

Sets the quantity

Parameters:

quantity -

getQuantityUnits

public Concept getQuantityUnits()

Returns:

concept

Since:

1.10

setQuantityUnits

public void setQuantityUnits(Concept quantityUnits)

Parameters:

quantityUnits -

Since:

1.10

getDrug

public Drug getDrug()

Gets the drug

Returns:

drug

setDrug

public void setDrug(Drug drug)

Sets the drug

Parameters:

drug -

getAsNeededCondition

public String getAsNeededCondition()

Returns:

the asNeededCondition

Since:

1.10

setAsNeededCondition

public void setAsNeededCondition(String asNeededCondition)

Parameters:

asNeededCondition - the asNeededCondition to set

Since:

1.10

getRoute

public Concept getRoute()

Gets the route

Since:

1.10

setRoute

public void setRoute(Concept route)

Sets the route

Parameters:

route -

Since:

1.10

setDose

public void setDose(Double dose)

getDose

public Double getDose()

getDosingType

public Class<? extends DosingInstructions> getDosingType()

Gets the dosingType

Since:

1.10

setDosingType

public void setDosingType(Class<? extends DosingInstructions> dosingType)

Sets the dosingType

Parameters:

dosingType - the dosingType to set

Since:

1.10

getDosingInstructionsInstance

public DosingInstructions getDosingInstructionsInstance()

Gets the dosingInstructions instance

Since:

1.10

getNumRefills

public Integer getNumRefills()

Gets numRefills

Since:

1.10

setNumRefills

public void setNumRefills(Integer numRefills)

Sets numRefills

Parameters:

numRefills - the numRefills to set

Since:

1.10

setDosingInstructions

public void setDosingInstructions(String dosingInstructions)

Sets the dosingInstructions

Parameters:

dosingInstructions - to set

Since:

1.10

getDosingInstructions

public String getDosingInstructions()

Gets the dosingInstructions

Since:

1.10

getDuration

public Integer getDuration()

Gets the duration of a Drug Order

Since:

1.10

setDuration

public void setDuration(Integer duration)

Sets the duration of a Drug Order

Parameters:

duration - to set

Since:

1.10

getDurationUnits

public Concept getDurationUnits()

Gets durationUnits of a Drug Order

Since:

1.10

setDurationUnits

public void setDurationUnits(Concept durationUnits)

Sets the durationUnits of a Drug Order

Parameters:

durationUnits -

Since:

1.10

getBrandName

public String getBrandName()

Gets the brandName

Returns:

brandName

Since:

1.10

setBrandName

public void setBrandName(String brandName)

Sets the brandName

Parameters:

brandName - the brandName to set to

Since:

1.10

getDispenseAsWritten

public Boolean getDispenseAsWritten()

Returns:

true or false

Since:

1.10

setDispenseAsWritten

public void setDispenseAsWritten(Boolean dispenseAsWritten)

Parameters:

dispenseAsWritten -

Since:

1.10

cloneForDiscontinuing

public DrugOrder cloneForDiscontinuing()

Description copied from class: Order

Creates a discontinuation order for this order, sets the previousOrder and action fields, note that the discontinuation order needs to be saved for the discontinuation to take effect

Overrides:

cloneForDiscontinuing in class Order

Returns:

the newly created order

Since:

1.10

See Also:

Should set all the relevant fields

cloneForRevision

public DrugOrder cloneForRevision()

Creates a DrugOrder for revision from this order, sets the previousOrder, action field and other drug order fields.

Overrides:

cloneForRevision in class Order

Returns:

the newly created order

Since:

1.10 Should set all the relevant fields Should set the relevant fields for a DC order

cloneForRevisionHelper

protected DrugOrder cloneForRevisionHelper(DrugOrder target)

See Also:

Order.cloneForRevisionHelper(Order)

setAutoExpireDateBasedOnDuration

public void setAutoExpireDateBasedOnDuration()

Sets autoExpireDate based on duration. Should delegate calculation to dosingInstructions Should not calculate for discontinue action Should not calculate if autoExpireDate already set

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class Order

See Also:

Object.toString()

setDosing

public void setDosing(DosingInstructions di)

Set dosing instructions to drug order

Parameters:

di - dosing instruction object to fetch data

Since:

1.10

hasSameOrderableAs

public boolean hasSameOrderableAs(Order otherOrder)

Checks whether orderable of this drug order is same as other order

Overrides:

hasSameOrderableAs in class Order

Parameters:

otherOrder - the other order to match on

Returns:

true if the drugs match Should return false if the other order is null Should return false if the other order is not a drug order Should return false if both drugs are null and the concepts are different Should return false if the concepts match and only this has a drug Should return false if the concepts match and only the other has a drug Should return false if the concepts match and drugs are different and not null Should return true if both drugs are null and the concepts match Should return true if the drugs match

Since:

1.10

See Also:

for overridden behaviour

getDrugNonCoded

public String getDrugNonCoded()

Returns:

drugNonCoded

Since:

1.12

setDrugNonCoded

public void setDrugNonCoded(String drugNonCoded)

Since:

1.12 sets drugNonCoded

isNonCodedDrug

public boolean isNonCodedDrug()

Since:

1.12 return true if a drug is non coded