org.openmrs.arden

Interface MlmRule

All Superinterfaces:

Rule

public interface MlmRule
extends Rule

A medical logic module (MLM) is an independent unit in a health knowledge base that combines the knowledge required and the definition of the way it should be applied for a single health decision (from: wikipedia). Currently the way to create an MlmRule is using Arden syntax and then transform them to Rule object using the ArdenService.

Since:

1.8

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAction() Returns the action that should be taken when the logic evaluates to true
java.lang.Integer	getAgeMax()
java.lang.String	getAgeMaxUnits()
java.lang.Integer	getAgeMin()
java.lang.String	getAgeMinUnits()
java.lang.String	getAuthor() Returns the name of the person that authored this rule
java.lang.String	getCitations() Returns citations that can be used as reference for this rule
java.lang.String	getData() Returns the portion of the rule logic that pulls the data to run the rule
java.lang.String	getDate() Returns the date this rule was created
java.lang.String	getExplanation() Returns an explanation of why this rule is needed
java.lang.String	getInstitution() Returns the institution that authored this rule
java.lang.String	getKeywords() Returns keywords that can be used to classify the rule
java.lang.String	getLinks() Returns urls that can be used as reference for this rule
java.lang.String	getLogic() Returns the logic that is applied to the data to decide what action should be taken
java.lang.Integer	getPriority() Returns the priority value of the rule.
java.lang.String	getPurpose() Returns the purpose of this rule
java.lang.String	getSpecialist() Returns the name of the specialist this rule applies to
java.lang.String	getTitle() Returns a descriptive title for the rule.
java.lang.String	getType() Returns the type of the rule.
java.lang.Double	getVersion() Returns the version of the rule.

Methods inherited from interface org.openmrs.logic.Rule

eval, getDefaultDatatype, getDependencies, getParameterList, getTTL

Method Detail

getPriority

java.lang.Integer getPriority()

Returns the priority value of the rule. This value determines in what order the rules get evaluated.

Returns:

Integer priority value

getTitle

java.lang.String getTitle()

Returns a descriptive title for the rule.

Returns:

String title for the rule

getVersion

java.lang.Double getVersion()

Returns the version of the rule.

Returns:

Double version of the rule

getInstitution

java.lang.String getInstitution()

Returns the institution that authored this rule

Returns:

String institution that authored this rule

getAuthor

java.lang.String getAuthor()

Returns the name of the person that authored this rule

Returns:

String name of the person that authored this rule

getSpecialist

java.lang.String getSpecialist()

Returns the name of the specialist this rule applies to

Returns:

String name of the specialist this rule applies to

getDate

java.lang.String getDate()

Returns the date this rule was created

Returns:

String date this rule was created

getPurpose

java.lang.String getPurpose()

Returns the purpose of this rule

Returns:

String purpose of this rule

getExplanation

java.lang.String getExplanation()

Returns an explanation of why this rule is needed

Returns:

String explanation of why this rule is needed

getKeywords

java.lang.String getKeywords()

Returns keywords that can be used to classify the rule

Returns:

String keywords that can be used to classify the rule

getCitations

java.lang.String getCitations()

Returns citations that can be used as reference for this rule

Returns:

String citations that can be used as reference for this rule

getLinks

java.lang.String getLinks()

Returns urls that can be used as reference for this rule

Returns:

String urls that can be used as reference for this rule

getData

java.lang.String getData()

Returns the portion of the rule logic that pulls the data to run the rule

Returns:

String portion of the rule logic that pulls the data to run the rule

getLogic

java.lang.String getLogic()

Returns the logic that is applied to the data to decide what action should be taken

Returns:

String the logic that is applied to the data to decide what action should be taken

getAction

java.lang.String getAction()

Returns the action that should be taken when the logic evaluates to true

Returns:

String action that should be taken when the logic evaluates to true

getType

java.lang.String getType()

Returns the type of the rule. This type is used along with the priority to evaluate prioritized rule sets

Returns:

String type of the rule

getAgeMin

java.lang.Integer getAgeMin()

getAgeMax

java.lang.Integer getAgeMax()

getAgeMinUnits

java.lang.String getAgeMinUnits()

getAgeMaxUnits

java.lang.String getAgeMaxUnits()