Class SubscriptionTopic

  • 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 SubscriptionTopic
    extends DomainResource
    Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
      • identifier

        protected List<Identifier> identifier
        Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
      • version

        protected StringType version
        The identifier that is used to identify this version of the SubscriptionTopic 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.
      • title

        protected StringType title
        A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
      • derivedFrom

        protected List<CanonicalType> derivedFrom
        The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
      • experimental

        protected BooleanType experimental
        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.
      • date

        protected DateTimeType date
        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.
      • publisher

        protected StringType publisher
        Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
      • contact

        protected List<ContactDetail> contact
        Contact details to assist a user in finding and communicating with the publisher.
      • description

        protected MarkdownType description
        A free text natural language description of the Topic from the consumer's perspective.
      • useContext

        protected List<UsageContext> useContext
        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.
      • purpose

        protected MarkdownType purpose
        Explains why this Topic is needed and why it has been designed as it has.
      • copyright

        protected MarkdownType copyright
        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.
      • approvalDate

        protected DateType approvalDate
        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • lastReviewDate

        protected DateType lastReviewDate
        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      • effectivePeriod

        protected Period effectivePeriod
        The period during which the SubscriptionTopic content was or is planned to be effective.
      • resourceTrigger

        protected List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> resourceTrigger
        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).
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Date status first applied
        Type: date
        Path: SubscriptionTopic.date

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: Date status first applied
        Type: date
        Path: SubscriptionTopic.date

      • SP_DERIVED_OR_SELF

        public static final String SP_DERIVED_OR_SELF
        Search parameter: derived-or-self

        Description: A server defined search that matches either the url or derivedFrom
        Type: uri
        Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom

        See Also:
        Constant Field Values
      • DERIVED_OR_SELF

        public static final ca.uhn.fhir.rest.gclient.UriClientParam DERIVED_OR_SELF
        Fluent Client search parameter constant for derived-or-self

        Description: A server defined search that matches either the url or derivedFrom
        Type: uri
        Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Business Identifier for SubscriptionTopic
        Type: token
        Path: SubscriptionTopic.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: Business Identifier for SubscriptionTopic
        Type: token
        Path: SubscriptionTopic.identifier

      • SP_RESOURCE

        public static final String SP_RESOURCE
        Search parameter: resource

        Description: Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.
        Type: uri
        Path: SubscriptionTopic.resourceTrigger.resource

        See Also:
        Constant Field Values
      • RESOURCE

        public static final ca.uhn.fhir.rest.gclient.UriClientParam RESOURCE
        Fluent Client search parameter constant for resource

        Description: Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.
        Type: uri
        Path: SubscriptionTopic.resourceTrigger.resource

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: draft | active | retired | unknown
        Type: token
        Path: SubscriptionTopic.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: draft | active | retired | unknown
        Type: token
        Path: SubscriptionTopic.status

      • SP_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: Name for this SubscriptionTopic (Human friendly)
        Type: string
        Path: SubscriptionTopic.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: Name for this SubscriptionTopic (Human friendly)
        Type: string
        Path: SubscriptionTopic.title

      • SP_TRIGGER_DESCRIPTION

        public static final String SP_TRIGGER_DESCRIPTION
        Search parameter: trigger-description

        Description: Text representation of the trigger
        Type: string
        Path: SubscriptionTopic.resourceTrigger.description

        See Also:
        Constant Field Values
      • TRIGGER_DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TRIGGER_DESCRIPTION
        Fluent Client search parameter constant for trigger-description

        Description: Text representation of the trigger
        Type: string
        Path: SubscriptionTopic.resourceTrigger.description

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Logical canonical URL to reference this SubscriptionTopic (globally unique)
        Type: uri
        Path: SubscriptionTopic.url

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Logical canonical URL to reference this SubscriptionTopic (globally unique)
        Type: uri
        Path: SubscriptionTopic.url

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: Business version of the SubscriptionTopic
        Type: token
        Path: SubscriptionTopic.version

        See Also:
        Constant Field Values
      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

        Description: Business version of the SubscriptionTopic
        Type: token
        Path: SubscriptionTopic.version