Package org.linuxforhealth.fhir.model.resource

Class SubscriptionTopic.ResourceTrigger

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    SubscriptionTopic
    public static class SubscriptionTopic.ResourceTrigger
extends BackboneElement
    A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

    • Method Detail

      • getDescription

        public Markdown getDescription()
        The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".
        Returns:
        An immutable object of type Markdown that may be null.

      • getResource

        public Uri getResource()
        URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href=" elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>.
        Returns:
        An immutable object of type Uri that is non-null.

      • getSupportedInteraction

        public java.util.List<MethodCode> getSupportedInteraction()
        The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE).
        Returns:
        An unmodifiable list containing immutable objects of type MethodCode that may be empty.

      • getFhirPathCriteria

        public String getFhirPathCriteria()
        The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
        Returns:
        An immutable object of type String that may be null.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object