Package com.ibm.fhir.model.type

Class TriggerDefinition.Builder

    • Method Detail

      • id

        public TriggerDefinition.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public TriggerDefinition.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public TriggerDefinition.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • type

        public TriggerDefinition.Builder type​(TriggerType type)
        The type of triggering event.

        This element is required.

        Parameters:
        type - named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
        Returns:
        A reference to this Builder instance

      • name

        public TriggerDefinition.Builder name​(String 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.
        Parameters:
        name - Name or URI that identifies the event
        Returns:
        A reference to this Builder instance

      • timing

        public TriggerDefinition.Builder timing​(Element timing)
        The timing of the event (if this is a periodic trigger).

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        • Schedule
        Parameters:
        timing - Timing of the event
        Returns:
        A reference to this Builder instance

      • data

        public TriggerDefinition.Builder data​(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.

        Adds new element(s) to the existing list

        Parameters:
        data - Triggering data of the event (multiple = 'and')
        Returns:
        A reference to this Builder instance

      • data

        public TriggerDefinition.Builder data​(Collection<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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        data - Triggering data of the event (multiple = 'and')
        Returns:
        A reference to this Builder instance

      • condition

        public TriggerDefinition.Builder condition​(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.
        Parameters:
        condition - Whether the event triggers (boolean expression)
        Returns:
        A reference to this Builder instance