ConceptService (OpenMRS 1.10.7-SNAPSHOT API)

All Superinterfaces:: OpenmrsService

All Known Implementing Classes:: ConceptServiceImpl

@Transactional
public interface ConceptService
extends OpenmrsService

Contains methods pertaining to creating/updating/deleting/retiring Concepts, Drugs, Concept Proposals, and all other things 'Concept'.

To get a list of concepts:

 
 List<Concept> concepts = Context.getConceptService().getAllConcepts();

To get a single concept:

 
 // if there is a concept row in the database with concept_id = 3845
 Concept concept = Context.getConceptService().getConcept(3845);
 
 String name = concept.getPreferredName(Context.getLocale()).getName();

To save a concept to the database

   Concept concept = new Concept();
   concept.setConceptClass(Context.getConceptService().getConceptClass(3));
   concept.setDatatype(Context.getConceptService().getConceptDatatype(17));
   concept.setName...
   ... // and other required values on the concept
   Context.getConceptService().saveConcept(concept);

See Also:: Context

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkIfLocked()` Check if the concepts are locked and if so, throw exception during manipulation of concept
`java.util.Iterator<Concept>`	`conceptIterator()` Returns an iterator for all concepts, including retired and expired.
`void`	`convertBooleanConceptToCoded(Concept conceptToChange)` Changes the datatype of a concept from boolean to coded when it has observations it is associated to.
`void`	`createConcept(Concept concept)` Deprecated. use #saveConcept(Concept)
`void`	`createConcept(ConceptNumeric concept)` Deprecated. use #saveConcept(Concept)
`void`	`createDrug(Drug drug)` Deprecated. use #saveDrug(Drug)
`void`	`deleteConcept(Concept concept)` Deprecated. use #purgeConcept(Concept concept)
`void`	`deleteConceptStopWord(java.lang.Integer conceptStopWordId)` Delete the given `ConceptStopWord` in the database
`java.util.List<ConceptSearchResult>`	`findConceptAnswers(java.lang.String phrase, java.util.Locale locale, Concept concept)` Finds concepts that are possible value coded answers to concept parameter
`java.util.List<ConceptWord>`	`findConceptAnswers(java.lang.String phrase, java.util.Locale locale, Concept concept, boolean includeRetired)` Deprecated. use `findConceptAnswers(String, Locale, Concept)`
`java.util.List<ConceptWord>`	`findConcepts(java.lang.String phrase, java.util.List<java.util.Locale> searchLocales, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes)` Deprecated. use `getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)`
`java.util.List<ConceptWord>`	`findConcepts(java.lang.String phrase, java.util.Locale locale, boolean includeRetired)` Deprecated. use `getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)`
`java.util.List<ConceptWord>`	`findConcepts(java.lang.String phrase, java.util.Locale locale, boolean includeRetired, int start, int size)` Deprecated. Use `getConceptWords(String, List, boolean, List, List, List, List, Concept, Integer, Integer)`
`java.util.List<ConceptWord>`	`findConcepts(java.lang.String phrase, java.util.Locale locale, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes)` Deprecated. use `getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)`
`java.util.List<Drug>`	`findDrugs(java.lang.String phrase, boolean includeVoided)` Deprecated. Use `getDrugs(String)`
`java.util.List<ConceptProposal>`	`findMatchingConceptProposals(java.lang.String text)` Deprecated. use `getConceptProposals(String)`
`java.util.List<Concept>`	`findProposedConcepts(java.lang.String text)` Deprecated. Use `getProposedConcepts(String)`
`java.util.List<ConceptMapType>`	`getActiveConceptMapTypes()` Returns a list of concept map types currently in the database excluding hidden ones
`java.util.List<ConceptClass>`	`getAllConceptClasses()` Return a list of concept classes currently in the database
`java.util.List<ConceptClass>`	`getAllConceptClasses(boolean includeRetired)` Return a list of concept classes currently in the database
`java.util.List<ConceptDatatype>`	`getAllConceptDatatypes()` Return a list of all concept datatypes currently in the database
`java.util.List<ConceptDatatype>`	`getAllConceptDatatypes(boolean includeRetired)` Return a list of concept datatypes currently in the database
`java.util.List<ConceptNameTag>`	`getAllConceptNameTags()` Get all the concept name tags defined in the database, included voided ones
`java.util.List<ConceptProposal>`	`getAllConceptProposals(boolean includeCompleted)` Get a List of all concept proposals
`java.util.List<ConceptReferenceTerm>`	`getAllConceptReferenceTerms()` Gets a list of all concept reference terms saved in the database
`java.util.List<Concept>`	`getAllConcepts()` Return a list of unretired concepts sorted by concept id ascending and
`java.util.List<Concept>`	`getAllConcepts(java.lang.String sortBy, boolean asc, boolean includeRetired)` Return a list of concepts sorted on sortBy in dir direction (asc/desc)
`java.util.List<ConceptSource>`	`getAllConceptSources()` Return a list of concept sources currently in the database that are not voided
`java.util.List<ConceptStopWord>`	`getAllConceptStopWords()` Get all the concept stop words
`java.util.List<Drug>`	`getAllDrugs()` Return a list of drugs currently in the database that are not retired
`java.util.List<Drug>`	`getAllDrugs(boolean includeRetired)` Get drugs by concept.
`Concept`	`getConcept(java.lang.Integer conceptId)` Gets the concept with the given id
`Concept`	`getConcept(java.lang.String conceptIdOrName)` Get Concept by id or name convenience method
`ConceptAnswer`	`getConceptAnswer(java.lang.Integer conceptAnswerId)` Gets the ConceptAnswer with the given id
`ConceptAnswer`	`getConceptAnswerByUuid(java.lang.String uuid)` Get ConceptAnswer by its UUID
`java.util.List<ConceptWord>`	`getConceptAnswers(java.lang.String phrase, java.util.Locale locale, Concept concept)` Deprecated. use `findConceptAnswers(String, Locale, Concept)`
`Concept`	`getConceptByIdOrName(java.lang.String idOrName)` Deprecated. use `getConcept(String)`
`Concept`	`getConceptByMapping(java.lang.String code, java.lang.String sourceName)` Looks up a concept via `ConceptMap` This will return the `Concept` which contains a `ConceptMap` entry whose `sourceCode` is equal to the passed `conceptCode` and whose `ConceptSource` has either a `name` or `hl7Code` that is equal to the passed `mappingCode`.
`Concept`	`getConceptByMapping(java.lang.String code, java.lang.String sourceName, java.lang.Boolean includeRetired)` Looks up a concept via `ConceptMap` This will return the `Concept` which contains a `ConceptMap` entry whose `sourceCode` is equal to the passed `conceptCode` and whose `ConceptSource` has either a `name` or `hl7Code` that is equal to the passed `mappingCode` .
`Concept`	`getConceptByName(java.lang.String name)` Return a Concept that matches the name exactly
`Concept`	`getConceptByUuid(java.lang.String uuid)` Get Concept by its UUID
`ConceptClass`	`getConceptClass(java.lang.Integer conceptClassId)` Return a Concept class matching the given identifier
`ConceptClass`	`getConceptClassByName(java.lang.String name)` Return a Concept class matching the given name
`ConceptClass`	`getConceptClassByUuid(java.lang.String uuid)` Get ConceptClass by its UUID
`java.util.List<ConceptClass>`	`getConceptClasses()` Deprecated. use `getAllConceptClasses(boolean)`
`ConceptComplex`	`getConceptComplex(java.lang.Integer conceptId)` Get a ComplexConcept with the given conceptId
`ConceptDatatype`	`getConceptDatatype(java.lang.Integer i)` Return a ConceptDatatype matching the given identifier
`ConceptDatatype`	`getConceptDatatypeByName(java.lang.String name)` Return a Concept datatype matching the given name
`ConceptDatatype`	`getConceptDatatypeByUuid(java.lang.String uuid)` Get ConceptDatatype by its UUID
`java.util.List<ConceptDatatype>`	`getConceptDatatypes(java.lang.String name)` Deprecated. you probably want to use `getConceptDatatypeByName(String)`
`ConceptDescription`	`getConceptDescriptionByUuid(java.lang.String uuid)` Get ConceptDescription by its UUID
`java.util.List<ConceptMap>`	`getConceptMappingsToSource(ConceptSource conceptSource)` Returns a list of mappings from concepts to terms in the given reference terminology
`ConceptMapType`	`getConceptMapType(java.lang.Integer conceptMapTypeId)` Return a concept map type matching the given concept map type id
`ConceptMapType`	`getConceptMapTypeByName(java.lang.String name)` Return a concept map type matching the given name
`ConceptMapType`	`getConceptMapTypeByUuid(java.lang.String uuid)` Return a concept map type matching the given uuid
`java.util.List<ConceptMapType>`	`getConceptMapTypes(boolean includeRetired, boolean includeHidden)` Returns a list of concept map types currently in the database including or excluding retired and hidden ones as specified by the includeRetired and includeHidden arguments
`ConceptName`	`getConceptName(java.lang.Integer conceptNameId)` Gets the concept-name with the given id
`ConceptName`	`getConceptNameByUuid(java.lang.String uuid)` Get ConceptName by its UUID
`ConceptNameTag`	`getConceptNameTag(java.lang.Integer id)` Gets the `ConceptNameTag` with the given database primary key
`ConceptNameTag`	`getConceptNameTagByName(java.lang.String tag)` Search for a ConceptNameTag by name
`ConceptNameTag`	`getConceptNameTagByUuid(java.lang.String uuid)` Get ConceptNameTag by its UUID
`ConceptNumeric`	`getConceptNumeric(java.lang.Integer conceptId)` Get the ConceptNumeric with the given id
`ConceptNumeric`	`getConceptNumericByUuid(java.lang.String uuid)` Get ConceptNumeric by its UUID
`ConceptProposal`	`getConceptProposal(java.lang.Integer conceptProposalId)` Get a ConceptProposal by conceptProposalId
`ConceptProposal`	`getConceptProposalByUuid(java.lang.String uuid)` Get ConceptProposal by its UUID
`java.util.List<ConceptProposal>`	`getConceptProposals(boolean includeCompleted)` Deprecated. use `getAllConceptProposals(boolean)`
`java.util.List<ConceptProposal>`	`getConceptProposals(java.lang.String text)` Find matching concept proposals
`ConceptReferenceTerm`	`getConceptReferenceTerm(java.lang.Integer conceptReferenceTermId)` Gets the concept reference term with the specified concept reference term id
`ConceptReferenceTerm`	`getConceptReferenceTermByCode(java.lang.String code, ConceptSource conceptSource)` Gets a concept reference term with the specified code from the specified concept source
`ConceptReferenceTerm`	`getConceptReferenceTermByName(java.lang.String name, ConceptSource conceptSource)` Gets a concept reference term with the specified name from the specified concept source ignoring all retired ones
`ConceptReferenceTerm`	`getConceptReferenceTermByUuid(java.lang.String uuid)` Gets the concept reference term with the specified uuid
`java.util.List<ConceptReferenceTerm>`	`getConceptReferenceTerms(boolean includeRetired)` Gets a list of concept reference terms saved in the database
`java.util.List<ConceptReferenceTerm>`	`getConceptReferenceTerms(java.lang.String query, ConceptSource conceptSource, java.lang.Integer start, java.lang.Integer length, boolean includeRetired)` Finds the concept reference term in the database that have a code or name that contains the specified search phrase.
`java.util.List<ConceptSearchResult>`	`getConcepts(java.lang.String phrase, java.util.List<java.util.Locale> locales, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, java.lang.Integer start, java.lang.Integer size)` Searches for concepts by the given parameters.
`java.util.List<ConceptSearchResult>`	`getConcepts(java.lang.String phrase, java.util.Locale locale, boolean includeRetired)` Searches for concepts with the given parameters
`java.util.List<Concept>`	`getConcepts(java.lang.String sortBy, java.lang.String dir)` Deprecated. use `getAllConcepts(String, boolean, boolean)`
`java.util.List<Concept>`	`getConceptsByAnswer(Concept concept)` Returns all possible Concepts to which this concept is a value-coded answer.
`java.util.List<Concept>`	`getConceptsByClass(ConceptClass cc)`
`java.util.List<Concept>`	`getConceptsByConceptSet(Concept concept)` Return a List of all concepts within a concept set
`java.util.List<ConceptMap>`	`getConceptsByConceptSource(ConceptSource conceptSource)` Deprecated. as of version 1.9, use `#getConceptMapsBySource(ConceptSource))`
`java.util.List<Concept>`	`getConceptsByMapping(java.lang.String code, java.lang.String sourceName)` Looks up a concept via `ConceptMap` This will return the list of concepts `Concept`s which contain a `ConceptMap` entry whose `sourceCode` is equal to the passed `conceptCode` and whose `ConceptSource` has either a `name` or `hl7Code` that is equal to the passed `mappingCode`
`java.util.List<Concept>`	`getConceptsByMapping(java.lang.String code, java.lang.String sourceName, boolean includeRetired)` Looks up a concept via `ConceptMap` This will return the list of `Concept`s which contain a `ConceptMap` entry whose `sourceCode` is equal to the passed `conceptCode` and whose `ConceptSource` has either a `name` or `hl7Code` that is equal to the passed `mappingCode`.
`java.util.List<Concept>`	`getConceptsByName(java.lang.String name)` Returns a list of concepts matching any part of a concept name, this method is case insensitive to the concept name string
`java.util.List<Concept>`	`getConceptsByName(java.lang.String name, java.util.Locale locale, java.lang.Boolean exactLocale)` Returns a list of concepts with the same name in the given locale.
`ConceptSet`	`getConceptSetByUuid(java.lang.String uuid)` Get ConceptSet by its UUID
`java.util.List<ConceptSet>`	`getConceptSets(Concept concept)` Deprecated. use `getConceptSetsByConcept(Concept)`
`java.util.List<ConceptSet>`	`getConceptSetsByConcept(Concept concept)` Return a list of the concept sets with concept_set matching concept
`java.util.List<Concept>`	`getConceptsInSet(Concept concept)` Deprecated. use `getConceptsByConceptSet(Concept)`
`ConceptSource`	`getConceptSource(java.lang.Integer i)` Return a Concept source matching the given concept source id
`ConceptSource`	`getConceptSourceByName(java.lang.String conceptSourceName)` Lookup a ConceptSource by its name property
`ConceptSource`	`getConceptSourceByUuid(java.lang.String uuid)` Get ConceptSource by its UUID
`java.util.List<java.lang.String>`	`getConceptStopWords(java.util.Locale locale)` Gets the list of `ConceptStopWord` for given locale
`java.util.List<Concept>`	`getConceptsWithDrugsInFormulary()` Convenience method for finding concepts associated with drugs in formulary.
`java.util.List<ConceptWord>`	`getConceptWords(java.lang.String phrase, java.util.List<java.util.Locale> locales, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, java.lang.Integer start, java.lang.Integer size)` Deprecated. use `getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)`
`java.util.List<ConceptWord>`	`getConceptWords(java.lang.String phrase, java.util.Locale locale)` Deprecated. use `#getConcepts(String, Locale)` that returns a list of ConceptSearchResults
`java.lang.Integer`	`getCountOfConceptReferenceTerms(java.lang.String query, ConceptSource conceptSource, boolean includeRetired)` Returns the count of concept reference terms that match the specified arguments
`java.lang.Integer`	`getCountOfConcepts(java.lang.String phrase, java.util.List<java.util.Locale> locales, boolean includeRetired, java.util.List<ConceptClass> requireClasses, java.util.List<ConceptClass> excludeClasses, java.util.List<ConceptDatatype> requireDatatypes, java.util.List<ConceptDatatype> excludeDatatypes, Concept answersToConcept)` Return the number of concepts matching a search phrase and the specified arguments
`java.lang.Integer`	`getCountOfDrugs(java.lang.String drugName, Concept concept, boolean searchOnPhrase, boolean searchDrugConceptNames, boolean includeRetired)` Return the number of drugs with matching names or concept drug names
`ConceptMapType`	`getDefaultConceptMapType()` Gets the concept map type to be used as the default.
`Drug`	`getDrug(java.lang.Integer drugId)` Get the Drug with the given id
`Drug`	`getDrug(java.lang.String drugNameOrId)` Return the drug object corresponding to the given name or drugId
`Drug`	`getDrugByMapping(java.lang.String code, ConceptSource conceptSource, java.util.Collection<ConceptMapType> withAnyOfTheseTypesOrOrderOfPreference)` Gets the "best" matching drug, i.e.
`Drug`	`getDrugByNameOrId(java.lang.String drugId)` Return the drug object corresponding to the given name or drugId
`Drug`	`getDrugByUuid(java.lang.String uuid)` Get Drug by its UUID
`DrugIngredient`	`getDrugIngredientByUuid(java.lang.String uuid)` Get Drug Ingredient by its UUID
`java.util.List<Drug>`	`getDrugs()` Deprecated. use `getAllDrugs()`
`java.util.List<Drug>`	`getDrugs(Concept concept)` Deprecated. Use `getDrugsByConcept(Concept)`
`java.util.List<Drug>`	`getDrugs(java.lang.String phrase)` Find drugs in the system.
`java.util.List<Drug>`	`getDrugs(java.lang.String drugName, Concept concept, boolean searchOnPhrase, boolean searchDrugConceptNames, boolean includeRetired, java.lang.Integer start, java.lang.Integer length)` Returns a list of drugs with matching names or concept drug names and returns a specific number of them from the specified starting position.
`java.util.List<Drug>`	`getDrugs(java.lang.String searchPhrase, java.util.Locale locale, boolean exactLocale, boolean includeRetired)` Fetches un retired drugs that match the specified search phrase.
`java.util.List<Drug>`	`getDrugsByConcept(Concept concept)` Return a list of drugs associated with the given concept
`java.util.List<Drug>`	`getDrugsByMapping(java.lang.String code, ConceptSource conceptSource, java.util.Collection<ConceptMapType> withAnyOfTheseTypes, boolean includeRetired)` Fetches all drugs with reference mappings to the specified concept source that match the specified code and concept map types
`Concept`	`getFalseConcept()` Returns the FALSE concept
`java.util.Set<java.util.Locale>`	`getLocalesOfConceptNames()` Gets the set of unique Locales used by existing concept names.
`java.lang.Integer`	`getMaxConceptId()` Gets the highest concept-id used by a concept.
`Concept`	`getNextConcept(Concept concept)` Finds the next concept in the dictionary that has the next largest concept id
`java.util.List<ConceptSearchResult>`	`getOrderableConcepts(java.lang.String phrase, java.util.List<java.util.Locale> locales, boolean includeRetired, java.lang.Integer start, java.lang.Integer length)` An Orderable concept is one where its conceptClass has a mapping in the order_type_class_map table.
`Concept`	`getPrevConcept(Concept concept)` Finds the previous concept in the dictionary that has the next lowest concept id
`java.util.List<Concept>`	`getProposedConcepts(java.lang.String text)` Find matching proposed concepts
`java.util.List<Concept>`	`getQuestionsForAnswer(Concept concept)` Deprecated. use #getConceptsByAnswer(Concept)
`java.util.List<ConceptReferenceTermMap>`	`getReferenceTermMappingsTo(ConceptReferenceTerm term)` Fetches all the `ConceptReferenceTermMap` where the specified reference term is the termB i.e mappings added to other terms pointing to it
`java.util.List<ConceptSet>`	`getSetsContainingConcept(Concept concept)` Find all sets that the given concept is a member of
`Concept`	`getTrueConcept()` Returns the TRUE concept
`boolean`	`hasAnyObservation(Concept concept)` Checks if there are any observations (including voided observations) for a concept.
`boolean`	`hasAnyObservation(ConceptName conceptName)` Checks if there are any observations (including voided observations) using a conceptName.
`Concept`	`mapConceptProposalToConcept(ConceptProposal cp, Concept mappedConcept)` Maps a concept proposal to a concept
`Concept`	`mapConceptProposalToConcept(ConceptProposal cp, Concept mappedConcept, java.util.Locale locale)` Maps a concept proposal to a concept
`void`	`proposeConcept(ConceptProposal conceptProposal)` Deprecated. use `saveConceptProposal(ConceptProposal)`
`void`	`purgeConcept(Concept conceptOrConceptNumeric)` Completely purge a `Concept` or `ConceptNumeric` from the database.
`void`	`purgeConceptClass(ConceptClass cc)` Purge a ConceptClass
`void`	`purgeConceptDatatype(ConceptDatatype cd)` Deprecated. as of 1.9 because users should never delete datatypes, it could harm data and other code expecting them to be here
`void`	`purgeConceptMapType(ConceptMapType conceptMapType)` Completely purges a concept map type from the database
`void`	`purgeConceptProposal(ConceptProposal cp)` Removes a concept proposal from the database entirely.
`void`	`purgeConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)` Purges the specified concept reference term from the database
`ConceptSource`	`purgeConceptSource(ConceptSource cs)` Delete ConceptSource
`void`	`purgeDrug(Drug drug)` Completely purge a Drug from the database.
`void`	`rejectConceptProposal(ConceptProposal cp)` Deprecated. use `ConceptProposal.rejectConceptProposal()`
`Concept`	`retireConcept(Concept conceptOrConceptNumeric, java.lang.String reason)` Retiring a concept essentially removes it from circulation
`ConceptMapType`	`retireConceptMapType(ConceptMapType conceptMapType, java.lang.String retireReason)` Retiring a concept map type essentially removes it from circulation
`ConceptReferenceTerm`	`retireConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm, java.lang.String retireReason)` Retiring a concept reference term essentially removes it from circulation
`ConceptSource`	`retireConceptSource(ConceptSource cs, java.lang.String reason)` This effectively removes a concept source from the database.
`Drug`	`retireDrug(Drug drug, java.lang.String reason)` Retiring a Drug essentially removes it from circulation
`Concept`	`saveConcept(Concept concept)` Save or update the given `Concept` or `ConceptNumeric` in the database
`ConceptClass`	`saveConceptClass(ConceptClass cc)` Creates or updates a concept class
`ConceptDatatype`	`saveConceptDatatype(ConceptDatatype cd)` Deprecated. as of 1.9 because users should never change datatypes, it could harm data and other code expecting them to be here
`ConceptMapType`	`saveConceptMapType(ConceptMapType conceptMapType)` Saves or updates the specified concept map type in the database
`ConceptNameTag`	`saveConceptNameTag(ConceptNameTag nameTag)` Creates a new Concept name tag if none exists.
`ConceptProposal`	`saveConceptProposal(ConceptProposal conceptProposal)` Saves/updates/proposes a concept proposal
`ConceptReferenceTerm`	`saveConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)` Stores the specified concept reference term to the database
`ConceptSource`	`saveConceptSource(ConceptSource conceptSource)` Create a new ConceptSource
`ConceptStopWord`	`saveConceptStopWord(ConceptStopWord conceptStopWord)` Save the given `ConceptStopWord` in the database
`Drug`	`saveDrug(Drug drug)` Save or update the given `Drug` in the database.
`void`	`setConceptDAO(ConceptDAO dao)` Sets the data access object for Concepts.
`ConceptMapType`	`unretireConceptMapType(ConceptMapType conceptMapType)` Marks a concept map type that is currently retired as not retired.
`ConceptReferenceTerm`	`unretireConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)` Marks a concept reference term that is currently retired as not retired.
`Drug`	`unretireDrug(Drug drug)` Marks a drug that is currently retired as not retired.
`void`	`updateConcept(Concept concept)` Deprecated. use #saveConcept(Concept)
`void`	`updateConcept(ConceptNumeric concept)` Deprecated. use #saveConcept(Concept)
`void`	`updateConceptIndex(Concept concept)` Iterates over the words in names and synonyms (for each locale) and updates the concept index, note that this only updates the index of the specified concept.
`void`	`updateConceptIndexes()` Iterates over all concepts and calls upddateConceptIndexes(Concept concept)
`void`	`updateConceptIndexes(java.lang.Integer conceptIdStart, java.lang.Integer conceptIdEnd)` Iterates over all concepts with conceptIds between `conceptIdStart` and `conceptIdEnd` (inclusive) and calls updateConceptIndexes(concept)
`void`	`updateConceptSetDerived()` Iterates over all concepts calling updateConceptSetDerived(concept)
`void`	`updateConceptSetDerived(Concept concept)` Updates the concept set derived business table for this concept (bursting the concept sets)
`void`	`updateConceptWord(Concept concept)` Deprecated. use `updateConceptWord(Concept)`
`void`	`updateConceptWords()` Deprecated. use `updateConceptWords()`
`void`	`updateConceptWords(java.lang.Integer conceptIdStart, java.lang.Integer conceptIdEnd)` Deprecated. use `updateConceptIndexes(Integer, Integer)`
`void`	`updateDrug(Drug drug)` Deprecated. use #saveDrug(Drug)
`void`	`voidConcept(Concept concept, java.lang.String reason)` Deprecated. use `retireConcept(Concept, String)`

Methods inherited from interface org.openmrs.api.OpenmrsService
onShutdown, onStartup

Method Detail

setConceptDAO
```
void setConceptDAO(ConceptDAO dao)
```
Sets the data access object for Concepts. The dao is used for saving and getting concepts to/from the database

Parameters:

dao - The data access object to use

createConcept

@Deprecated
 @Authorized(value="Manage Concepts")
void createConcept(Concept concept)
                                                              throws APIException

Deprecated. use #saveConcept(Concept)

Throws:: APIException

createConcept

@Deprecated
 @Authorized(value="Manage Concepts")
void createConcept(ConceptNumeric concept)
                                                              throws APIException

Deprecated. use #saveConcept(Concept)

Throws:: APIException

updateConcept

@Deprecated
 @Authorized(value="Manage Concepts")
void updateConcept(Concept concept)
                                                              throws APIException

Deprecated. use #saveConcept(Concept)

Throws:: APIException

getConceptByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConceptByUuid(java.lang.String uuid)

Get Concept by its UUID

Parameters:: uuid -
Returns:

updateConcept

@Deprecated
 @Authorized(value="Manage Concepts")
void updateConcept(ConceptNumeric concept)
                                                              throws APIException

Deprecated. use #saveConcept(Concept)

Throws:: APIException

