Package org.hl7.fhir.dstu2016may.model

Class DecisionSupportRule

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.model.DecisionSupportRule

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class DecisionSupportRule
extends DomainResource

This resource defines a decision support rule of the form [on Event] if Condition then Action. It is intended to be a shareable, computable definition of a actions that should be taken whenever some condition is met in response to a particular event or events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ActionDefinition>	action	The action element defines the "when" portion of the rule that determines what actions should be performed if the condition evaluates to true.
protected StringType	condition	The condition element describes he "if" portion of the rule that determines whether or not the rule "fires".
static ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<Reference>	library	A reference to a Library containing the formal logic used by the rule.
protected List<Library>	libraryTarget	The actual objects that are the target of the reference (A reference to a Library containing the formal logic used by the rule.)
protected ModuleMetadata	moduleMetadata	The metadata for the decision support rule, including publishing, life-cycle, version, documentation, and supporting evidence.
static String	SP_DESCRIPTION	Search parameter: description
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_STATUS	Search parameter: status
static String	SP_TITLE	Search parameter: title
static String	SP_TOPIC	Search parameter: topic
static String	SP_VERSION	Search parameter: version
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
static ca.uhn.fhir.rest.gclient.TokenClientParam	TOPIC	Fluent Client search parameter constant for topic
protected List<TriggerDefinition>	trigger	The trigger element defines when the rule should be invoked.
static ca.uhn.fhir.rest.gclient.StringClientParam	VERSION	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DecisionSupportRule()	Constructor

Method Summary

