Package org.hl7.fhir.r5.model

Class TriggerDefinition

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.TriggerDefinition

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class TriggerDefinition
extends DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TriggerDefinition.TriggerType
static class	TriggerDefinition.TriggerTypeEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	code	A code that identifies the event.
protected Expression	condition	A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
protected List<DataRequirement>	data	The triggering data of the event (if this is a data trigger).
protected StringType	name	A formal name for the event.
protected CanonicalType	subscriptionTopic	A reference to a SubscriptionTopic resource that defines the event.
protected DataType	timing	The timing of the event (if this is a periodic trigger).
protected Enumeration<TriggerDefinition.TriggerType>	type	The type of triggering event.

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
TriggerDefinition()	Constructor
TriggerDefinition(TriggerDefinition.TriggerType type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
DataRequirement	addData()
TriggerDefinition	addData(DataRequirement t)
TriggerDefinition	copy()
void	copyValues(TriggerDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCode()
Expression	getCondition()
List<DataRequirement>	getData()
DataRequirement	getDataFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getSubscriptionTopic()
CanonicalType	getSubscriptionTopicElement()
DataType	getTiming()
DateTimeType	getTimingDateTimeType()
DateType	getTimingDateType()
Reference	getTimingReference()
Timing	getTimingTiming()
TriggerDefinition.TriggerType	getType()
Enumeration<TriggerDefinition.TriggerType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCode()
boolean	hasCondition()
boolean	hasData()
boolean	hasName()
boolean	hasNameElement()
boolean	hasSubscriptionTopic()
boolean	hasSubscriptionTopicElement()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingDateType()
boolean	hasTimingReference()
boolean	hasTimingTiming()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
TriggerDefinition	setCode(CodeableConcept value)
TriggerDefinition	setCondition(Expression value)
TriggerDefinition	setData(List<DataRequirement> theData)
TriggerDefinition	setName(String value)
TriggerDefinition	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
TriggerDefinition	setSubscriptionTopic(String value)
TriggerDefinition	setSubscriptionTopicElement(CanonicalType value)
TriggerDefinition	setTiming(DataType value)
TriggerDefinition	setType(TriggerDefinition.TriggerType value)
TriggerDefinition	setTypeElement(Enumeration<TriggerDefinition.TriggerType> value)
protected TriggerDefinition	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getExtensionValue, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

Field Details

type

protected Enumeration<TriggerDefinition.TriggerType> type

The type of triggering event.

name

protected StringType name

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

code

protected CodeableConcept code

A code that identifies the event.

subscriptionTopic

protected CanonicalType subscriptionTopic

A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.

timing

protected DataType timing

The timing of the event (if this is a periodic trigger).

data

protected List<DataRequirement> data

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

condition

protected Expression condition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

Constructor Details

TriggerDefinition

public TriggerDefinition()

Constructor

TriggerDefinition

public TriggerDefinition(TriggerDefinition.TriggerType type)

Constructor

Method Details

getTypeElement

public Enumeration<TriggerDefinition.TriggerType> getTypeElement()

Returns:

type (The type of triggering event.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public TriggerDefinition setTypeElement(Enumeration<TriggerDefinition.TriggerType> value)

Parameters:

value - type (The type of triggering event.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public TriggerDefinition.TriggerType getType()

Returns:

The type of triggering event.

setType

public TriggerDefinition setType(TriggerDefinition.TriggerType value)

Parameters:

value - The type of triggering event.

getNameElement

public StringType getNameElement()

Returns:

name (A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public TriggerDefinition setNameElement(StringType value)

Parameters:

value - name (A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

setName

public TriggerDefinition setName(String value)

Parameters:

value - A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

getCode

public CodeableConcept getCode()

Returns:

code (A code that identifies the event.)

hasCode

public boolean hasCode()

setCode

public TriggerDefinition setCode(CodeableConcept value)

Parameters:

value - code (A code that identifies the event.)

getSubscriptionTopicElement

public CanonicalType getSubscriptionTopicElement()

Returns:

subscriptionTopic (A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.). This is the underlying object with id, value and extensions. The accessor "getSubscriptionTopic" gives direct access to the value

hasSubscriptionTopicElement

public boolean hasSubscriptionTopicElement()

hasSubscriptionTopic

public boolean hasSubscriptionTopic()

setSubscriptionTopicElement

public TriggerDefinition setSubscriptionTopicElement(CanonicalType value)

Parameters:

value - subscriptionTopic (A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.). This is the underlying object with id, value and extensions. The accessor "getSubscriptionTopic" gives direct access to the value

getSubscriptionTopic

public String getSubscriptionTopic()

Returns:

A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.

setSubscriptionTopic

public TriggerDefinition setSubscriptionTopic(String value)

Parameters:

value - A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.

getTiming

public DataType getTiming()

Returns:

timing (The timing of the event (if this is a periodic trigger).)

getTimingTiming

public Timing getTimingTiming()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The timing of the event (if this is a periodic trigger).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingTiming

public boolean hasTimingTiming()

getTimingReference

public Reference getTimingReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The timing of the event (if this is a periodic trigger).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingReference

public boolean hasTimingReference()

getTimingDateType

public DateType getTimingDateType()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The timing of the event (if this is a periodic trigger).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateType

public boolean hasTimingDateType()

getTimingDateTimeType

public DateTimeType getTimingDateTimeType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The timing of the event (if this is a periodic trigger).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateTimeType

public boolean hasTimingDateTimeType()

hasTiming

public boolean hasTiming()

setTiming

public TriggerDefinition setTiming(DataType value)

Parameters:

value - timing (The timing of the event (if this is a periodic trigger).)

getData

public List<DataRequirement> getData()

Returns:

data (The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.)

setData

public TriggerDefinition setData(List<DataRequirement> theData)

Returns:

Returns a reference to this for easy method chaining

hasData

public boolean hasData()

addData

public DataRequirement addData()

addData

public TriggerDefinition addData(DataRequirement t)

getDataFirstRep

public DataRequirement getDataFirstRep()

Returns:

The first repetition of repeating field data, creating it if it does not already exist {3}

getCondition

public Expression getCondition()

Returns:

condition (A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.)

hasCondition

public boolean hasCondition()

setCondition

public TriggerDefinition setCondition(Expression value)

Parameters:

value - condition (A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

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

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

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 DataType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public TriggerDefinition copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(TriggerDefinition dst)

typedCopy

protected TriggerDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element