Order (OpenMRS 1.10.7-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.Order

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable

Direct Known Subclasses:

DrugOrder, TestOrder
```
public class Order
extends BaseOpenmrsData
implements java.io.Serializable
```
Encapsulates information about the clinical action of a provider requesting something for a patient e.g requesting a test to be performed, prescribing a medication, requesting the patient to enroll on a specific diet etc. There is the notion of effective dates, these are used to determine the span of an order's schedule i.e its effective start and stop dates therefore dates should be interpreted as follows: The effective start of the schedule is the scheduledDate if urgency is set to ON_SCHEDULED_DATE otherwise it is the dateActivated; the effective end date is dateStopped, if it is null then it is the autoExpireDate. For DrugOrders, if the autoExpireDate is not specified then it will be calculated and set by the API based on the duration and frequency, note that frequency is only used in case duration is specified as a recurring interval e.g. 3 times.

Version:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.Action

static class Order.Urgency

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Action`
`static class`	`Order.Urgency`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

Order()
default constructor

Order(java.lang.Integer orderId)
constructor with id

Constructors
Constructor and Description
`Order()` default constructor
`Order(java.lang.Integer orderId)` constructor with id

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Order`	`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
`Order`	`cloneForRevision()` Creates an order for revision from this order, sets the previousOrder and action field.
`protected Order`	`cloneForRevisionHelper(Order target)` The purpose of this method is to allow subclasses of Order to delegate a portion of their cloneForRevision() method back to the superclass, in case the base class implementation changes.
`Order`	`copy()` Performs a shallow copy of this Order.
`protected Order`	`copyHelper(Order target)` The purpose of this method is to allow subclasses of Order to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
`java.lang.String`	`getAccessionNumber()`
`Order.Action`	`getAction()` Gets the action
`java.util.Date`	`getAutoExpireDate()`
`CareSetting`	`getCareSetting()` Gets the careSetting
`java.lang.String`	`getCommentToFulfiller()`
`Concept`	`getConcept()`
`java.util.Date`	`getDateActivated()`
`java.util.Date`	`getDateStopped()`
`java.util.Date`	`getEffectiveStartDate()` A convenience method to return start of the schedule for order.
`java.util.Date`	`getEffectiveStopDate()` A convenience method to return end of the schedule for order.
`Encounter`	`getEncounter()`
`java.lang.Integer`	`getId()`
`java.lang.String`	`getInstructions()`
`Provider`	`getOrderer()`
`java.lang.Integer`	`getOrderId()`
`java.lang.String`	`getOrderNumber()`
`Concept`	`getOrderReason()`
`java.lang.String`	`getOrderReasonNonCoded()`
`OrderType`	`getOrderType()` Get the `OrderType`
`Patient`	`getPatient()`
`Order`	`getPreviousOrder()` Gets the previous related order.
`java.util.Date`	`getScheduledDate()`
`Order.Urgency`	`getUrgency()`
`boolean`	`hasSameOrderableAs(Order otherOrder)` Checks whether orderable of this order is same as other order
`boolean`	`isActive()` Convenience method to determine if the order was active as of the current date
`boolean`	`isActive(java.util.Date checkDate)` Convenience method to determine if the order is active as of the specified date
`boolean`	`isCurrent()` Deprecated.
`boolean`	`isCurrent(java.util.Date checkDate)` Deprecated.
`boolean`	`isDiscontinued(java.util.Date checkDate)` Convenience method to determine if the order is discontinued as of the specified date
`boolean`	`isDiscontinuedRightNow()`
`boolean`	`isExpired()` Convenience method to determine if the order is expired as of the specified date
`boolean`	`isExpired(java.util.Date checkDate)` Convenience method to determine if order was expired at a given time
`boolean`	`isFuture()` Deprecated. use isStarted()
`boolean`	`isFuture(java.util.Date checkDate)` Deprecated. use isStarted(java.util.Date)
`boolean`	`isStarted()` Convenience method to determine if order is started as of the current date
`boolean`	`isStarted(java.util.Date checkDate)` Convenience method to determine if the order is started as of the specified date, returns true only if the order has been activated.
`boolean`	`isType(OrderType orderType)` Checks whether this order's orderType matches or is a sub type of the specified one
`void`	`setAccessionNumber(java.lang.String accessionNumber)`
`void`	`setAction(Order.Action action)` Sets the ation
`void`	`setAutoExpireDate(java.util.Date autoExpireDate)`
`void`	`setCareSetting(CareSetting careSetting)` Sets the careSetting
`void`	`setCommentToFulfiller(java.lang.String commentToFulfiller)`
`void`	`setConcept(Concept concept)`
`void`	`setDateActivated(java.util.Date dateActivated)`
`void`	`setEncounter(Encounter encounter)`
`void`	`setId(java.lang.Integer id)`
`void`	`setInstructions(java.lang.String instructions)`
`void`	`setOrderer(Provider orderer)`
`void`	`setOrderId(java.lang.Integer orderId)`
`void`	`setOrderReason(Concept orderReason)`
`void`	`setOrderReasonNonCoded(java.lang.String orderReasonNonCoded)`
`void`	`setOrderType(OrderType orderType)` Set the `OrderType`
`void`	`setPatient(Patient patient)`
`void`	`setPreviousOrder(Order previousOrder)` Sets the previous order.
`void`	`setScheduledDate(java.util.Date scheduledDate)`
`void`	`setUrgency(Order.Urgency urgency)`
`java.lang.String`	`toString()` Returns a string consisting of the name of the class of which the object is an instance and the `uuid` field surrounded by `[` and `]`.

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
  - Order
```
public Order()
```
    default constructor
  - Order
```
public Order(java.lang.Integer orderId)
```
    constructor with id
- Method Detail
  - copy
```
public Order copy()
```
    Performs a shallow copy of this Order. Does NOT copy orderId.
    
    Returns:
    
    a shallow copy of this Order
  - copyHelper
```
protected Order copyHelper(Order target)
```
    The purpose of this method is to allow subclasses of Order to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
    
    Parameters:
    
    target - an Order that will have the state of this copied into it
    
    Returns:
    
    Returns the Order that was passed in, with state copied into it
  - getAutoExpireDate
```
public java.util.Date getAutoExpireDate()
```
    Returns:
    
    Returns the autoExpireDate.
  - setAutoExpireDate
```
public void setAutoExpireDate(java.util.Date autoExpireDate)
```
    Parameters:
    
    autoExpireDate - The autoExpireDate to set.
  - getConcept
```
public Concept getConcept()
```
    Returns:
    
    Returns the concept.
  - setConcept
```
public void setConcept(Concept concept)
```
    Parameters:
    
    concept - The concept to set.
  - getScheduledDate
```
public java.util.Date getScheduledDate()
```
    Returns:
    
    the scheduledDate
    
    Since:
    
    1.10
  - setScheduledDate
```
public void setScheduledDate(java.util.Date scheduledDate)
```
    Parameters:
    
    scheduledDate - the date to set
    
    Since:
    
    1.10
  - getDateStopped
```
public java.util.Date getDateStopped()
```
    Returns:
    
    Returns the dateStopped.
    
    Since:
    
    1.10
  - getOrderReason
```
public Concept getOrderReason()
```
    Returns:
    
    Returns the orderReason.
  - setOrderReason
```
public void setOrderReason(Concept orderReason)
```
    Parameters:
    
    orderReason - The orderReason to set.
  - getEncounter
```
public Encounter getEncounter()
```
    Returns:
    
    Returns the encounter.
  - setEncounter
```
public void setEncounter(Encounter encounter)
```
    Parameters:
    
    encounter - The encounter to set.
  - getInstructions
```
public java.lang.String getInstructions()
```
    Returns:
    
    Returns the instructions.
  - setInstructions
```
public void setInstructions(java.lang.String instructions)
```
    Parameters:
    
    instructions - The instructions to set.
  - getAccessionNumber
```
public java.lang.String getAccessionNumber()
```
    Returns:
    
    Returns the accessionNumber.
  - setAccessionNumber
```
public void setAccessionNumber(java.lang.String accessionNumber)
```
    Parameters:
    
    accessionNumber - The accessionNumber to set.
  - getOrderer
```
public Provider getOrderer()
```
    Returns:
    
    Returns the orderer.
  - setOrderer
```
public void setOrderer(Provider orderer)
```
    Parameters:
    
    orderer - The orderer to set.
  - getOrderId
```
public java.lang.Integer getOrderId()
```
    Returns:
    
    Returns the orderId.
  - setOrderId
```
public void setOrderId(java.lang.Integer orderId)
```
    Parameters:
    
    orderId - The orderId to set.
  - getDateActivated
```
public java.util.Date getDateActivated()
```
    Returns:
    
    Returns the dateActivated.
  - setDateActivated
```
public void setDateActivated(java.util.Date dateActivated)
```
    Parameters:
    
    dateActivated - The dateActivated to set.
  - getOrderReasonNonCoded
```
public java.lang.String getOrderReasonNonCoded()
```
    Returns:
    
    Returns the orderReasonNonCoded.
  - setOrderReasonNonCoded
```
public void setOrderReasonNonCoded(java.lang.String orderReasonNonCoded)
```
    Parameters:
    
    orderReasonNonCoded - The orderReasonNonCoded to set.
  - getCommentToFulfiller
```
public java.lang.String getCommentToFulfiller()
```
    Returns:
    
    the commentToFulfiller
    
    Since:
    
    1.10
  - setCommentToFulfiller
```
public void setCommentToFulfiller(java.lang.String commentToFulfiller)
```
    Parameters:
    
    commentToFulfiller - The commentToFulfiller to set
    
    Since:
    
    1.10
  - isActive
```
public boolean isActive()
```
    Convenience method to determine if the order was active as of the current date
    
    Returns:
    
    boolean indicating whether the order was active on the check date
    
    Since:
    
    1.10.1
  - isActive
```
public boolean isActive(java.util.Date checkDate)
```
    Convenience method to determine if the order is active as of the specified date
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was active on the check date
    
    Since:
    
    1.10.1
  - isCurrent
```
@Deprecated
public boolean isCurrent(java.util.Date checkDate)
```
    Deprecated.
    
    Convenience method to determine if order is current
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was current on the input date
    
    See Also:
    
    isActive(java.util.Date)
  - isCurrent
```
@Deprecated
public boolean isCurrent()
```
    Deprecated.
    
    Returns:
    
    See Also:
    
    isActive()
  - isFuture
```
@Deprecated
public boolean isFuture(java.util.Date checkDate)
```
    Deprecated. use isStarted(java.util.Date)
    
    Convenience method to determine if the order is not yet activated as of the given date
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was activated after the check date
    
    See Also:
    
    isStarted(java.util.Date)
  - isFuture
```
@Deprecated
public boolean isFuture()
```
    Deprecated. use isStarted()
    
    Returns:
    
    See Also:
    
    isStarted()
  - isStarted
```
public boolean isStarted()
```
    Convenience method to determine if order is started as of the current date
    
    Returns:
    
    boolean indicating whether the order is started as of the current date
    
    Since:
    
    1.10.1
    
    See Also:
    
    isStarted(java.util.Date)
  - isStarted
```
public boolean isStarted(java.util.Date checkDate)
```
    Convenience method to determine if the order is started as of the specified date, returns true only if the order has been activated. In case of scheduled orders, the scheduledDate becomes the effective start date that gets used to determined if it is started.
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order is started as of the check date
    
    Since:
    
    1.10.1
  - isDiscontinued
```
public boolean isDiscontinued(java.util.Date checkDate)
```
    Convenience method to determine if the order is discontinued as of the specified date
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was discontinued on the input date
  - isExpired
```
public boolean isExpired()
```
    Convenience method to determine if the order is expired as of the specified date
    
    Returns:
    
    boolean indicating whether the order is expired at the current time
    
    Since:
    
    1.10.1
  - isExpired
```
public boolean isExpired(java.util.Date checkDate)
```
    Convenience method to determine if order was expired at a given time
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was expired on the input date
    
    Since:
    
    1.10.1
  - isDiscontinuedRightNow
```
public boolean isDiscontinuedRightNow()
```
  - getPatient
```
public Patient getPatient()
```
  - setPatient
```
public void setPatient(Patient patient)
```
  - getId
```
public java.lang.Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
  - toString
```
public java.lang.String toString()
```
    Description copied from class: BaseOpenmrsObject
    Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:
    getClass().getName() + '[' + uuid + ']'
    If the uuid field is null, it delegates to Object.toString()
    Overrides:
    
    toString in class BaseOpenmrsObject
    
    See Also:
    
    Object.toString()
  - setId
```
public void setId(java.lang.Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)
  - getUrgency
```
public Order.Urgency getUrgency()
```
    Returns:
    
    the urgency
    
    Since:
    
    1.9.2
  - setUrgency
```
public void setUrgency(Order.Urgency urgency)
```
    Parameters:
    
    urgency - the urgency to set
    
    Since:
    
    1.9.2
  - getOrderNumber
```
public java.lang.String getOrderNumber()
```
    Returns:
    
    the orderNumber
    
    Since:
    
    1.10
  - getPreviousOrder
```
public Order getPreviousOrder()
```
    Gets the previous related order.
    
    Returns:
    
    the previous order.
    
    Since:
    
    1.10
  - setPreviousOrder
```
public void setPreviousOrder(Order previousOrder)
```
    Sets the previous order.
    
    Parameters:
    
    previousOrder - the previous order to set.
    
    Since:
    
    1.10
  - getAction
```
public Order.Action getAction()
```
    Gets the action
    
    Returns:
    
    the action
    
    Since:
    
    1.10
  - setAction
```
public void setAction(Order.Action action)
```
    Sets the ation
    
    Parameters:
    
    action - the action to set
    
    Since:
    
    1.10
  - getCareSetting
```
public CareSetting getCareSetting()
```
    Gets the careSetting
    
    Returns:
    
    the action
    
    Since:
    
    1.10
  - setCareSetting
```
public void setCareSetting(CareSetting careSetting)
```
    Sets the careSetting
    
    Parameters:
    
    careSetting - the action to set
    
    Since:
    
    1.10
  - getOrderType
```
public OrderType getOrderType()
```
    Get the OrderType
    
    Returns:
    
    the OrderType
  - setOrderType
```
public void setOrderType(OrderType orderType)
```
    Set the OrderType
    
    Parameters:
    
    orderType - the OrderType
  - cloneForDiscontinuing
```
public Order 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
    
    Returns:
    
    the newly created order
    
    Since:
    
    1.10
  - cloneForRevision
```
public Order cloneForRevision()
```
    Creates an order for revision from this order, sets the previousOrder and action field.
    
    Returns:
    
    the newly created order
    
    Since:
    
    1.10
  - cloneForRevisionHelper
```
protected Order cloneForRevisionHelper(Order target)
```
    The purpose of this method is to allow subclasses of Order to delegate a portion of their cloneForRevision() method back to the superclass, in case the base class implementation changes.
    
    Parameters:
    
    target - an Order that will have the state of this copied into it
    
    Returns:
    
    Returns the Order that was passed in, with state copied into it
  - isType
```
public boolean isType(OrderType orderType)
```
    Checks whether this order's orderType matches or is a sub type of the specified one
    
    Parameters:
    
    orderType - the orderType to match on
    
    Returns:
    
    true if the type of the order matches or is a sub type of the other order
    
    Since:
    
    1.10
  - hasSameOrderableAs
```
public boolean hasSameOrderableAs(Order otherOrder)
```
    Checks whether orderable of this order is same as other order
    
    Parameters:
    
    otherOrder - the other order to match on
    
    Returns:
    
    true if the concept of the orders match
    
    Since:
    
    1.10
    
    See Also:
    
    for overridden behaviour
  - getEffectiveStartDate
```
public java.util.Date getEffectiveStartDate()
```
    A convenience method to return start of the schedule for order.
    
    Since:
    
    1.10
  - getEffectiveStopDate
```
public java.util.Date getEffectiveStopDate()
```
    A convenience method to return end of the schedule for order.
    
    Since:
    
    1.10

Class Order

Nested Class Summary

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

Order

Order

Method Detail

copy

copyHelper

getAutoExpireDate

setAutoExpireDate

getConcept

setConcept

getScheduledDate

setScheduledDate

getDateStopped

getOrderReason

setOrderReason

getEncounter

setEncounter

getInstructions

setInstructions

getAccessionNumber

setAccessionNumber

getOrderer

setOrderer

getOrderId

setOrderId

getDateActivated

setDateActivated

getOrderReasonNonCoded

setOrderReasonNonCoded

getCommentToFulfiller

setCommentToFulfiller

isActive

isActive

isCurrent

isCurrent

isFuture

isFuture

isStarted

isStarted

isDiscontinued

isExpired

isExpired

isDiscontinuedRightNow

getPatient

setPatient

getId

toString

setId

getUrgency

setUrgency

getOrderNumber

getPreviousOrder

setPreviousOrder

getAction

setAction

getCareSetting

setCareSetting

getOrderType

setOrderType

cloneForDiscontinuing

cloneForRevision

cloneForRevisionHelper

isType

hasSameOrderableAs

getEffectiveStartDate

getEffectiveStopDate