Modifier and Type	Method	Description
ActionDefinition	addAction()
DecisionSupportRule	addAction(ActionDefinition t)
Base	addChild(String name)
Reference	addLibrary()
DecisionSupportRule	addLibrary(Reference t)
Library	addLibraryTarget()
TriggerDefinition	addTrigger()
DecisionSupportRule	addTrigger(TriggerDefinition t)
DecisionSupportRule	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<ActionDefinition>	getAction()
String	getCondition()
StringType	getConditionElement()
List<Reference>	getLibrary()
List<Library>	getLibraryTarget()
ModuleMetadata	getModuleMetadata()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<TriggerDefinition>	getTrigger()
boolean	hasAction()
boolean	hasCondition()
boolean	hasConditionElement()
boolean	hasLibrary()
boolean	hasModuleMetadata()
boolean	hasTrigger()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)	make an instance of a property.
DecisionSupportRule	setCondition(String value)
DecisionSupportRule	setConditionElement(StringType value)
DecisionSupportRule	setModuleMetadata(ModuleMetadata value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
protected DecisionSupportRule	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Detail

moduleMetadata

protected ModuleMetadata moduleMetadata

The metadata for the decision support rule, including publishing, life-cycle, version, documentation, and supporting evidence.

library

protected List<Reference> library

A reference to a Library containing the formal logic used by the rule.

libraryTarget

protected List<Library> libraryTarget

The actual objects that are the target of the reference (A reference to a Library containing the formal logic used by the rule.)

trigger

protected List<TriggerDefinition> trigger

The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.

condition

protected StringType condition

The condition element describes he "if" portion of the rule that determines whether or not the rule "fires". The condition must be the name of an expression in a referenced library.

action

protected List<ActionDefinition> action

The action element defines the "when" portion of the rule that determines what actions should be performed if the condition evaluates to true.

SP_TOPIC

public static final String SP_TOPIC

Search parameter: topic

Description: Topics associated with the module
Type: token
Path: DecisionSupportRule.moduleMetadata.topic

See Also:

Constant Field Values

TOPIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC

Fluent Client search parameter constant for topic

Description: Topics associated with the module
Type: token
Path: DecisionSupportRule.moduleMetadata.topic

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: Text search against the title
Type: string
Path: DecisionSupportRule.moduleMetadata.title

See Also:

Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE

Fluent Client search parameter constant for title

Description: Text search against the title
Type: string
Path: DecisionSupportRule.moduleMetadata.title

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: Status of the module
Type: token
Path: DecisionSupportRule.moduleMetadata.status

See Also:

Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: Status of the module
Type: token
Path: DecisionSupportRule.moduleMetadata.status

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: Text search against the description
Type: string
Path: DecisionSupportRule.moduleMetadata.description

See Also:

Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: Text search against the description
Type: string
Path: DecisionSupportRule.moduleMetadata.description

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Logical identifier for the module (e.g. CMS-143)
Type: token
Path: DecisionSupportRule.moduleMetadata.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Logical identifier for the module (e.g. CMS-143)
Type: token
Path: DecisionSupportRule.moduleMetadata.identifier

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: Version of the module (e.g. 1.0.0)
Type: string
Path: DecisionSupportRule.moduleMetadata.version

See Also:

Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.StringClientParam VERSION

Fluent Client search parameter constant for version

Description: Version of the module (e.g. 1.0.0)
Type: string
Path: DecisionSupportRule.moduleMetadata.version

Constructor Detail

DecisionSupportRule

public DecisionSupportRule()

Constructor

Method Detail

getModuleMetadata

public ModuleMetadata getModuleMetadata()

Returns:

moduleMetadata (The metadata for the decision support rule, including publishing, life-cycle, version, documentation, and supporting evidence.)

hasModuleMetadata

public boolean hasModuleMetadata()

setModuleMetadata

public DecisionSupportRule setModuleMetadata(ModuleMetadata value)

Parameters:

value - moduleMetadata (The metadata for the decision support rule, including publishing, life-cycle, version, documentation, and supporting evidence.)

getLibrary

public List<Reference> getLibrary()

Returns:

library (A reference to a Library containing the formal logic used by the rule.)

hasLibrary

public boolean hasLibrary()

addLibrary

public Reference addLibrary()

Returns:

library (A reference to a Library containing the formal logic used by the rule.)

addLibrary

public DecisionSupportRule addLibrary(Reference t)

getLibraryTarget

public List<Library> getLibraryTarget()

Returns:

library (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A reference to a Library containing the formal logic used by the rule.)

addLibraryTarget

public Library addLibraryTarget()

Returns:

library (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. A reference to a Library containing the formal logic used by the rule.)

getTrigger

public List<TriggerDefinition> getTrigger()

Returns:

trigger (The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.)

hasTrigger

public boolean hasTrigger()

addTrigger

public TriggerDefinition addTrigger()

Returns:

trigger (The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.)

addTrigger

public DecisionSupportRule addTrigger(TriggerDefinition t)

getConditionElement

public StringType getConditionElement()

Returns:

condition (The condition element describes he "if" portion of the rule that determines whether or not the rule "fires". The condition must be the name of an expression in a referenced library.). This is the underlying object with id, value and extensions. The accessor "getCondition" gives direct access to the value

hasConditionElement

public boolean hasConditionElement()

hasCondition

public boolean hasCondition()

setConditionElement

public DecisionSupportRule setConditionElement(StringType value)

Parameters:

value - condition (The condition element describes he "if" portion of the rule that determines whether or not the rule "fires". The condition must be the name of an expression in a referenced library.). This is the underlying object with id, value and extensions. The accessor "getCondition" gives direct access to the value

getCondition

public String getCondition()

Returns:

The condition element describes he "if" portion of the rule that determines whether or not the rule "fires". The condition must be the name of an expression in a referenced library.

setCondition

public DecisionSupportRule setCondition(String value)

Parameters:

value - The condition element describes he "if" portion of the rule that determines whether or not the rule "fires". The condition must be the name of an expression in a referenced library.

getAction

public List<ActionDefinition> getAction()

Returns:

action (The action element defines the "when" portion of the rule that determines what actions should be performed if the condition evaluates to true.)

hasAction

public boolean hasAction()

addAction

public ActionDefinition addAction()

Returns:

action (The action element defines the "when" portion of the rule that determines what actions should be performed if the condition evaluates to true.)

addAction

public DecisionSupportRule addAction(ActionDefinition t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Description copied from class: Base

make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property

Overrides:

makeProperty in class DomainResource

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public DecisionSupportRule copy()

Specified by:

copy in class DomainResource

typedCopy

protected DecisionSupportRule typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource