org.openmrs.api

Interface OrderService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

OrderServiceImpl

public interface OrderService
extends OpenmrsService

Contains methods pertaining to creating/deleting/voiding Orders

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARALLEL_ORDERS

Method Summary

Modifier and Type	Method and Description
Order	discontinueOrder(Order orderToDiscontinue, Concept reasonCoded, Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
Order	discontinueOrder(Order orderToDiscontinue, String reasonNonCoded, Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
List<Order>	getActiveOrders(Patient patient, OrderType orderType, CareSetting careSetting, Date asOfDate) Gets all active orders for the specified patient matching the specified CareSetting, OrderType as of the specified date.
List<Order>	getActiveOrders(Patient patient, Visit visit, OrderType orderType, CareSetting careSetting, Date asOfDate)
List<OrderAttributeType>	getAllOrderAttributeTypes() Returns all order attribute types
List<OrderGroupAttributeType>	getAllOrderGroupAttributeTypes() Returns all order group attribute types
List<Order>	getAllOrdersByPatient(Patient patient) Gets all orders for the specified patient including discontinuation orders
CareSetting	getCareSetting(Integer careSettingId) Retrieve care setting
CareSetting	getCareSettingByName(String name) Gets the CareSetting with the specified name
CareSetting	getCareSettingByUuid(String uuid) Gets the CareSetting with the specified uuid
List<CareSetting>	getCareSettings(boolean includeRetired) Gets all non retired CareSettings if includeRetired is set to true otherwise retired ones are included too
Order	getDiscontinuationOrder(Order order) Get discontinuation order for the given order, it is the un voided discontinuation order with a previousOrder that matches the specified order.
List<Concept>	getDrugDispensingUnits() Gets the possible units of dispensing, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DISPENSING_UNITS_CONCEPT_UUID
List<Concept>	getDrugDosingUnits() Gets the possible drug dosing units, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DOSING_UNITS_CONCEPT_UUID
List<Concept>	getDrugRoutes() Gets the possible drug routes, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_ROUTES_CONCEPT_UUID
List<Concept>	getDurationUnits() Gets the possible units of duration, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DURATION_UNITS_CONCEPT_UUID
Long	getNextOrderNumberSeedSequenceValue() Gets the next available order number seed
Concept	getNonCodedDrugConcept() Gets the non coded drug concept, i.e the concept that matches the uuid specified as the value for the global property {@link OpenmrsConstants#GP_DRUG_ORDER_DRUG_OTHER
Order	getOrder(Integer orderId) Get order by internal primary key identifier
OrderAttribute	getOrderAttributeByUuid(String uuid) Fetches a given order attribute using the provided uuid
OrderAttributeType	getOrderAttributeTypeById(Integer orderAttributeTypeId) Fetches order attribute type using provided Id
OrderAttributeType	getOrderAttributeTypeByName(String orderAttributeTypeName) Retrieves an order attribute type object based on the name provided
OrderAttributeType	getOrderAttributeTypeByUuid(String uuid) Fetches order attribute type using provided uuid
Order	getOrderByOrderNumber(String orderNumber) Gets the order identified by a given order number
Order	getOrderByUuid(String uuid) Get Order by its UUID
List<OrderFrequency>	getOrderFrequencies(boolean includeRetired) Gets all order frequencies
List<OrderFrequency>	getOrderFrequencies(String searchPhrase, Locale locale, boolean exactLocale, boolean includeRetired) Gets all non retired order frequencies associated to concepts that match the specified search phrase
OrderFrequency	getOrderFrequency(Integer orderFrequencyId) Gets OrderFrequency that matches the specified orderFrequencyId
OrderFrequency	getOrderFrequencyByConcept(Concept concept) Gets an OrderFrequency that matches the specified concept
OrderFrequency	getOrderFrequencyByUuid(String uuid) Gets OrderFrequency that matches the specified uuid
OrderGroup	getOrderGroup(Integer orderGroupId) Fetches the OrderGroup by Id.
OrderGroupAttribute	getOrderGroupAttributeByUuid(String uuid) Fetches a given order group attribute using the provided uuid
OrderGroupAttributeType	getOrderGroupAttributeType(Integer orderGroupAttributeTypeId) Fetches order group attribute type using provided Id
OrderGroupAttributeType	getOrderGroupAttributeTypeByName(String orderGroupAttributeTypeName) Retrieves an order group attribute type object based on the name provided
OrderGroupAttributeType	getOrderGroupAttributeTypeByUuid(String uuid) Fetches order group attribute type using provided uuid
OrderGroup	getOrderGroupByUuid(String uuid) Fetches the OrderGroup By Uuid.
List<OrderGroup>	getOrderGroupsByEncounter(Encounter encounter) Fetches all order groups for the specified encounter
List<OrderGroup>	getOrderGroupsByPatient(Patient patient) Fetches all order groups for the specified patient
List<Order>	getOrderHistoryByConcept(Patient patient, Concept concept) Gets all Order objects that use this Concept for a given patient.
List<Order>	getOrderHistoryByOrderNumber(String orderNumber) Gets the order matching the specified order number and its previous orders in the ordering they occurred, i.e if this order has a previous order, fetch it and if it also has a previous order then fetch it until the original one with no previous order is reached
List<Order>	getOrders(OrderSearchCriteria orderSearchCriteria) Get all orders that match a variety of (nullable) criteria contained in the parameter object.
List<Order>	getOrders(Patient patient, CareSetting careSetting, OrderType orderType, boolean includeVoided) Gets all Orders that match the specified parameters excluding discontinuation orders
List<Order>	getOrders(Patient patient, Visit visit, CareSetting careSetting, OrderType orderType, boolean includeVoided)
OrderType	getOrderType(Integer orderTypeId) Get OrderType by orderTypeId
OrderType	getOrderTypeByConcept(Concept concept) Gets the order type mapped to a given concept
OrderType	getOrderTypeByConceptClass(ConceptClass conceptClass) Gets the order type mapped to a given concept class
OrderType	getOrderTypeByName(String orderTypeName) Gets OrderType that matches the specified name
OrderType	getOrderTypeByUuid(String uuid) Get OrderType by uuid
List<OrderType>	getOrderTypes(boolean includeRetired) Get all order types, if includeRetired is set to true then retired ones will be included otherwise not
Order	getRevisionOrder(Order order) Get revision order for the given order, it is the order with the changes that was created as a replacement for the specified order.
List<OrderType>	getSubtypes(OrderType orderType, boolean includeRetired) Returns all descendants of a given order type for example Given TEST will get back LAB TEST and RADIOLOGY TEST; and Given LAB TEST, will might get back SEROLOGY, MICROBIOLOGY, and CHEMISTRY
List<Concept>	getTestSpecimenSources() Gets the possible test specimen sources, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_TEST_SPECIMEN_SOURCES_CONCEPT_UUID
void	purgeOrder(Order order) Completely delete an order from the database.
void	purgeOrder(Order order, boolean cascade) Completely delete an order from the database.
void	purgeOrderAttributeType(OrderAttributeType orderAttributeType) Completely removes an order attribute type from the database
void	purgeOrderFrequency(OrderFrequency orderFrequency) Completely removes an order frequency from the database
void	purgeOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Completely removes an order group attribute type from the database
void	purgeOrderType(OrderType orderType) Completely removes an order type from the database
OrderAttributeType	retireOrderAttributeType(OrderAttributeType orderAttributeType, String reason) Retires the given order attribute type in the database
OrderFrequency	retireOrderFrequency(OrderFrequency orderFrequency, String reason) Retires the given order frequency in the database
OrderGroupAttributeType	retireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType, String reason) Retires the given order group attribute type in the database
OrderType	retireOrderType(OrderType orderType, String reason) Retires the given order type in the database
Order	saveOrder(Order order, OrderContext orderContext) Save or update the given order in the database.
OrderAttributeType	saveOrderAttributeType(OrderAttributeType orderAttributeType) Creates or updates the given order attribute type in the database
OrderFrequency	saveOrderFrequency(OrderFrequency orderFrequency) Creates or updates the given order frequency in the database
OrderGroup	saveOrderGroup(OrderGroup orderGroup) Saves the orderGroup.
OrderGroup	saveOrderGroup(OrderGroup orderGroup, OrderContext orderContext) Saves an order group with a specific order context
OrderGroupAttributeType	saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Creates or updates the given order group attribute type in the database
OrderType	saveOrderType(OrderType orderType) Creates or updates the given order type in the database
Order	saveRetrospectiveOrder(Order order, OrderContext orderContext) Save or update the given retrospective order in the database.
void	setOrderDAO(OrderDAO dao) Setter for the Order data access object.
OrderAttributeType	unretireOrderAttributeType(OrderAttributeType orderAttributeType) Restores an order attribute type that was previously retired in the database
OrderFrequency	unretireOrderFrequency(OrderFrequency orderFrequency) Restores an order frequency that was previously retired in the database
OrderGroupAttributeType	unretireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Restores an order group attribute type that was previously retired in the database
OrderType	unretireOrderType(OrderType orderType) Restores an order type that was previously retired in the database
Order	unvoidOrder(Order order) Unvoid order record.
Order	updateOrderFulfillerStatus(Order order, Order.FulfillerStatus orderFulfillerStatus, String fullFillerComment) Updates the fulfillerStatus of an order and the related comment and finally persists it
Order	updateOrderFulfillerStatus(Order order, Order.FulfillerStatus orderFulfillerStatus, String fullFillerComment, String accessionNumber) Updates the fulfillerStatus of an order and the related comment and finally persists it
Order	voidOrder(Order order, String voidReason) Mark an order as voided.

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Field Detail

PARALLEL_ORDERS

static final String PARALLEL_ORDERS

See Also:

Constant Field Values

Method Detail

setOrderDAO

void setOrderDAO(OrderDAO dao)

Setter for the Order data access object. The dao is used for saving and getting orders to/from the database

Parameters:

dao - The data access object to use

saveOrder

@Authorized(value={"Edit Orders","Add Orders"})
Order saveOrder(Order order,
                                                                OrderContext orderContext)
                                                         throws APIException

Save or update the given order in the database. If the OrderType for the order is not specified, then it will be set to the one set on the OrderContext if any, if none exists on the orderContext, then it will be set to the one associated to the ConceptClass of the ordered concept otherwise the save fails. If the CareSetting field of the order is not specified then it will default to the one set on the passed in OrderContext if any otherwise the save fails.

Parameters:

order - the Order to save

orderContext - the OrderContext object

Returns:

the Order that was saved

Throws:

APIException - Should not save order if order doesnt validate Should discontinue existing active order if new order being saved with action to discontinue Should pass if the existing drug order matches the concept and drug of the DC order Should fail if the existing drug order matches the concept and not drug of the DC order Should discontinue previousOrder if it is not already discontinued Should fail if concept in previous order does not match this concept Should not allow editing an existing order Should not allow revising a voided order Should not allow revising a stopped order Should not allow revising an expired order Should not allow revising an order with no previous order Should save a revised order Should save a revised order for a scheduled order which is not started Should set order number specified in the context if specified Should set the order number returned by the configured generator Should set order type if null but mapped to the concept class Should fail if order type is null and not mapped to the concept class Should default to care setting and order type defined in the order context if null Should not allow changing the patient of the previous order when revising an order Should not allow changing the careSetting of the previous order when revising an order Should not allow changing the concept of the previous order when revising an order Should not allow changing the drug of the previous drug order when revising an order Should fail if concept in previous order does not match that of the revised order Should fail if the existing drug order matches the concept and not drug of the revised order Should fail if the order type of the previous order does not match Should fail if the java type of the previous order does not match Should fail if the careSetting of the previous order does not match Should set concept for drug orders if null Should pass for a discontinuation order with no previous order Should fail if an active drug order for the same concept and care setting exists Should pass if an active test order for the same concept and care setting exists Should pass if an active order for the same concept exists in a different care setting Should set Order type of Drug Order to drug order if not set and concept not mapped Should set Order type of Test Order to test order if not set and concept not mapped Should throw AmbiguousOrderException if an active drug order for the same drug formulation exists Should pass if an active order for the same concept exists in a different care setting Should fail for revision order if an active drug order for the same concept and care settings exists Should pass for revision order if an active test order for the same concept and care settings exists Should roll the autoExpireDate to the end of the day if it has no time component Should not change the autoExpireDate if it has a time component Should throw AmbiguousOrderException if disconnecting multiple active orders for the given concept Should throw AmbiguousOrderException if disconnecting multiple active drug orders with the same drug

saveRetrospectiveOrder

@Authorized(value={"Edit Orders","Add Orders"})
Order saveRetrospectiveOrder(Order order,
                                                                             OrderContext orderContext)

Save or update the given retrospective order in the database. If the OrderType for the order is not specified, then it will be set to the one set on the OrderContext if any, if none exists on the orderContext, then it will be set to the one associated to the ConceptClass of the ordered concept otherwise the save fails. If the CareSetting field of the order is not specified then it will default to the one set on the passed in OrderContext if any otherwise the save fails. Retrospective entry of orders can affect downstream systems that acts on orders created. Orders cannot be stopped if they are already stopped in retrospective entry.

Parameters:

order - the Order to save

orderContext - the OrderContext object

Returns:

the Order that was saved

Throws:

APIException

See Also:

saveOrder(Order, OrderContext)

purgeOrder

@Authorized(value="Purge Orders")
void purgeOrder(Order order)
                                           throws APIException

Completely delete an order from the database. This should not typically be used unless desperately needed. Most orders should just be voided. See voidOrder(Order, String)

Parameters:

order - The Order to remove from the system

Throws:

APIException - Should delete order from the database

purgeOrder

@Authorized(value="Purge Orders")
void purgeOrder(Order order,
                                                  boolean cascade)
                                           throws APIException

Completely delete an order from the database. This should not typically be used unless desperately needed. Most orders should just be voided. See voidOrder(Order, String) This method is different from purgeOrder(Order order) above: If param cascade is false will completely delete an order from the database period If param cascade is true will completely delete an order from the database and delete any Obs that references the Order.

Parameters:

order - The Order to remove from the system

cascade -

Throws:

APIException

Since:

1.9.4 Should delete any Obs associated to the order when cascade is true

voidOrder

@Authorized(value="Delete Orders")
Order voidOrder(Order order,
                                                   String voidReason)
                                            throws APIException

Mark an order as voided. This functionally removes the Order from the system while keeping a semblance

Parameters:

voidReason - String reason

order - Order to void

Returns:

the Order that was voided

Throws:

APIException - Should void an order Should unset dateStopped of the previous order if the specified order is a discontinuation Should unset dateStopped of the previous order if the specified order is a revision

getOrder

@Authorized(value="Get Orders")
Order getOrder(Integer orderId)
                                        throws APIException

Get order by internal primary key identifier

Parameters:

orderId - internal order identifier

Returns:

order with given internal identifier

Throws:

APIException

getOrderByUuid

@Authorized(value="Get Orders")
Order getOrderByUuid(String uuid)
                                              throws APIException

Get Order by its UUID

Parameters:

uuid -

Returns:

order or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getDiscontinuationOrder

@Authorized(value="Get Orders")
Order getDiscontinuationOrder(Order order)
                                                       throws APIException

Get discontinuation order for the given order, it is the un voided discontinuation order with a previousOrder that matches the specified order.

Parameters:

order -

Returns:

the discontinuation order or null if none

Throws:

APIException

Since:

1.10 Should return discontinuation order if order has been discontinued Should return null if order has not been discontinued Should return null if dc order is voided

getRevisionOrder

@Authorized(value="Get Orders")
Order getRevisionOrder(Order order)
                                                throws APIException

Get revision order for the given order, it is the order with the changes that was created as a replacement for the specified order. In other words, it is the un voided revise order with a previousOrder that matches the specified order.

Parameters:

order -

Returns:

the revision order or null if none

Throws:

APIException

Since:

1.10 Should return revision order if order has been revised Should return null if order has not been revised Should not return a voided revision order

getOrders

@Authorized(value="Get Orders")
List<Order> getOrders(Patient patient,
                                                      CareSetting careSetting,
                                                      OrderType orderType,
                                                      boolean includeVoided)

Gets all Orders that match the specified parameters excluding discontinuation orders

Parameters:

patient - the patient to match on

careSetting - the CareSetting to match on

orderType - The OrderType to match on

includeVoided - Specifies whether voided orders should be included or not

Returns:

list of Orders matching the parameters

Since:

1.10 Should fail if patient is null Should fail if careSetting is null Should get the orders that match all the arguments Should get all unvoided matches if includeVoided is set to false Should include voided matches if includeVoided is set to true Should include orders for sub types if order type is specified

getAllOrdersByPatient

@Authorized(value="Get Orders")
List<Order> getAllOrdersByPatient(Patient patient)

Gets all orders for the specified patient including discontinuation orders

Parameters:

patient - the patient to match on

Returns:

list of matching Order

Since:

1.10 Should fail if patient is null Should get all the orders for the specified patient

getOrders

@Authorized(value="Get Orders")
List<Order> getOrders(OrderSearchCriteria orderSearchCriteria)

Get all orders that match a variety of (nullable) criteria contained in the parameter object. Each extra value for a parameter that is provided acts as an "and" and will reduce the number of results returned

Parameters:

orderSearchCriteria - the object containing search parameters

Returns:

a list of orders matching the search criteria

Since:

2.2 Should get the order matching the search criteria

unvoidOrder

@Authorized(value="Delete Orders")
Order unvoidOrder(Order order)
                                              throws APIException

Unvoid order record. Reverse a previous call to voidOrder(Order, String)

Parameters:

order - order to be unvoided

Returns:

the Order that was unvoided Should unvoid an order Should stop the previous order if the specified order is a discontinuation Should stop the previous order if the specified order is a revision Should fail for a discontinuation order if the previousOrder is inactive Should fail for a revise order if the previousOrder is inactive

Throws:

APIException

updateOrderFulfillerStatus

@Authorized(value="Edit Orders")
Order updateOrderFulfillerStatus(Order order,
                                                                  Order.FulfillerStatus orderFulfillerStatus,
                                                                  String fullFillerComment)

Updates the fulfillerStatus of an order and the related comment and finally persists it

Parameters:

order - order whose fulfillerStatus should be changed

orderFulfillerStatus - describes the new Order.FulfillerStatus the order should be set to

fullFillerComment - is a string which describes a comment that is set while changing the FulfillerStatus

Returns:

the Order that is updated with an according fulfillerStatus and fulFillerComment Should set the new fulfillerStatus Should set the new fulFillerComment Should not update fulfillerStatus or fulFillerComment if null passed in to that field Should save the changed order

updateOrderFulfillerStatus

@Authorized(value="Edit Orders")
Order updateOrderFulfillerStatus(Order order,
                                                                  Order.FulfillerStatus orderFulfillerStatus,
                                                                  String fullFillerComment,
                                                                  String accessionNumber)

Updates the fulfillerStatus of an order and the related comment and finally persists it

Parameters:

order - order whose fulfillerStatus should be changed

orderFulfillerStatus - describes the new Order.FulfillerStatus the order should be set to

fullFillerComment - is a string which describes a comment that is set while changing the FulfillerStatus

accessionNumber - is the accession number to set

Returns:

the Order that is updated with an according fulfillerStatus and fulFillerComment and accession number Should set the new fulfillerStatus Should set the new fulFillerComment Should set the new accessionNumber Should not update fulfillerStatus or fulFillerComment or accessionNumber if null passed in to that field Should save the changed order

getOrderByOrderNumber

@Authorized(value="Get Orders")
Order getOrderByOrderNumber(String orderNumber)

Gets the order identified by a given order number

Parameters:

orderNumber - the order number

Returns:

the order object Should find object given valid order number Should return null if no object found with given order number

getOrderHistoryByConcept

@Authorized(value="Get Orders")
List<Order> getOrderHistoryByConcept(Patient patient,
                                                                     Concept concept)

Gets all Order objects that use this Concept for a given patient. Orders will be returned in the order in which they occurred, i.e. sorted by startDate starting with the latest

Parameters:

patient - the patient.

concept - the concept.

Returns:

the list of orders. Should return orders with the given concept Should return empty list for concept without orders Should reject a null patient Should reject a null concept

getNextOrderNumberSeedSequenceValue

@Authorized(value="Add Orders")
Long getNextOrderNumberSeedSequenceValue()

Gets the next available order number seed

Returns:

the order number seed

getOrderHistoryByOrderNumber

@Authorized(value="Get Orders")
List<Order> getOrderHistoryByOrderNumber(String orderNumber)

Gets the order matching the specified order number and its previous orders in the ordering they occurred, i.e if this order has a previous order, fetch it and if it also has a previous order then fetch it until the original one with no previous order is reached

Parameters:

orderNumber - the order number whose history to get

Returns:

a list of orders for given order number Should return all order history for given order number

getActiveOrders

@Authorized(value="Get Orders")
List<Order> getActiveOrders(Patient patient,
                                                            OrderType orderType,
                                                            CareSetting careSetting,
                                                            Date asOfDate)

Gets all active orders for the specified patient matching the specified CareSetting, OrderType as of the specified date. Below is the criteria for determining an active order:

 - Not voided
 - Not a discontinuation Order i.e one where action != Action#DISCONTINUE
 - dateActivated is before or equal to asOfDate
 - dateStopped and autoExpireDate are both null OR if it has dateStopped, then it should be
 after asOfDate OR if it has autoExpireDate, then it should be after asOfDate. NOTE: If both
 dateStopped and autoExpireDate are set then dateStopped wins because an order can never
 expire and then stopped later i.e. you stop an order that hasn't yet expired
 

Parameters:

patient - the patient

orderType - The OrderType to match

careSetting - the care setting, returns all ignoring care setting if value is null

asOfDate - defaults to current time

Returns:

all active orders for given patient parameters

Since:

1.10 Should return all active orders for the specified patient Should return all active orders for the specified patient and care setting Should return all active drug orders for the specified patient Should return all active test orders for the specified patient Should fail if patient is null Should return active orders as of the specified date Should return all orders if no orderType is specified Should include orders for sub types if order type is specified

getCareSetting

@Authorized(value="Get Care Settings")
CareSetting getCareSetting(Integer careSettingId)

Retrieve care setting

Parameters:

careSettingId -

Returns:

the care setting

Since:

1.10

getCareSettingByUuid

@Authorized(value="Get Care Settings")
CareSetting getCareSettingByUuid(String uuid)

Gets the CareSetting with the specified uuid

Parameters:

uuid - the uuid to match on

Returns:

CareSetting Should return the care setting with the specified uuid

getCareSettingByName

@Authorized(value="Get Care Settings")
CareSetting getCareSettingByName(String name)

Gets the CareSetting with the specified name

Parameters:

name - the name to match on

Returns:

CareSetting Should return the care setting with the specified name

getCareSettings

@Authorized(value="Get Care Settings")
List<CareSetting> getCareSettings(boolean includeRetired)

Gets all non retired CareSettings if includeRetired is set to true otherwise retired ones are included too

Parameters:

includeRetired - specifies whether retired care settings should be returned or not

Returns:

A List of CareSettings Should return only un retired care settings if includeRetired is set to false Should return retired care settings if includeRetired is set to true

getOrderTypeByName

@Authorized(value="Get Order Types")
OrderType getOrderTypeByName(String orderTypeName)

Gets OrderType that matches the specified name

Parameters:

orderTypeName - the name to match against

Returns:

OrderType

Since:

1.10 Should return the order type that matches the specified name

getOrderFrequency

@Authorized(value="Get Order Frequencies")
OrderFrequency getOrderFrequency(Integer orderFrequencyId)

Gets OrderFrequency that matches the specified orderFrequencyId

Parameters:

orderFrequencyId - the id to match against

Returns:

OrderFrequency

Since:

1.10 Should return the order frequency that matches the specified id

getOrderFrequencyByUuid

@Authorized(value="Get Order Frequencies")
OrderFrequency getOrderFrequencyByUuid(String uuid)

Gets OrderFrequency that matches the specified uuid

Parameters:

uuid - the uuid to match against

Returns:

OrderFrequency

Since:

1.10 Should return the order frequency that matches the specified uuid

getOrderFrequencyByConcept

@Authorized(value="Get Order Frequencies")
OrderFrequency getOrderFrequencyByConcept(Concept concept)

Gets an OrderFrequency that matches the specified concept

Parameters:

concept - the concept to match against

Returns:

OrderFrequency

Since:

1.10 Should return the order frequency that matches the specified concept

getOrderFrequencies

@Authorized(value="Get Order Frequencies")
List<OrderFrequency> getOrderFrequencies(boolean includeRetired)

Gets all order frequencies

Parameters:

includeRetired - specifies whether retired ones should be included or not Should return only non retired order frequencies if includeRetired is set to false Should return all the order frequencies if includeRetired is set to true

Returns:

List<OrderFrequency>

Since:

1.10

getOrderFrequencies

@Authorized(value="Get Order Frequencies")
List<OrderFrequency> getOrderFrequencies(String searchPhrase,
                                                                                    Locale locale,
                                                                                    boolean exactLocale,
                                                                                    boolean includeRetired)

Gets all non retired order frequencies associated to concepts that match the specified search phrase

Parameters:

searchPhrase - The string to match on

locale - The locale to match on when searching in associated concept names

exactLocale - If false then order frequencies associated to concepts with names in a broader locale will be matched e.g in case en_GB is passed in then en will be matched

includeRetired - Specifies if retired order frequencies that match should be included or not

Returns:

List<OrderFrequency>

Since:

1.10 Should get non retired frequencies with names matching the phrase if includeRetired is false Should include retired frequencies if includeRetired is set to true Should get frequencies with names that match the phrase and locales if exact locale is false Should get frequencies with names that match the phrase and locale if exact locale is true Should return unique frequencies Should reject a null search phrase

discontinueOrder

@Authorized(value={"Add Orders","Edit Orders"})
Order discontinueOrder(Order orderToDiscontinue,
                                                                       Concept reasonCoded,
                                                                       Date discontinueDate,
                                                                       Provider orderer,
                                                                       Encounter encounter)

Discontinues an order. Creates a new order that discontinues the orderToDiscontinue

Parameters:

orderToDiscontinue -

reasonCoded -

discontinueDate -

orderer -

encounter -

Returns:

the new order that discontinued orderToDiscontinue

Throws:

APIException - if the action of orderToDiscontinue is Order.Action.DISCONTINUE

Since:

1.10 Should set correct attributes on the discontinue and discontinued orders Should pass for an active order which is scheduled and not started as of discontinue date Should not pass for a discontinuation order Should fail for a stopped order Should fail for an expired order Should reject a future discontinueDate Should not pass for a discontinued order

discontinueOrder

@Authorized(value={"Add Orders","Edit Orders"})
Order discontinueOrder(Order orderToDiscontinue,
                                                                       String reasonNonCoded,
                                                                       Date discontinueDate,
                                                                       Provider orderer,
                                                                       Encounter encounter)

Discontinues an order. Creates a new order that discontinues the orderToDiscontinue.

Parameters:

orderToDiscontinue -

reasonNonCoded -

discontinueDate -

orderer -

encounter -

Returns:

the new order that discontinued orderToDiscontinue

Throws:

APIException - if the action of orderToDiscontinue is Order.Action.DISCONTINUE

Since:

1.10 Should populate correct attributes on the discontinue and discontinued orders Should pass for an active order which is scheduled and not started as of discontinue date Should fail for a discontinuation order Should fail if discontinueDate is in the future Should fail for a voided order Should fail for a discontinued order

saveOrderFrequency

@Authorized(value="Manage Order Frequencies")
OrderFrequency saveOrderFrequency(OrderFrequency orderFrequency)
                                                                         throws APIException

Creates or updates the given order frequency in the database

Parameters:

orderFrequency - the order frequency to save

Returns:

the order frequency created/saved

Throws:

APIException

Since:

1.10 Should add a new order frequency to the database Should edit an existing order frequency that is not in use Should not allow editing an existing order frequency that is in use

retireOrderFrequency

@Authorized(value="Manage Order Frequencies")
OrderFrequency retireOrderFrequency(OrderFrequency orderFrequency,
                                                                                  String reason)

Retires the given order frequency in the database

Parameters:

orderFrequency - the order frequency to retire

reason - the retire reason

Returns:

the retired order frequency

Since:

1.10 Should retire given order frequency

unretireOrderFrequency

@Authorized(value="Manage Order Frequencies")
OrderFrequency unretireOrderFrequency(OrderFrequency orderFrequency)

Restores an order frequency that was previously retired in the database

Parameters:

orderFrequency - the order frequency to unretire

Returns:

the unretired order frequency

Since:

1.10 Should unretire given order frequency

purgeOrderFrequency

@Authorized(value="Purge Order Frequencies")
void purgeOrderFrequency(OrderFrequency orderFrequency)
                                                               throws APIException

Completely removes an order frequency from the database

Parameters:

orderFrequency - the order frequency to purge

Throws:

APIException

Since:

1.10 Should delete given order frequency Should not allow deleting an order frequency that is in use

getOrderType

@Authorized(value="Get Order Types")
OrderType getOrderType(Integer orderTypeId)

Get OrderType by orderTypeId

Parameters:

orderTypeId - the orderTypeId to match on

Returns:

order type object associated with given id Should find order type object given valid id Should return null if no order type object found with given id

Since:

1.10

getOrderTypeByUuid

@Authorized(value="Get Order Types")
OrderType getOrderTypeByUuid(String uuid)

Get OrderType by uuid

Parameters:

uuid - the uuid to match on

Returns:

order type object associated with given uuid Should find order type object given valid uuid Should return null if no order type object found with given uuid

Since:

1.10

getOrderTypes

@Authorized(value="Get Order Types")
List<OrderType> getOrderTypes(boolean includeRetired)

Get all order types, if includeRetired is set to true then retired ones will be included otherwise not

Parameters:

includeRetired - boolean flag which indicate search needs to look at retired order types or not Should get all order types if includeRetired is set to true Should get all non retired order types if includeRetired is set to false

Returns:

list of order types

Since:

1.10

saveOrderType

@Authorized(value="Manage Order Types")
OrderType saveOrderType(OrderType orderType)

Creates or updates the given order type in the database

Parameters:

orderType - the order type to save

Returns:

the order type created/saved

Since:

1.10 Should add a new order type to the database Should edit an existing order type

purgeOrderType

@Authorized(value="Purge Order Types")
void purgeOrderType(OrderType orderType)
                                                    throws APIException

Completely removes an order type from the database

Parameters:

orderType - the order type to purge

Throws:

APIException

Since:

1.10 Should delete order type if not in use Should not allow deleting an order type that is in use

retireOrderType

@Authorized(value="Manage Order Types")
OrderType retireOrderType(OrderType orderType,
                                                                  String reason)

Retires the given order type in the database

Parameters:

orderType - the order type to retire

reason - the retire reason

Returns:

the retired order type

Since:

1.10 Should retire order type

unretireOrderType

@Authorized(value="Manage Order Types")
OrderType unretireOrderType(OrderType orderType)

Restores an order type that was previously retired in the database

Parameters:

orderType - the order type to unretire

Returns:

the unretired order type

Since:

1.10 Should unretire order type

getSubtypes

@Authorized(value="Get Order Types")
List<OrderType> getSubtypes(OrderType orderType,
                                                                 boolean includeRetired)

Returns all descendants of a given order type for example Given TEST will get back LAB TEST and RADIOLOGY TEST; and Given LAB TEST, will might get back SEROLOGY, MICROBIOLOGY, and CHEMISTRY

Parameters:

orderType - the order type which needs to search for its' dependencies

includeRetired - boolean flag for include retired order types or not

Returns:

list of order type which matches the given order type

getOrderTypeByConceptClass

@Authorized(value="Get Order Types")
OrderType getOrderTypeByConceptClass(ConceptClass conceptClass)

Gets the order type mapped to a given concept class

Parameters:

conceptClass - the concept class

Returns:

the matching order type

Since:

1.10 Should get order type mapped to the given concept class

getOrderTypeByConcept

@Authorized(value="Get Order Types")
OrderType getOrderTypeByConcept(Concept concept)

Gets the order type mapped to a given concept

Parameters:

concept - the concept

Returns:

the matching order type

Since:

1.10 Should get order type mapped to the given concept

getDrugRoutes

@Authorized(value="Get Concepts")
List<Concept> getDrugRoutes()

Gets the possible drug routes, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_ROUTES_CONCEPT_UUID

Returns:

concept list of drug routes

Since:

1.10 Should return an empty list if nothing is configured

getDrugDosingUnits

@Authorized(value="Get Concepts")
List<Concept> getDrugDosingUnits()

Gets the possible drug dosing units, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DOSING_UNITS_CONCEPT_UUID

Returns:

concept list of drug dosing units

Since:

1.10 Should return an empty list if nothing is configured Should return a list if GP is set

getDrugDispensingUnits

@Authorized(value="Get Concepts")
List<Concept> getDrugDispensingUnits()

Gets the possible units of dispensing, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DISPENSING_UNITS_CONCEPT_UUID

Returns:

concept list of units of dispensing

Since:

1.10 Should return an empty list if nothing is configured Should return a list if GP is set Should return the union of the dosing and dispensing units

getDurationUnits

@Authorized(value="Get Concepts")
List<Concept> getDurationUnits()

Gets the possible units of duration, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DURATION_UNITS_CONCEPT_UUID

Returns:

concept list of units of duration

Since:

1.10 Should return an empty list if nothing is configured Should return a list if GP is set

getTestSpecimenSources

@Authorized(value="Get Concepts")
List<Concept> getTestSpecimenSources()

Gets the possible test specimen sources, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_TEST_SPECIMEN_SOURCES_CONCEPT_UUID

Returns:

concept list of specimen sources

Since:

1.10 Should return an empty list if nothing is configured Should return a list if GP is set

getNonCodedDrugConcept

@Authorized(value="Get Concepts")
Concept getNonCodedDrugConcept()

Gets the non coded drug concept, i.e the concept that matches the uuid specified as the value for the global property {@link OpenmrsConstants#GP_DRUG_ORDER_DRUG_OTHER

Returns:

concept of non coded drug

Since:

1.12 Should return null if nothing is configured Should return a concept if GP is set

getOrderGroupByUuid

@Authorized(value="Get Orders")
OrderGroup getOrderGroupByUuid(String uuid)
                                                        throws APIException

Fetches the OrderGroup By Uuid.

Parameters:

uuid - Uuid Of the OrderGroup

Returns:

saved OrderGroup

Throws:

APIException

Since:

1.12

getOrderGroup

@Authorized(value="Get Orders")
OrderGroup getOrderGroup(Integer orderGroupId)
                                                  throws APIException

Fetches the OrderGroup by Id.

Parameters:

orderGroupId - Id of the OrderGroup

Returns:

saved OrderGroup

Throws:

APIException

Since:

1.12

saveOrderGroup

@Authorized(value={"Edit Orders","Add Orders"})
OrderGroup saveOrderGroup(OrderGroup orderGroup)
                                                                   throws APIException

Saves the orderGroup. It also saves the list of orders that are present within the orderGroup.

Parameters:

orderGroup - the orderGroup to be saved

Throws:

APIException

Since:

1.12

saveOrderGroup

@Authorized(value={"Edit Orders","Add Orders"})
OrderGroup saveOrderGroup(OrderGroup orderGroup,
                                                                          OrderContext orderContext)
                                                                   throws APIException

Saves an order group with a specific order context

Parameters:

orderGroup - the order group to be saved

orderContext - the order context data transfer object containing care setting and the order type to save with the order group

Returns:

the order group that was saved with the specified order context data

Throws:

APIException

Since:

2.7.0

getOrderGroupsByPatient

@Authorized(value="Get Orders")
List<OrderGroup> getOrderGroupsByPatient(Patient patient)
                                                                  throws APIException

Fetches all order groups for the specified patient

Parameters:

patient - the patient to match on

Returns:

list of matching OrderGroups

Throws:

APIException

Since:

2.4.0

getOrderGroupsByEncounter

@Authorized(value="Get Orders")
List<OrderGroup> getOrderGroupsByEncounter(Encounter encounter)
                                                                    throws APIException

Fetches all order groups for the specified encounter

Parameters:

encounter - the encounter to match on

Returns:

list of matching OrderGroups

Throws:

APIException

Since:

2.4.0

getAllOrderGroupAttributeTypes

@Authorized(value="Get Orders")
List<OrderGroupAttributeType> getAllOrderGroupAttributeTypes()
                                                                                      throws APIException

Returns all order group attribute types

Returns:

all OrderGroupAttributeTypes

Throws:

APIException

getOrderGroupAttributeType

@Authorized(value="Get Orders")
OrderGroupAttributeType getOrderGroupAttributeType(Integer orderGroupAttributeTypeId)
                                                                            throws APIException

Fetches order group attribute type using provided Id

Parameters:

id - The Id of the order group attribute type to fetch from the database

Returns:

the OrderGroupAttributeType with the given internal id

Throws:

APIException

getOrderGroupAttributeTypeByUuid

OrderGroupAttributeType getOrderGroupAttributeTypeByUuid(String uuid)
                                                  throws APIException

Fetches order group attribute type using provided uuid

Parameters:

uuid - The uuid of the order group attribute type to fetch from the database

Returns:

the OrderGroupAttributeType with the given uuid

Throws:

APIException

saveOrderGroupAttributeType

@Authorized(value={"Edit Orders","Add Orders"})
OrderGroupAttributeType saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                                                             throws APIException

Creates or updates the given order group attribute type in the database

Parameters:

orderGroupAttributeType - The order group attribute type to save in the database

Returns:

the order group attribute type created or saved

Throws:

APIException

retireOrderGroupAttributeType

@Authorized(value="Manage Order Types")
OrderGroupAttributeType retireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType,
                                                                                              String reason)
                                                                                       throws APIException

Retires the given order group attribute type in the database

Parameters:

orderGroupAttributeType - The order group attribute type to retire

reason - The reason why the order group attribute type is being retired

Returns:

the order group attribute type retired

Throws:

APIException

unretireOrderGroupAttributeType

@Authorized(value="Manage Order Types")
OrderGroupAttributeType unretireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                                                         throws APIException

Restores an order group attribute type that was previously retired in the database

Parameters:

orderGroupAttributeType - The order group attribute type to unretire

Returns:

the order group attribute type unretired

Throws:

APIException

purgeOrderGroupAttributeType

@Authorized(value="Purge Orders")
void purgeOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                             throws APIException

Completely removes an order group attribute type from the database

Parameters:

orderGroupAttributeType - The order group attribute type to purge

Throws:

APIException

getOrderGroupAttributeTypeByName

@Authorized(value="Get Orders")
OrderGroupAttributeType getOrderGroupAttributeTypeByName(String orderGroupAttributeTypeName)
                                                                                  throws APIException

Retrieves an order group attribute type object based on the name provided

Parameters:

orderGroupAttributeTypeName - The name of the order group attribute type to fetch

Returns:

the OrderGroupAttributeType with the specified name

Throws:

APIException

getOrderGroupAttributeByUuid

@Authorized(value="Get Orders")
OrderGroupAttribute getOrderGroupAttributeByUuid(String uuid)
                                                                          throws APIException

Fetches a given order group attribute using the provided uuid

Parameters:

uuid - The uuid of the order group attribute to fetch

Returns:

the OrderGroupAttribute with the given uuid

Throws:

APIException

Since:

2.4.0

getAllOrderAttributeTypes

@Authorized(value="Get Orders")
List<OrderAttributeType> getAllOrderAttributeTypes()
                                                                            throws APIException

Returns all order attribute types

Returns:

all OrderAttributeTypes

Throws:

APIException

Since:

2.5.0

getOrderAttributeTypeById

@Authorized(value="Get Orders")
OrderAttributeType getOrderAttributeTypeById(Integer orderAttributeTypeId)
                                                                      throws APIException

Fetches order attribute type using provided Id

Parameters:

id - The Id of the order attribute type to fetch from the database

Returns:

the OrderAttributeType with the given internal id

Throws:

APIException

Since:

2.5.0

getOrderAttributeTypeByUuid

OrderAttributeType getOrderAttributeTypeByUuid(String uuid)
                                        throws APIException

Fetches order attribute type using provided uuid

Parameters:

uuid - The uuid of the order attribute type to fetch from the database

Returns:

the OrderAttributeType with the given uuid

Throws:

APIException

Since:

2.5.0

saveOrderAttributeType

@Authorized(value={"Edit Orders","Add Orders"})
OrderAttributeType saveOrderAttributeType(OrderAttributeType orderAttributeType)
                                                                                   throws APIException

Creates or updates the given order attribute type in the database

Parameters:

orderAttributeType - The order attribute type to save in the database

Returns:

the order attribute type created or saved

Throws:

APIException

Since:

2.5.0

retireOrderAttributeType

@Authorized(value="Manage Order Types")
OrderAttributeType retireOrderAttributeType(OrderAttributeType orderAttributeType,
                                                                                    String reason)
                                                                             throws APIException

Retires the given order attribute type in the database

Parameters:

orderAttributeType - The order attribute type to retire

reason - The reason why the order attribute type is being retired

Returns:

the order attribute type retired

Throws:

APIException

Since:

2.5.0

unretireOrderAttributeType

@Authorized(value="Manage Order Types")
OrderAttributeType unretireOrderAttributeType(OrderAttributeType orderAttributeType)
                                                                               throws APIException

Restores an order attribute type that was previously retired in the database

Parameters:

orderAttributeType - The order attribute type to unretire

Returns:

the order attribute type unretired

Throws:

APIException

Since:

2.5.0

purgeOrderAttributeType

@Authorized(value="Purge Orders")
void purgeOrderAttributeType(OrderAttributeType orderAttributeType)
                                                        throws APIException

Completely removes an order attribute type from the database

Parameters:

orderAttributeType - The order attribute type to purge

Throws:

APIException

Since:

2.5.0

getOrderAttributeTypeByName

@Authorized(value="Get Orders")
OrderAttributeType getOrderAttributeTypeByName(String orderAttributeTypeName)
                                                                        throws APIException

Retrieves an order attribute type object based on the name provided

Parameters:

orderAttributeTypeName - The name of the order attribute type to fetch

Returns:

the OrderAttributeType with the specified name

Throws:

APIException

Since:

2.5.0

getOrderAttributeByUuid

@Authorized(value="Get Orders")
OrderAttribute getOrderAttributeByUuid(String uuid)
                                                                throws APIException

Fetches a given order attribute using the provided uuid

Parameters:

uuid - The uuid of the order attribute to fetch

Returns:

the OrderAttribute with the given uuid

Throws:

APIException

Since:

2.5.0

getActiveOrders

@Authorized(value="Get Orders")
List<Order> getActiveOrders(Patient patient,
                                                            Visit visit,
                                                            OrderType orderType,
                                                            CareSetting careSetting,
                                                            Date asOfDate)

Parameters:

visit - the Visit to restrict active orders (optional)

Since:

2.7.0

See Also:

This method works exactly the same; it only adds visit to the search criteria. It effectively surpasses the above method; the old one is however kept for backward compatibility reasons.

getOrders

@Authorized(value="Get Orders")
List<Order> getOrders(Patient patient,
                                                      Visit visit,
                                                      CareSetting careSetting,
                                                      OrderType orderType,
                                                      boolean includeVoided)

Parameters:

visit - the Visit to restrict orders (optional)

Since:

2.7.0

See Also:

This method works exactly the same; it only adds visit to the search criteria. It effectively surpasses the above method; the old one is however kept for backward compatibility reasons.