createDrug

@Deprecated
 @Authorized(value="Manage Concepts")
void createDrug(Drug drug)
                                                           throws APIException

Deprecated. use #saveDrug(Drug)

Throws:: APIException

updateDrug

@Deprecated
 @Authorized(value="Manage Concepts")
void updateDrug(Drug drug)
                                                           throws APIException

Deprecated. use #saveDrug(Drug)

Throws:: APIException

deleteConcept

@Deprecated
 @Authorized(value="Purge Concepts")
void deleteConcept(Concept concept)
                                                             throws APIException

Deprecated. use #purgeConcept(Concept concept)

Throws:: APIException

voidConcept

@Deprecated
 @Authorized(value="Manage Concepts")
void voidConcept(Concept concept,
                                                                   java.lang.String reason)
                                                            throws APIException

Deprecated. use retireConcept(Concept, String)

Throws:: APIException

saveConcept
```
@Authorized(value="Manage Concepts")
Concept saveConcept(Concept concept)
                                                  throws APIException
```
Save or update the given Concept or ConceptNumeric in the database
If this is a new concept, the returned concept will have a new Concept.getConceptId() inserted into it that was generated by the database

Parameters:

concept - The Concept or ConceptNumeric to save or update

Returns:

the Concept or ConceptNumeric that was saved or updated

Throws:

APIException

ConceptsLockedException

ConceptInUseException

saveDrug
```
@Authorized(value="Manage Concepts")
Drug saveDrug(Drug drug)
                                            throws APIException
```
Save or update the given Drug in the database. If this is a new drug, the returned drug object will have a new Drug.getDrugId() inserted into it that was generated by the database

Parameters:

drug - The Drug to save or update

Returns:

the Drug that was saved or updated

Throws:

APIException

purgeConcept
```
@Authorized(value="Purge Concepts")
void purgeConcept(Concept conceptOrConceptNumeric)
                                               throws APIException
```
Completely purge a Concept or ConceptNumeric from the database. This should not typically be used unless desperately needed. Most should just be retired. See retireConcept(Concept, String)

Parameters:

conceptOrConceptNumeric - The Concept or ConceptNumeric to remove from the system

Throws:

APIException

retireConcept

@Authorized(value="Manage Concepts")
Concept retireConcept(Concept conceptOrConceptNumeric,
                                                           java.lang.String reason)
                                                    throws APIException

Retiring a concept essentially removes it from circulation

Parameters:: conceptOrConceptNumeric - The Concept or ConceptNumeric to retire; reason - The retire reason
Returns:: the retired Concept or ConceptNumeric
Throws:: APIException

retireDrug

@Authorized(value="Manage Concepts")
Drug retireDrug(Drug drug,
                                                     java.lang.String reason)
                                              throws APIException

Retiring a Drug essentially removes it from circulation

Parameters:: drug - The Drug to retire; reason - The retire reason
Returns:: the retired Drug
Throws:: APIException

unretireDrug
```
@Authorized(value="Manage Concepts")
Drug unretireDrug(Drug drug)
                                                throws APIException
```
Marks a drug that is currently retired as not retired.

Parameters:

drug - that is current set as retired

Returns:

the given drug, marked as not retired now, and saved to the db

Throws:

APIException

purgeDrug
```
@Authorized(value="Purge Concepts")
void purgeDrug(Drug drug)
                                            throws APIException
```
Completely purge a Drug from the database. This should not typically be used unless desperately needed. Most Drugs should just be retired.

Parameters:

drug - The Drug to remove from the system

Throws:

APIException

getConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConcept(java.lang.Integer conceptId)
                                                                              throws APIException

Gets the concept with the given id

Parameters:: conceptId -
Returns:: the matching Concept object
Throws:: APIException

getConceptName

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptName getConceptName(java.lang.Integer conceptNameId)
                                                                                      throws APIException

Gets the concept-name with the given id

Parameters:: conceptNameId -
Returns:: the matching Concept object
Throws:: APIException

getConceptAnswer

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptAnswer getConceptAnswer(java.lang.Integer conceptAnswerId)
                                                                                          throws APIException

Gets the ConceptAnswer with the given id

Parameters:: conceptAnswerId -
Returns:: the matching ConceptAnswer object
Throws:: APIException

getDrug

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Drug getDrug(java.lang.Integer drugId)
                                                                        throws APIException

Get the Drug with the given id

Parameters:: drugId -
Returns:: the matching Drug object
Throws:: APIException

getConceptNumeric

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptNumeric getConceptNumeric(java.lang.Integer conceptId)
                                                                                            throws APIException

Get the ConceptNumeric with the given id

Parameters:: conceptId - The ConceptNumeric id
Returns:: the matching ConceptNumeric object
Throws:: APIException

getConceptClass

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptClass getConceptClass(java.lang.Integer conceptClassId)
                                                                                        throws APIException

Return a Concept class matching the given identifier

Parameters:: conceptClassId - the concept class identifier
Returns:: the matching ConceptClass
Throws:: APIException

getAllConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getAllConcepts()
                                                                                                  throws APIException

Return a list of unretired concepts sorted by concept id ascending and

Returns:: a List object containing all of the sorted concepts
Throws:: APIException

getAllConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getAllConcepts(java.lang.String sortBy,
                                                                                                         boolean asc,
                                                                                                         boolean includeRetired)
                                                                                                  throws APIException

Return a list of concepts sorted on sortBy in dir direction (asc/desc)

Parameters:: sortBy - The property name to sort by; if null or invalid, concept_id is used.; asc - true = sort ascending; false = sort descending; includeRetired - If true, retired concepts will also be returned
Returns:: a List object containing all of the sorted concepts
Throws:: APIException

getConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConcepts(java.lang.String sortBy,
                                                                                                                   java.lang.String dir)
                                                                                                            throws APIException

Deprecated. use getAllConcepts(String, boolean, boolean)

Throws:: APIException

getConceptsByName

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByName(java.lang.String name)
                                                                                                     throws APIException

Returns a list of concepts matching any part of a concept name, this method is case insensitive to the concept name string

Parameters:: name - The search string
Returns:: a List object containing all of the matching concepts
Throws:: APIException

getConceptByName

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConceptByName(java.lang.String name)
                                                                                    throws APIException

Return a Concept that matches the name exactly

Parameters:: name - The search string
Returns:: the found Concept
Throws:: APIException

getConceptByIdOrName

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConceptByIdOrName(java.lang.String idOrName)
                                                                                                     throws APIException

Deprecated. use getConcept(String)

Get Concepts by id or name

Note: this just calls other impl methods; no DAO of its own

Parameters:: idOrName -
Returns:: the found Concept
Throws:: APIException

getConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConcept(java.lang.String conceptIdOrName)
                                                                              throws APIException

Get Concept by id or name convenience method

Parameters:: conceptIdOrName -
Returns:: the found Concept
Throws:: APIException

getConceptWords

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> getConceptWords(java.lang.String phrase,
                                                                                                                           java.util.List<java.util.Locale> locales,
                                                                                                                           boolean includeRetired,
                                                                                                                           java.util.List<ConceptClass> requireClasses,
                                                                                                                           java.util.List<ConceptClass> excludeClasses,
                                                                                                                           java.util.List<ConceptDatatype> requireDatatypes,
                                                                                                                           java.util.List<ConceptDatatype> excludeDatatypes,
                                                                                                                           Concept answersToConcept,
                                                                                                                           java.lang.Integer start,
                                                                                                                           java.lang.Integer size)
                                                                                                                    throws APIException

Deprecated. use getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

Throws:: APIException

getConceptWords

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> getConceptWords(java.lang.String phrase,
                                                                                                                           java.util.Locale locale)
                                                                                                                    throws APIException

Deprecated. use #getConcepts(String, Locale) that returns a list of ConceptSearchResults

Throws:: APIException

findConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> findConcepts(java.lang.String phrase,
                                                                                                                        java.util.Locale locale,
                                                                                                                        boolean includeRetired)
                                                                                                                 throws APIException

Deprecated. use getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

Throws:: APIException

findConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> findConcepts(java.lang.String phrase,
                                                                                                                        java.util.Locale locale,
                                                                                                                        boolean includeRetired,
                                                                                                                        java.util.List<ConceptClass> requireClasses,
                                                                                                                        java.util.List<ConceptClass> excludeClasses,
                                                                                                                        java.util.List<ConceptDatatype> requireDatatypes,
                                                                                                                        java.util.List<ConceptDatatype> excludeDatatypes)
                                                                                                                 throws APIException

Deprecated. use getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

Throws:: APIException

getDrugByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Drug getDrugByUuid(java.lang.String uuid)

Get Drug by its UUID

Parameters:: uuid -
Returns:

getDrugIngredientByUuid
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
DrugIngredient getDrugIngredientByUuid(java.lang.String uuid)
```
Get Drug Ingredient by its UUID

Parameters:

uuid - the uuid for the drug ingredient to get

Returns:

the drug ingredient if found, else null

findConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> findConcepts(java.lang.String phrase,
                                                                                                                        java.util.Locale locale,
                                                                                                                        boolean includeRetired,
                                                                                                                        int start,
                                                                                                                        int size)
                                                                                                                 throws APIException

Deprecated. Use getConceptWords(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

Throws:: APIException

getDrug

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Drug getDrug(java.lang.String drugNameOrId)
                                                                        throws APIException

Return the drug object corresponding to the given name or drugId

Parameters:: drugNameOrId - String name or drugId to match exactly on
Returns:: matching Drug object
Throws:: APIException

getDrugByNameOrId

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Drug getDrugByNameOrId(java.lang.String drugId)
                                                                                  throws APIException

Return the drug object corresponding to the given name or drugId

Parameters:: drugId - String
Returns:: matching Drug object
Throws:: APIException

getDrugs

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugs()
                                                                                                      throws APIException

Deprecated. use getAllDrugs()

Throws:: APIException

getAllDrugs

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getAllDrugs()
                                                                                            throws APIException

Return a list of drugs currently in the database that are not retired

Returns:: a List object containing all drugs
Throws:: APIException

getDrugs

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugs(Concept concept)
                                                                                                      throws APIException

Deprecated. Use getDrugsByConcept(Concept)

Throws:: APIException

getDrugsByConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugsByConcept(Concept concept)
                                                                                                  throws APIException

Return a list of drugs associated with the given concept

Parameters:: concept -
Returns:: a List object containing all matching drugs
Throws:: APIException

getAllDrugs
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getAllDrugs(boolean includeRetired)
```
Get drugs by concept. This method is the utility method that should be used to generically retrieve all Drugs in the system.

Parameters:

includeRetired - If true then the search will include voided Drugs

Returns:

A List object containing all matching Drugs

findDrugs

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> findDrugs(java.lang.String phrase,
                                                                                                              boolean includeVoided)
                                                                                                       throws APIException

Deprecated. Use getDrugs(String)

Throws:: APIException

getDrugs
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugs(java.lang.String phrase)
                                                                                         throws APIException
```
Find drugs in the system. The string search can match either drug.name or drug.concept.name, drug.drugId or drug.concept.conceptId

Parameters:

phrase - Search phrase

Returns:

A List object containing all Drug matches

Throws:

APIException

getConceptsByClass

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByClass(ConceptClass cc)
                                                                                                      throws APIException

Parameters:: cc - ConceptClass
Returns:: Returns all concepts in a given class
Throws:: APIException

getConceptClasses

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concept Classes")
java.util.List<ConceptClass> getConceptClasses()
                                                                                                                              throws APIException

Deprecated. use getAllConceptClasses(boolean)

Return a list of concept classes currently in the database

Returns:: List object with all ConceptClass objects
Throws:: APIException

getConceptClassByName

@Transactional(readOnly=true)
 @Authorized(value="View Concept Classes")
ConceptClass getConceptClassByName(java.lang.String name)
                                                                                                     throws APIException

Return a Concept class matching the given name

Parameters:: name -
Returns:: ConceptClass matching the given name
Throws:: APIException

getAllConceptClasses

@Transactional(readOnly=true)
 @Authorized(value="View Concept Classes")
java.util.List<ConceptClass> getAllConceptClasses()
                                                                                                                    throws APIException

Return a list of concept classes currently in the database

Returns:: List object with all ConceptClass objects
Throws:: APIException

getAllConceptClasses

@Transactional(readOnly=true)
 @Authorized(value="View Concept Classes")
java.util.List<ConceptClass> getAllConceptClasses(boolean includeRetired)
                                                                                                                    throws APIException

Return a list of concept classes currently in the database

Parameters:: includeRetired - include retired concept classes in the search results?
Returns:: List object with all ConceptClass objects
Throws:: APIException

getConceptClassByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Classes")
ConceptClass getConceptClassByUuid(java.lang.String uuid)

Get ConceptClass by its UUID

Parameters:: uuid -
Returns:

getConceptAnswerByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptAnswer getConceptAnswerByUuid(java.lang.String uuid)

Get ConceptAnswer by its UUID

Parameters:: uuid -
Returns:

getConceptNameByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptName getConceptNameByUuid(java.lang.String uuid)

Get ConceptName by its UUID

Parameters:: uuid -
Returns:

getConceptSetByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptSet getConceptSetByUuid(java.lang.String uuid)

Get ConceptSet by its UUID

Parameters:: uuid -
Returns:

getConceptSourceByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Sources")
ConceptSource getConceptSourceByUuid(java.lang.String uuid)

Get ConceptSource by its UUID

Parameters:: uuid -
Returns:

saveConceptClass

@Authorized(value="Manage Concept Classes")
ConceptClass saveConceptClass(ConceptClass cc)
                                                                   throws APIException

Creates or updates a concept class

Parameters:: cc - ConceptClass to create or update
Throws:: APIException

purgeConceptClass

@Authorized(value="Purge Concept Classes")
void purgeConceptClass(ConceptClass cc)
                                                           throws APIException

Purge a ConceptClass

Parameters:: cc - ConceptClass to delete
Throws:: APIException

saveConceptDatatype
```
@Authorized(value="Manage Concept Datatypes")
 @Deprecated
ConceptDatatype saveConceptDatatype(ConceptDatatype cd)
                                                                                        throws org.apache.commons.lang.NotImplementedException
```
Deprecated. as of 1.9 because users should never change datatypes, it could harm data and other code expecting them to be here

Create or update a ConceptDatatype

Parameters:

cd - ConceptDatatype to create or update

Throws:

org.apache.commons.lang.NotImplementedException

purgeConceptDatatype
```
@Authorized(value="Purge Concept Datatypes")
 @Deprecated
void purgeConceptDatatype(ConceptDatatype cd)
                                                                             throws org.apache.commons.lang.NotImplementedException
```
Deprecated. as of 1.9 because users should never delete datatypes, it could harm data and other code expecting them to be here

Purge a ConceptDatatype. This removes the concept datatype from the database completely.

Parameters:

cd - ConceptDatatype to purge

Throws:

org.apache.commons.lang.NotImplementedException

getAllConceptDatatypes

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
java.util.List<ConceptDatatype> getAllConceptDatatypes()
                                                                                                                           throws APIException

Return a list of all concept datatypes currently in the database

Returns:: List of ConceptDatatypes
Throws:: APIException

getAllConceptDatatypes

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
java.util.List<ConceptDatatype> getAllConceptDatatypes(boolean includeRetired)
                                                                                                                           throws APIException

Return a list of concept datatypes currently in the database

Parameters:: includeRetired - boolean - include the retired datatypes?
Returns:: List of ConceptDatatypes
Throws:: APIException

getConceptDatatypes

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
 @Deprecated
java.util.List<ConceptDatatype> getConceptDatatypes(java.lang.String name)
                                                                                                                                     throws APIException

Deprecated. you *probably* want to use getConceptDatatypeByName(String)

Find concept datatypes that contain the given name string

Parameters:: name -
Returns:: List object of ConceptDatatypes matching the string
Throws:: APIException

getConceptDatatype

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
ConceptDatatype getConceptDatatype(java.lang.Integer i)
                                                                                                       throws APIException

Return a ConceptDatatype matching the given identifier

Parameters:: i - Integer for the requested ConceptDatatype
Returns:: ConceptDatatype matching the given identifier
Throws:: APIException

getConceptDatatypeByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
ConceptDatatype getConceptDatatypeByUuid(java.lang.String uuid)

Get ConceptDatatype by its UUID

Parameters:: uuid -
Returns:

getConceptDatatypeByName

@Transactional(readOnly=true)
 @Authorized(value="View Concept Datatypes")
ConceptDatatype getConceptDatatypeByName(java.lang.String name)
                                                                                                             throws APIException

Return a Concept datatype matching the given name

Parameters:: name -
Returns:: ConceptDatatype matching the given name
Throws:: APIException

updateConceptSetDerived

@Authorized(value="Manage Concepts")
void updateConceptSetDerived(Concept concept)
                                                           throws APIException

Updates the concept set derived business table for this concept (bursting the concept sets)

Parameters:: concept -
Throws:: APIException

updateConceptSetDerived

@Authorized(value="Manage Concepts")
void updateConceptSetDerived()
                                                           throws APIException

Iterates over all concepts calling updateConceptSetDerived(concept)

Throws:: APIException

getConceptSets

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSet> getConceptSets(Concept concept)
                                                                                                                  throws APIException

Deprecated. use getConceptSetsByConcept(Concept)

Throws:: APIException

getConceptSetsByConcept
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSet> getConceptSetsByConcept(Concept concept)
                                                                                                              throws APIException
```
Return a list of the concept sets with concept_set matching concept
For example to find all concepts for ARVs, you would do getConceptSets(getConcept("ANTIRETROVIRAL MEDICATIONS")) and then take the conceptIds from the resulting list.

Parameters:

concept - The concept representing the concept set

Returns:

A List object containing all matching ConceptSets

Throws:

APIException

getConceptsInSet

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsInSet(Concept concept)
                                                                                                                 throws APIException

Deprecated. use getConceptsByConceptSet(Concept)

Throws:: APIException

getConceptsByConceptSet

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByConceptSet(Concept concept)
                                                                                                           throws APIException

Return a List of all concepts within a concept set

Parameters:: concept - The concept representing the concept set
Returns:: A List object containing all objects within the ConceptSet
Throws:: APIException

getSetsContainingConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSet> getSetsContainingConcept(Concept concept)
                                                                                                               throws APIException

Find all sets that the given concept is a member of

Parameters:: concept -
Returns:: A List object with all parent concept sets
Throws:: APIException

getConceptProposals

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
java.util.List<ConceptProposal> getConceptProposals(boolean includeCompleted)
                                                                                                                                     throws APIException

Deprecated. use getAllConceptProposals(boolean)

Throws:: APIException

getAllConceptProposals

@Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
java.util.List<ConceptProposal> getAllConceptProposals(boolean includeCompleted)
                                                                                                                           throws APIException

Get a List of all concept proposals

Parameters:: includeCompleted - boolean - include completed proposals as well?
Returns:: a List object of all found ConceptProposals
Throws:: APIException

getConceptNumericByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptNumeric getConceptNumericByUuid(java.lang.String uuid)

Get ConceptNumeric by its UUID

Parameters:: uuid -
Returns:

getConceptProposal

@Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
ConceptProposal getConceptProposal(java.lang.Integer conceptProposalId)
                                                                                                       throws APIException

Get a ConceptProposal by conceptProposalId

Parameters:: conceptProposalId - the Integer concept proposal Id
Returns:: the found ConceptProposal
Throws:: APIException

getConceptProposals

@Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
java.util.List<ConceptProposal> getConceptProposals(java.lang.String text)
                                                                                                                        throws APIException

Find matching concept proposals

Parameters:: text -
Returns:: a List object containing matching concept proposals
Throws:: APIException

findProposedConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
java.util.List<Concept> findProposedConcepts(java.lang.String text)
                                                                                                                              throws APIException

Deprecated. Use getProposedConcepts(String)

Throws:: APIException

getProposedConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
java.util.List<Concept> getProposedConcepts(java.lang.String text)
                                                                                                                throws APIException

Find matching proposed concepts

Parameters:: text -
Returns:: a List object containing matching proposed concepts
Throws:: APIException

findConcepts

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> findConcepts(java.lang.String phrase,
                                                                                                                        java.util.List<java.util.Locale> searchLocales,
                                                                                                                        boolean includeRetired,
                                                                                                                        java.util.List<ConceptClass> requireClasses,
                                                                                                                        java.util.List<ConceptClass> excludeClasses,
                                                                                                                        java.util.List<ConceptDatatype> requireDatatypes,
                                                                                                                        java.util.List<ConceptDatatype> excludeDatatypes)

Deprecated. use getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

proposeConcept

@Deprecated
 @Authorized(value="Add Concept Proposals")
void proposeConcept(ConceptProposal conceptProposal)
                                                                     throws APIException

Deprecated. use saveConceptProposal(ConceptProposal)

Throws:: APIException

saveConceptProposal

@Authorized(value={"Add Concept Proposals","Edit Concept Proposals"})
ConceptProposal saveConceptProposal(ConceptProposal conceptProposal)
                                                                                                   throws APIException

Saves/updates/proposes a concept proposal

Parameters:: conceptProposal - The ConceptProposal to save
Returns:: the saved/updated ConceptProposal object
Throws:: APIException

purgeConceptProposal

@Authorized(value="Purge Concept Proposals")
void purgeConceptProposal(ConceptProposal cp)
                                                                throws APIException

Removes a concept proposal from the database entirely.

Parameters:: cp -
Throws:: APIException

mapConceptProposalToConcept

@Authorized(value="Manage Concepts")
Concept mapConceptProposalToConcept(ConceptProposal cp,
                                                                         Concept mappedConcept)
                                                                  throws APIException

Maps a concept proposal to a concept

Parameters:: cp -; mappedConcept -
Returns:: the mappedConcept
Throws:: APIException

mapConceptProposalToConcept

@Authorized(value="Manage Concepts")
Concept mapConceptProposalToConcept(ConceptProposal cp,
                                                                         Concept mappedConcept,
                                                                         java.util.Locale locale)
                                                                  throws APIException

Maps a concept proposal to a concept

Parameters:: cp -; mappedConcept -; locale - of concept proposal
Returns:: the mappedConcept
Throws:: APIException

rejectConceptProposal

@Deprecated
 @Authorized(value="Edit Concept Proposals")
void rejectConceptProposal(ConceptProposal cp)
                                                                             throws APIException

Deprecated. use ConceptProposal.rejectConceptProposal()

Throws:: APIException

findMatchingConceptProposals

@Deprecated
 @Authorized(value="Add Concept Proposals")
java.util.List<ConceptProposal> findMatchingConceptProposals(java.lang.String text)

Deprecated. use getConceptProposals(String)

findConceptAnswers

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptWord> findConceptAnswers(java.lang.String phrase,
                                                                                                                              java.util.Locale locale,
                                                                                                                              Concept concept,
                                                                                                                              boolean includeRetired)
                                                                                                                       throws APIException

Deprecated. use findConceptAnswers(String, Locale, Concept)

Throws:: APIException

getConceptAnswers

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
 @Deprecated
java.util.List<ConceptWord> getConceptAnswers(java.lang.String phrase,
                                                                                                                             java.util.Locale locale,
                                                                                                                             Concept concept)
                                                                                                                      throws APIException

Deprecated. use findConceptAnswers(String, Locale, Concept)

Throws:: APIException

getQuestionsForAnswer

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getQuestionsForAnswer(Concept concept)
                                                                                                                      throws APIException

Deprecated. use #getConceptsByAnswer(Concept)

Throws:: APIException

getConceptsByAnswer
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByAnswer(Concept concept)
                                                                                                       throws APIException
```
Returns all possible Concepts to which this concept is a value-coded answer. To navigate in the other direction, i.e., from Concept to its answers use Concept.getAnswers()

Parameters:

concept -

Returns:

A List containing all possible questions to which this concept is a valued_Coded answer

Throws:

APIException

getPrevConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getPrevConcept(Concept concept)
                                                                                  throws APIException

Finds the previous concept in the dictionary that has the next lowest concept id

Parameters:: concept - the offset Concept
Returns:: the foundConcept
Throws:: APIException

getNextConcept

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getNextConcept(Concept concept)
                                                                                  throws APIException

Finds the next concept in the dictionary that has the next largest concept id

Parameters:: concept - the offset Concept
Returns:: the foundConcept
Throws:: APIException

checkIfLocked
```
@Transactional(readOnly=true)
void checkIfLocked()
                                          throws ConceptsLockedException
```
Check if the concepts are locked and if so, throw exception during manipulation of concept

Throws:

ConceptsLockedException

getConceptProposalByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Proposals")
ConceptProposal getConceptProposalByUuid(java.lang.String uuid)

Get ConceptProposal by its UUID

Parameters:: uuid -
Returns:

getConceptsWithDrugsInFormulary

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsWithDrugsInFormulary()
                                                                                                                   throws APIException

Convenience method for finding concepts associated with drugs in formulary.

Returns:: A List object of all concepts that occur as a Drug.concept.
Throws:: APIException

updateConceptWord

@Deprecated
 @Authorized(value="Manage Concepts")
void updateConceptWord(Concept concept)
                                                                  throws APIException

Deprecated. use updateConceptWord(Concept)

Throws:: APIException

updateConceptWords

@Deprecated
 @Authorized(value="Manage Concepts")
void updateConceptWords()
                                                                   throws APIException

Deprecated. use updateConceptWords()

Throws:: APIException

getConceptNameTagByUuid
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptNameTag getConceptNameTagByUuid(java.lang.String uuid)
```
Get ConceptNameTag by its UUID

