Package org.linuxforhealth.fhir.model.resource

Class SubscriptionTopic

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class SubscriptionTopic
extends DomainResource
    Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.

    Maturity level: FMM0 (draft)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.
        Returns:
        An immutable object of type Uri that is non-null.

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
        Returns:
        An immutable object of type String that may be null.

      • getDerivedFrom

        public java.util.List<Canonical> getDerivedFrom()
        The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getExperimental

        public Boolean getExperimental()
        A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the Topic from the consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A jurisdiction in which the Topic is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explains why this Topic is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
        Returns:
        An immutable object of type Markdown that may be null.

      • getApprovalDate

        public Date getApprovalDate()
        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Returns:
        An immutable object of type Date that may be null.

      • getLastReviewDate

        public Date getLastReviewDate()
        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
        Returns:
        An immutable object of type Date that may be null.

      • getEffectivePeriod

        public Period getEffectivePeriod()
        The period during which the SubscriptionTopic content was or is planned to be effective.
        Returns:
        An immutable object of type Period that may be null.

      • getResourceTrigger

        public java.util.List<SubscriptionTopic.ResourceTrigger> getResourceTrigger()
        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).
        Returns:
        An unmodifiable list containing immutable objects of type SubscriptionTopic.ResourceTrigger that may be empty.

      • getCanFilterBy

        public java.util.List<SubscriptionTopic.CanFilterBy> getCanFilterBy()
        List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).
        Returns:
        An unmodifiable list containing immutable objects of type SubscriptionTopic.CanFilterBy that may be empty.

      • 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