se.cambio.cds.ts
Interface TerminologyService

All Known Subinterfaces:

TerminologyServicePlugin

All Known Implementing Classes:

CSVTerminologyServicePlugin, DummyTerminologyServicePlugin, ICD10TerminologyServicePlugin, TerminologyServiceImpl

public interface TerminologyService

This class defines a minimal interface of a terminology service that is required to support runtime and authoring of CDSS.

Author:

rong.chen

Method Summary

Collection<String>	getSupportedTerminologies()
boolean	hasPropertyOfValue(org.openehr.rm.datatypes.text.CodePhrase concept, org.openehr.rm.datatypes.text.CodePhrase property, org.openehr.rm.datatypes.text.CodePhrase value) Checks if given concept has a named attribute of given value
boolean	isSubclassOf(org.openehr.rm.datatypes.text.CodePhrase a, org.openehr.rm.datatypes.text.CodePhrase b) Checks if codePhrase a is subclass of b with regards to subsumption relationship
boolean	isSubclassOf(org.openehr.rm.datatypes.text.CodePhrase code, Set<org.openehr.rm.datatypes.text.CodePhrase> codes) Checks if the given code is subclass of any member of specified set of codes
boolean	isTerminologySupported(String terminologyId)
List<Node>	retrieve(String expression, org.openehr.rm.datatypes.text.CodePhrase language)
List<Node>	retrieveAll(String terminologyId, org.openehr.rm.datatypes.text.CodePhrase language)
List<org.openehr.rm.datatypes.text.DvCodedText>	retrieveAllPossibleValues(org.openehr.rm.datatypes.text.CodePhrase property, org.openehr.rm.datatypes.text.CodePhrase language) Retrieves all possible values of given attribute with labels in specified language
Node	retrieveAllSubclasses(org.openehr.rm.datatypes.text.CodePhrase concept, org.openehr.rm.datatypes.text.CodePhrase language) Retrieves all subclasses of given concept with specified language
String	retrieveTerm(org.openehr.rm.datatypes.text.CodePhrase concept, org.openehr.rm.datatypes.text.CodePhrase language) Retrieves the term of a given concept in given language

Method Detail

isSubclassOf

boolean isSubclassOf(org.openehr.rm.datatypes.text.CodePhrase a,
                     org.openehr.rm.datatypes.text.CodePhrase b)
                     throws UnsupportedTerminologyException,
                            InvalidCodeException

Checks if codePhrase a is subclass of b with regards to subsumption relationship

Parameters:

a -

b -

Returns:

true if a is subclass of b

Throws:

UnsupportedTerminologyException

InvalidCodeException

isSubclassOf

boolean isSubclassOf(org.openehr.rm.datatypes.text.CodePhrase code,
                     Set<org.openehr.rm.datatypes.text.CodePhrase> codes)
                     throws UnsupportedTerminologyException,
                            InvalidCodeException

Checks if the given code is subclass of any member of specified set of codes

Parameters:

code -

codes -

Returns:

true if a is subclass of b

Throws:

UnsupportedTerminologyException

InvalidCodeException

retrieveAllSubclasses

Node retrieveAllSubclasses(org.openehr.rm.datatypes.text.CodePhrase concept,
                           org.openehr.rm.datatypes.text.CodePhrase language)
                           throws UnsupportedTerminologyException,
                                  UnsupportedLanguageException,
                                  InvalidCodeException

Retrieves all subclasses of given concept with specified language

Parameters:

concept -

Returns:

returns a tree representation of subclasses

Throws:

UnsupportedTerminologyException

UnsupportedLanguageException

InvalidCodeException

retrieve

List<Node> retrieve(String expression,
                    org.openehr.rm.datatypes.text.CodePhrase language)
                    throws UnsupportedTerminologyException,
                           UnsupportedLanguageException

Throws:

UnsupportedTerminologyException

UnsupportedLanguageException

retrieveAll

List<Node> retrieveAll(String terminologyId,
                       org.openehr.rm.datatypes.text.CodePhrase language)
                       throws UnsupportedTerminologyException,
                              UnsupportedLanguageException

Throws:

UnsupportedTerminologyException

UnsupportedLanguageException

hasPropertyOfValue

boolean hasPropertyOfValue(org.openehr.rm.datatypes.text.CodePhrase concept,
                           org.openehr.rm.datatypes.text.CodePhrase property,
                           org.openehr.rm.datatypes.text.CodePhrase value)
                           throws UnsupportedTerminologyException,
                                  UnknownPropertyException

Checks if given concept has a named attribute of given value

Parameters:

concept -

property -

value -

Returns:

true if the property has value

Throws:

UnsupportedTerminologyException

UnknownPropertyException

retrieveTerm

String retrieveTerm(org.openehr.rm.datatypes.text.CodePhrase concept,
                    org.openehr.rm.datatypes.text.CodePhrase language)
                    throws UnsupportedTerminologyException,
                           UnsupportedLanguageException

Retrieves the term of a given concept in given language

Parameters:

concept -

language -

Returns:

the term

Throws:

UnsupportedTerminologyException

UnsupportedLanguageException

retrieveAllPossibleValues

List<org.openehr.rm.datatypes.text.DvCodedText> retrieveAllPossibleValues(org.openehr.rm.datatypes.text.CodePhrase property,
                                                                          org.openehr.rm.datatypes.text.CodePhrase language)
                                                                          throws UnsupportedTerminologyException,
                                                                                 UnknownPropertyException,
                                                                                 UnsupportedLanguageException

Retrieves all possible values of given attribute with labels in specified language

Parameters:

property -

language -

Returns:

a list of coded texts

Throws:

UnsupportedTerminologyException

UnknownPropertyException

UnsupportedLanguageException

isTerminologySupported

boolean isTerminologySupported(String terminologyId)

getSupportedTerminologies

Collection<String> getSupportedTerminologies()