Parameters:

uuid -

Returns:

the conceptNameTag with a matching uuid

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

updateConceptWords

@Deprecated
 @Authorized(value="Manage Concepts")
void updateConceptWords(java.lang.Integer conceptIdStart,
                                                                          java.lang.Integer conceptIdEnd)
                                                                   throws APIException

Deprecated. use updateConceptIndexes(Integer, Integer)

Throws:: APIException

getConceptComplex
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptComplex getConceptComplex(java.lang.Integer conceptId)
```
Get a ComplexConcept with the given conceptId

Parameters:

conceptId - of the ComplexConcept

Returns:

a ConceptComplex object

Since:

1.5

getConceptNameTagByName
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptNameTag getConceptNameTagByName(java.lang.String tag)
```
Search for a ConceptNameTag by name

Parameters:

tag - String name of ConceptNameTag

Returns:

ConceptNameTag matching the given String tag

See Also:

Concept.getPreferredName(Locale), Concept.getFullySpecifiedName(Locale), Concept.getShortNameInLocale(Locale), Concept.getShortestName(Locale, Boolean)

getLocalesOfConceptNames
```
@Transactional(readOnly=true)
java.util.Set<java.util.Locale> getLocalesOfConceptNames()
```
Gets the set of unique Locales used by existing concept names.

Returns:

set of used Locales

getAllConceptSources

@Transactional(readOnly=true)
 @Authorized(value="View Concept Sources")
java.util.List<ConceptSource> getAllConceptSources()
                                                                                                                     throws APIException

Return a list of concept sources currently in the database that are not voided

Returns:: List of Concept source objects
Throws:: APIException

getConceptSource

@Transactional(readOnly=true)
 @Authorized(value="View Concept Sources")
ConceptSource getConceptSource(java.lang.Integer i)
                                                                                                 throws APIException

Return a Concept source matching the given concept source id

Parameters:: i - Integer conceptSourceId
Returns:: ConceptSource
Throws:: APIException

saveConceptSource

@Authorized(value="Manage Concept Sources")
ConceptSource saveConceptSource(ConceptSource conceptSource)
                                                                     throws APIException

Create a new ConceptSource

Parameters:: conceptSource - ConceptSource to create
Throws:: APIException

purgeConceptSource

@Authorized(value="Purge Concept Sources")
ConceptSource purgeConceptSource(ConceptSource cs)
                                                                     throws APIException

Delete ConceptSource

Parameters:: cs - ConceptSource object delete
Throws:: APIException

retireConceptSource
```
@Authorized(value="Purge Concept Sources")
ConceptSource retireConceptSource(ConceptSource cs,
                                                                             java.lang.String reason)
                                                                      throws APIException
```
This effectively removes a concept source from the database. The source can still be referenced by old data, but no new data should use this source.

Parameters:

cs - the concept source to retire

reason - why the concept source is to be retired, must not be empty of null

Returns:

the retired concept source

Throws:

APIException

saveConceptNameTag
```
@Authorized(value="Manage Concept Name tags")
ConceptNameTag saveConceptNameTag(ConceptNameTag nameTag)
```
Creates a new Concept name tag if none exists. If a tag exists with the same name then that existing tag is returned.

Parameters:

nameTag - the concept name tag to be saved

Returns:

the newly created or existing concept name tag

getMaxConceptId
```
@Transactional(readOnly=true)
java.lang.Integer getMaxConceptId()
```
Gets the highest concept-id used by a concept.

Returns:

highest concept-id

conceptIterator

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.Iterator<Concept> conceptIterator()

Returns an iterator for all concepts, including retired and expired.

Returns:: the Iterator

getConceptByMapping
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConceptByMapping(java.lang.String code,
                                                                                              java.lang.String sourceName)
                                                                                       throws APIException
```
Looks up a concept via ConceptMap This will return the Concept which contains a ConceptMap entry whose sourceCode is equal to the passed conceptCode and whose ConceptSource has either a name or hl7Code that is equal to the passed mappingCode. Delegates to getConceptByMapping(code,sourceName,includeRetired) with includeRetired=true

Parameters:

code - the code associated with a concept within a given ConceptSource

sourceName - the name or hl7Code of the ConceptSource to check

Returns:

the Concept that has the given mapping, or null if no Concept found

Throws:

APIException

getConceptByMapping
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Concept getConceptByMapping(java.lang.String code,
                                                                                              java.lang.String sourceName,
                                                                                              java.lang.Boolean includeRetired)
                                                                                       throws APIException
```
Looks up a concept via ConceptMap This will return the Concept which contains a ConceptMap entry whose sourceCode is equal to the passed conceptCode and whose ConceptSource has either a name or hl7Code that is equal to the passed mappingCode . Operates under the assumption that each mappingCode in a ConceptSource references one and only one non-retired {@link Concept): if the underlying dao method returns more than one non-retired concept, this method will throw an exception; if the underlying dao method returns more than one concept, but only one non-retired concept, this method will return the non-retired concept; if the dao only returns retired concepts, this method will simply return the first concept in the list returns by the dao method; retired concepts can be excluded by setting the includeRetired parameter to false, but the above logic still applies

Parameters:

code - the code associated with a concept within a given ConceptSource

sourceName - the name or hl7Code of the ConceptSource to check

includeRetired - whether or not to include retired concepts

Returns:

the Concept that has the given mapping, or null if no Concept found

Throws:

APIException

getConceptsByMapping
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByMapping(java.lang.String code,
                                                                                                               java.lang.String sourceName)
                                                                                                        throws APIException
```
Looks up a concept via ConceptMap This will return the list of concepts Concepts which contain a ConceptMap entry whose sourceCode is equal to the passed conceptCode and whose ConceptSource has either a name or hl7Code that is equal to the passed mappingCode

Parameters:

code - the code associated with a concept within a given ConceptSource

sourceName - the name or hl7Code of the ConceptSource to check

Returns:

the list of non-voided Concepts that has the given mapping, or null if no Concept found

Throws:

APIException - if the specified source+code maps to more than one concept

Since:

1.8

getConceptsByMapping
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByMapping(java.lang.String code,
                                                                                                               java.lang.String sourceName,
                                                                                                               boolean includeRetired)
                                                                                                        throws APIException
```
Looks up a concept via ConceptMap This will return the list of Concepts which contain a ConceptMap entry whose sourceCode is equal to the passed conceptCode and whose ConceptSource has either a name or hl7Code that is equal to the passed mappingCode. Delegates to getConceptsByMapping(code,sourceName,includeRetired) with includeRetired=true

Parameters:

code - the code associated with a concept within a given ConceptSource

sourceName - the name or hl7Code of the ConceptSource to check

includeRetired - whether or not to include retired concepts

Returns:

the list of non-voided Concepts that has the given mapping, or null if no Concept found

Throws:

APIException - if the specified source+code maps to more than one concept

Since:

1.8

getAllConceptNameTags
```
@Transactional(readOnly=true)
java.util.List<ConceptNameTag> getAllConceptNameTags()
```
Get all the concept name tags defined in the database, included voided ones

Returns:

a list of the concept name tags stored in the

Since:

1.5

getConceptNameTag
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptNameTag getConceptNameTag(java.lang.Integer id)
```
Gets the ConceptNameTag with the given database primary key

Parameters:

id - the concept name tag id to find

Returns:

the matching ConceptNameTag or null if none found

Since:

1.5

getConceptDescriptionByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptDescription getConceptDescriptionByUuid(java.lang.String uuid)

Get ConceptDescription by its UUID

Parameters:: uuid -
Returns:

getConceptSourceByName

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
ConceptSource getConceptSourceByName(java.lang.String conceptSourceName)
                                                                                                throws APIException

Lookup a ConceptSource by its name property

Parameters:: conceptSourceName -
Returns:: ConceptSource
Throws:: APIException

getConceptsByConceptSource

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptMap> getConceptsByConceptSource(ConceptSource conceptSource)
                                                                                                                 throws APIException

Deprecated. as of version 1.9, use #getConceptMapsBySource(ConceptSource))

Looks up a list of ConceptMaps for a given ConceptSource

Parameters:: conceptSource -
Returns:: a List objects
Throws:: APIException

hasAnyObservation
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
boolean hasAnyObservation(Concept concept)
```
Checks if there are any observations (including voided observations) for a concept.

Parameters:

concept - which used or not used by an observation

Returns:

boolean true if the concept is used by an observation

Throws:

APIException

getTrueConcept

@Transactional(readOnly=true)
Concept getTrueConcept()

Returns the TRUE concept

Returns:: true concept

getFalseConcept
```
@Transactional(readOnly=true)
Concept getFalseConcept()
```
Returns the FALSE concept

Returns:

false concept

convertBooleanConceptToCoded
```
@Authorized(value="Manage Concepts")
void convertBooleanConceptToCoded(Concept conceptToChange)
                                                                throws APIException
```
Changes the datatype of a concept from boolean to coded when it has observations it is associated to.

Parameters:

conceptToChange - the concept which to change

Throws:

APIException

hasAnyObservation
```
@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
boolean hasAnyObservation(ConceptName conceptName)
                                                                                     throws APIException
```
Checks if there are any observations (including voided observations) using a conceptName.

Parameters:

conceptName - which is used or not used by an observation

Returns:

boolean true if the conceptName is used by an observation otherwise false

Throws:

APIException

Since:

Version 1.7

getConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSearchResult> getConcepts(java.lang.String phrase,
                                                                                                                  java.util.List<java.util.Locale> locales,
                                                                                                                  boolean includeRetired,
                                                                                                                  java.util.List<ConceptClass> requireClasses,
                                                                                                                  java.util.List<ConceptClass> excludeClasses,
                                                                                                                  java.util.List<ConceptDatatype> requireDatatypes,
                                                                                                                  java.util.List<ConceptDatatype> excludeDatatypes,
                                                                                                                  Concept answersToConcept,
                                                                                                                  java.lang.Integer start,
                                                                                                                  java.lang.Integer size)
                                                                                                           throws APIException

Searches for concepts by the given parameters.

Parameters:: phrase - matched to the start of any word in any of the names of a concept (if blank/null, matches all concepts); locales - List to restrict to; includeRetired - boolean if false, will exclude retired concepts; requireClasses - List to restrict to; excludeClasses - List to leave out of results; requireDatatypes - List to restrict to; excludeDatatypes - List to leave out of results; answersToConcept - all results will be a possible answer to this concept; start - all results less than this number will be removed; size - if non zero, all results after start + size will be removed
Returns:: a list of conceptSearchResults
Throws:: APIException
Since:: 1.8

findConceptAnswers

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSearchResult> findConceptAnswers(java.lang.String phrase,
                                                                                                                         java.util.Locale locale,
                                                                                                                         Concept concept)
                                                                                                                  throws APIException

Finds concepts that are possible value coded answers to concept parameter

Parameters:: phrase -; locale -; concept - the answers to match on
Returns:: a list of conceptSearchResults
Throws:: APIException
Since:: 1.8

updateConceptIndex
```
@Authorized(value="Manage Concepts")
void updateConceptIndex(Concept concept)
                                                      throws APIException
```
Iterates over the words in names and synonyms (for each locale) and updates the concept index, note that this only updates the index of the specified concept. Use updateConceptIndexes() if you wish to update the entire concept index.

Parameters:

concept - the concept whose index is to be updated

Throws:

APIException

Since:

1.8

updateConceptIndexes

@Authorized(value="Manage Concepts")
void updateConceptIndexes()
                                                        throws APIException

Iterates over all concepts and calls upddateConceptIndexes(Concept concept)

Throws:: APIException
Since:: 1.8

updateConceptIndexes
```
@Authorized(value="Manage Concepts")
void updateConceptIndexes(java.lang.Integer conceptIdStart,
                                                               java.lang.Integer conceptIdEnd)
                                                        throws APIException
```
Iterates over all concepts with conceptIds between conceptIdStart and conceptIdEnd (inclusive) and calls updateConceptIndexes(concept)

Parameters:

conceptIdStart - starts update with this concept_id

conceptIdEnd - ends update with this concept_id

Throws:

APIException

Since:

1.8

getConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptSearchResult> getConcepts(java.lang.String phrase,
                                                                                                                  java.util.Locale locale,
                                                                                                                  boolean includeRetired)
                                                                                                           throws APIException

Searches for concepts with the given parameters

Parameters:: phrase - the string to search against (if blank/null, matches all concepts); locale - the locale in which to search for the concepts; includeRetired - Specifies whether to include retired concepts
Returns:: a list ConceptSearchResults
Throws:: APIException
Since:: 1.8

getCountOfConcepts

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.lang.Integer getCountOfConcepts(java.lang.String phrase,
                                                                                                       java.util.List<java.util.Locale> locales,
                                                                                                       boolean includeRetired,
                                                                                                       java.util.List<ConceptClass> requireClasses,
                                                                                                       java.util.List<ConceptClass> excludeClasses,
                                                                                                       java.util.List<ConceptDatatype> requireDatatypes,
                                                                                                       java.util.List<ConceptDatatype> excludeDatatypes,
                                                                                                       Concept answersToConcept)

Return the number of concepts matching a search phrase and the specified arguments

Parameters:: phrase - matched to the start of any word in any of the names of a concept; locales - List to restrict to; includeRetired - Specifies whether to include retired concepts; requireClasses - List to restrict to; excludeClasses - List to leave out of results; requireDatatypes - List to restrict to; excludeDatatypes - List to leave out of results; answersToConcept - all results will be a possible answer to this concept
Returns:: the number of concepts matching the given search phrase
Throws:: APIException
Since:: 1.8

getCountOfDrugs

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.lang.Integer getCountOfDrugs(java.lang.String drugName,
                                                                                                    Concept concept,
                                                                                                    boolean searchOnPhrase,
                                                                                                    boolean searchDrugConceptNames,
                                                                                                    boolean includeRetired)
                                                                                             throws APIException

Return the number of drugs with matching names or concept drug names

Parameters:: drugName - the name of the drug; concept - the drug concept; searchOnPhrase - Specifies if the search should match names starting with or contain the text; searchDrugConceptNames - Specifies whether a search on concept names for the drug's concept should be done or not; includeRetired - specifies whether to include retired drugs
Returns:: the number of matching drugs
Throws:: APIException
Since:: 1.8

getDrugs

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugs(java.lang.String drugName,
                                                                                                Concept concept,
                                                                                                boolean searchOnPhrase,
                                                                                                boolean searchDrugConceptNames,
                                                                                                boolean includeRetired,
                                                                                                java.lang.Integer start,
                                                                                                java.lang.Integer length)
                                                                                         throws APIException

Returns a list of drugs with matching names or concept drug names and returns a specific number of them from the specified starting position. If start and length are not specified, then all matches are returned

Parameters:: drugName - the name of the drug; concept - the drug concept; searchOnPhrase - Specifies if the search should match names starting with or contain the text; searchDrugConceptNames - Specifies whether a search on concept names for the drug's concept should be done or not; includeRetired - specifies whether to include retired drugs; start - beginning index for the batch; length - number of drugs to return in the batch
Returns:: a list of matching drugs
Throws:: APIException
Since:: 1.8

getConceptStopWords
```
@Transactional(readOnly=true)
java.util.List<java.lang.String> getConceptStopWords(java.util.Locale locale)
```
Gets the list of ConceptStopWord for given locale

Parameters:

locale - The locale in which to search for the ConceptStopWord

Returns:

list of concept stop words for given locale

Since:

1.8

saveConceptStopWord
```
@Authorized(value="Manage Concept Stop Words")
ConceptStopWord saveConceptStopWord(ConceptStopWord conceptStopWord)
                                                                            throws APIException
```
Save the given ConceptStopWord in the database
If this is a new concept stop word, the returned concept stop word will have a new ConceptStopWord.getConceptStopWordId() inserted into it that was generated by the database

Parameters:

conceptStopWord - The ConceptStopWord to save or update

Returns:

the ConceptStopWord that was saved or updated

Throws:

APIException

Since:

1.8

deleteConceptStopWord

@Authorized(value="Manage Concept Stop Words")
void deleteConceptStopWord(java.lang.Integer conceptStopWordId)
                                                                   throws APIException

Delete the given ConceptStopWord in the database

Parameters:: conceptStopWordId - The ConceptStopWord to delete
Throws:: APIException
Since:: 1.8

getAllConceptStopWords
```
@Transactional(readOnly=true)
java.util.List<ConceptStopWord> getAllConceptStopWords()
```
Get all the concept stop words

Returns:

List of ConceptStopWord

Since:

1.8

getActiveConceptMapTypes

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
java.util.List<ConceptMapType> getActiveConceptMapTypes()
                                                                                                                            throws APIException

Returns a list of concept map types currently in the database excluding hidden ones

Returns:: List of concept map type objects
Throws:: APIException
Since:: 1.9

getConceptMapTypes

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
java.util.List<ConceptMapType> getConceptMapTypes(boolean includeRetired,
                                                                                                                             boolean includeHidden)
                                                                                                                      throws APIException

Returns a list of concept map types currently in the database including or excluding retired and hidden ones as specified by the includeRetired and includeHidden arguments

Parameters:: includeRetired - specifies if retired concept map types should be included
Returns:: List of concept map type objects
Throws:: APIException
Since:: 1.9

getConceptMapType

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
ConceptMapType getConceptMapType(java.lang.Integer conceptMapTypeId)
                                                                                                     throws APIException

Return a concept map type matching the given concept map type id

Parameters:: conceptMapTypeId - Integer concept map type id
Returns:: ConceptMapType
Throws:: APIException
Since:: 1.9

getConceptMapTypeByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
ConceptMapType getConceptMapTypeByUuid(java.lang.String uuid)
                                                                                                           throws APIException

Return a concept map type matching the given uuid

Parameters:: uuid - the uuid to search against
Returns:: ConceptMapType
Throws:: APIException
Since:: 1.9

getConceptMapTypeByName

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
ConceptMapType getConceptMapTypeByName(java.lang.String name)
                                                                                                           throws APIException

Return a concept map type matching the given name

Parameters:: name - the name to search against
Returns:: ConceptMapType
Throws:: APIException
Since:: 1.9

saveConceptMapType

@Authorized(value="Manage Concept Map Types")
ConceptMapType saveConceptMapType(ConceptMapType conceptMapType)
                                                                         throws APIException

Saves or updates the specified concept map type in the database

Parameters:: conceptMapType - the concept map type to save
Returns:: the saved conceptMapType
Throws:: APIException
Since:: 1.9

retireConceptMapType

@Authorized(value="Manage Concept Map Types")
ConceptMapType retireConceptMapType(ConceptMapType conceptMapType,
                                                                                  java.lang.String retireReason)
                                                                           throws APIException

Retiring a concept map type essentially removes it from circulation

Parameters:: conceptMapType - the concept map type to retire; retireReason - the reason why the concept map type is being retired
Returns:: the retired concept map type
Throws:: APIException
Since:: 1.9

unretireConceptMapType

@Authorized(value="Manage Concept Map Types")
ConceptMapType unretireConceptMapType(ConceptMapType conceptMapType)
                                                                             throws APIException

Marks a concept map type that is currently retired as not retired.

Parameters:: conceptMapType - the concept map type to unretire
Returns:: the unretired concept map type
Throws:: APIException
Since:: 1.9

purgeConceptMapType

@Authorized(value="Purge Concept Map Types")
void purgeConceptMapType(ConceptMapType conceptMapType)
                                                               throws APIException

Completely purges a concept map type from the database

Parameters:: conceptMapType - the concept map type to purge from the database
Throws:: APIException
Since:: 1.9

getConceptMappingsToSource

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<ConceptMap> getConceptMappingsToSource(ConceptSource conceptSource)
                                                                                                                 throws APIException

Returns a list of mappings from concepts to terms in the given reference terminology

Parameters:: conceptSource -
Returns:: a List object
Throws:: APIException
Since:: 1.9

getAllConceptReferenceTerms

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
java.util.List<ConceptReferenceTerm> getAllConceptReferenceTerms()
                                                                                                                                           throws APIException

Gets a list of all concept reference terms saved in the database

Returns:: a list of concept reference terms
Throws:: APIException
Since:: 1.9

getConceptReferenceTerms

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
java.util.List<ConceptReferenceTerm> getConceptReferenceTerms(boolean includeRetired)
                                                                                                                                        throws APIException

Gets a list of concept reference terms saved in the database

Parameters:: includeRetired - specifies if retired concept reference terms should be included
Returns:: a list of concept reference terms
Throws:: APIException
Since:: 1.9

getConceptReferenceTerm

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
ConceptReferenceTerm getConceptReferenceTerm(java.lang.Integer conceptReferenceTermId)
                                                                                                                       throws APIException

Gets the concept reference term with the specified concept reference term id

Parameters:: conceptReferenceTermId - the concept reference term id to search against
Returns:: the concept reference term object with the given concept reference term id
Throws:: APIException
Since:: 1.9

getConceptReferenceTermByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
ConceptReferenceTerm getConceptReferenceTermByUuid(java.lang.String uuid)
                                                                                                                             throws APIException

Gets the concept reference term with the specified uuid

Parameters:: uuid - the uuid to search against
Returns:: the concept reference term object with the given uuid
Throws:: APIException
Since:: 1.9

getConceptReferenceTermByName

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
ConceptReferenceTerm getConceptReferenceTermByName(java.lang.String name,
                                                                                                                                    ConceptSource conceptSource)
                                                                                                                             throws APIException

Gets a concept reference term with the specified name from the specified concept source ignoring all retired ones

Parameters:: name - the name to match against; conceptSource - the concept source to match against
Returns:: concept reference term object
Throws:: APIException
Since:: 1.9

getConceptReferenceTermByCode

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
ConceptReferenceTerm getConceptReferenceTermByCode(java.lang.String code,
                                                                                                                                    ConceptSource conceptSource)
                                                                                                                             throws APIException

Gets a concept reference term with the specified code from the specified concept source

Parameters:: code - the code to match against; conceptSource - the concept source to match against
Returns:: concept reference term object
Throws:: APIException
Since:: 1.9

saveConceptReferenceTerm

@Authorized(value="Manage Concept Reference Terms")
ConceptReferenceTerm saveConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)
                                                                                           throws APIException

Stores the specified concept reference term to the database

Parameters:: conceptReferenceTerm - the concept reference term object to save
Returns:: the saved concept reference term object
Throws:: APIException
Since:: 1.9

retireConceptReferenceTerm

@Authorized(value="Manage Concept Reference Terms")
ConceptReferenceTerm retireConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm,
                                                                                                    java.lang.String retireReason)
                                                                                             throws APIException

Retiring a concept reference term essentially removes it from circulation

Parameters:: conceptReferenceTerm - the concept reference term object to retire; retireReason - the reason why the concept reference term is being retired
Returns:: the retired concept reference term object
Throws:: APIException
Since:: 1.9

unretireConceptReferenceTerm

@Authorized(value="Manage Concept Reference Terms")
ConceptReferenceTerm unretireConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)
                                                                                               throws APIException

Marks a concept reference term that is currently retired as not retired.

Parameters:: conceptReferenceTerm - the concept reference term to unretire
Returns:: the unretired concept reference term
Throws:: APIException
Since:: 1.9

purgeConceptReferenceTerm

@Authorized(value="Purge Concept Reference Terms")
void purgeConceptReferenceTerm(ConceptReferenceTerm conceptReferenceTerm)
                                                                           throws APIException

Purges the specified concept reference term from the database

Parameters:: conceptReferenceTerm - the concept reference term object to purge
Throws:: APIException
Since:: 1.9

getConceptReferenceTerms

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
java.util.List<ConceptReferenceTerm> getConceptReferenceTerms(java.lang.String query,
                                                                                                                                               ConceptSource conceptSource,
                                                                                                                                               java.lang.Integer start,
                                                                                                                                               java.lang.Integer length,
                                                                                                                                               boolean includeRetired)
                                                                                                                                        throws APIException

Finds the concept reference term in the database that have a code or name that contains the specified search phrase.

Parameters:: query - the string to match against the reference term names or codes; conceptSource - the concept source from which the terms should be looked up; start - beginning index for the batch; length - number of terms to return in the batch; includeRetired - specifies if the retired terms should be included
Returns:: a list if ConceptReferenceTerms
Throws:: APIException
Since:: 1.9

getCountOfConceptReferenceTerms

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
java.lang.Integer getCountOfConceptReferenceTerms(java.lang.String query,
                                                                                                                                   ConceptSource conceptSource,
                                                                                                                                   boolean includeRetired)
                                                                                                                            throws APIException

Returns the count of concept reference terms that match the specified arguments

Parameters:: query - the string to match against the reference term names; conceptSource - the concept source from which the terms should be looked up; includeRetired - specifies if retired concept reference terms should be included
Returns:: the count of matching concept reference terms
Throws:: APIException
Since:: 1.9

getReferenceTermMappingsTo

@Transactional(readOnly=true)
 @Authorized(value="View Concept Reference Terms")
java.util.List<ConceptReferenceTermMap> getReferenceTermMappingsTo(ConceptReferenceTerm term)
                                                                                                                                             throws APIException

Fetches all the ConceptReferenceTermMap where the specified reference term is the termB i.e mappings added to other terms pointing to it

Parameters:: term - the term to match against
Returns:: a list of ConceptReferenceTermMaps
Throws:: APIException
Since:: 1.9

getConceptsByName

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Concept> getConceptsByName(java.lang.String name,
                                                                                                            java.util.Locale locale,
                                                                                                            java.lang.Boolean exactLocale)
                                                                                                     throws APIException

Returns a list of concepts with the same name in the given locale.

This method is case insensitive. It searches for exactly matching names and close matching locales (if exactLocale = false). It considers only non-voided names and all concepts.

Parameters:: name -; locale - null = all locales; exactLocale - false if search for both global and country specific, true if null
Returns:: the list of concepts
Throws:: APIException
Since:: 1.9, 1.8.4

getDefaultConceptMapType

@Transactional(readOnly=true)
 @Authorized(value="View Concept Map Types")
ConceptMapType getDefaultConceptMapType()
                                                                                                            throws APIException

Gets the concept map type to be used as the default. It is specified by the concept.defaultConceptMapType global property.

Returns:: the ConceptMapType
Throws:: APIException
Since:: 1.9

getDrugs
```
@Authorized(value="View Concepts")
java.util.List<Drug> getDrugs(java.lang.String searchPhrase,
                                                                 java.util.Locale locale,
                                                                 boolean exactLocale,
                                                                 boolean includeRetired)
```
Fetches un retired drugs that match the specified search phrase. The logic matches on drug names, concept names of the associated concepts or the concept reference term codes of the drug reference term mappings

Parameters:

searchPhrase - The string to match against

locale - The locale to match against when searching in drug concept names

exactLocale - If false then 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 drugs that match should be included or not

Returns:

A list of matching drugs

Since:

1.10

getDrugsByMapping

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
java.util.List<Drug> getDrugsByMapping(java.lang.String code,
                                                                                                         ConceptSource conceptSource,
                                                                                                         java.util.Collection<ConceptMapType> withAnyOfTheseTypes,
                                                                                                         boolean includeRetired)
                                                                                                  throws APIException

Fetches all drugs with reference mappings to the specified concept source that match the specified code and concept map types

Parameters:: code - the code the reference term code to match on; conceptSource - the concept source on which to match on; withAnyOfTheseTypes - the ConceptMapTypes to match on; includeRetired - specifies if retired drugs should be included or not
Returns:: the list of Drug
Throws:: APIException
Since:: 1.10

getDrugByMapping

@Transactional(readOnly=true)
 @Authorized(value="View Concepts")
Drug getDrugByMapping(java.lang.String code,
                                                                                        ConceptSource conceptSource,
                                                                                        java.util.Collection<ConceptMapType> withAnyOfTheseTypesOrOrderOfPreference)
                                                                                 throws APIException

Gets the "best" matching drug, i.e. matching the earliest ConceptMapType passed in e.g. getDrugByMapping("12345", rxNorm, Arrays.asList(sameAs, narrowerThan)) If there are multiple matches for the highest-priority ConceptMapType, throw an exception

Parameters:: code - the code the reference term code to match on; conceptSource - the concept source to match on; withAnyOfTheseTypesOrOrderOfPreference - the ConceptMapTypes to match on
Returns:: the Drug
Throws:: APIException
Since:: 1.10

getOrderableConcepts

@Transactional(readOnly=true)
java.util.List<ConceptSearchResult> getOrderableConcepts(java.lang.String phrase,
                                                                                       java.util.List<java.util.Locale> locales,
                                                                                       boolean includeRetired,
                                                                                       java.lang.Integer start,
                                                                                       java.lang.Integer length)

An Orderable concept is one where its conceptClass has a mapping in the order_type_class_map table. This method searches for orderable concepts which match the specified arguments

Parameters:: phrase - the phrase to match on; locales - list of locales to match on; includeRetired - include retired concepts or not; start - start index of search results; length - number of concept results to be returned
Returns:: List of ConceptSearchResults
Since:: 1.10

Interface ConceptService

Method Summary

Methods inherited from interface org.openmrs.api.OpenmrsService

Method Detail

setConceptDAO

createConcept

createConcept

updateConcept

getConceptByUuid

updateConcept

createDrug

updateDrug

deleteConcept

voidConcept

saveConcept

saveDrug

purgeConcept

retireConcept

retireDrug

unretireDrug

purgeDrug

getConcept

getConceptName

getConceptAnswer

getDrug

getConceptNumeric

getConceptClass

getAllConcepts

getAllConcepts

getConcepts

getConceptsByName

getConceptByName

getConceptByIdOrName

getConcept

getConceptWords

getConceptWords

findConcepts

findConcepts

getDrugByUuid

getDrugIngredientByUuid

findConcepts

getDrug

getDrugByNameOrId

getDrugs

getAllDrugs

getDrugs

getDrugsByConcept

getAllDrugs

findDrugs

getDrugs

getConceptsByClass

getConceptClasses

getConceptClassByName

getAllConceptClasses

getAllConceptClasses

getConceptClassByUuid

getConceptAnswerByUuid

getConceptNameByUuid

getConceptSetByUuid

getConceptSourceByUuid

saveConceptClass

purgeConceptClass

saveConceptDatatype

purgeConceptDatatype

getAllConceptDatatypes

getAllConceptDatatypes

getConceptDatatypes

getConceptDatatype

getConceptDatatypeByUuid

getConceptDatatypeByName

updateConceptSetDerived

updateConceptSetDerived

getConceptSets

getConceptSetsByConcept

getConceptsInSet

getConceptsByConceptSet

getSetsContainingConcept

getConceptProposals

getAllConceptProposals

getConceptNumericByUuid