Package org.linuxforhealth.fhir.model.resource

Class SubscriptionTopic.Builder

    • Method Detail

      • id

        public SubscriptionTopic.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public SubscriptionTopic.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public SubscriptionTopic.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public SubscriptionTopic.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public SubscriptionTopic.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public SubscriptionTopic.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public SubscriptionTopic.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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. If any of the elements are null, calling build() will fail.

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

      • extension

        public SubscriptionTopic.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public SubscriptionTopic.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public SubscriptionTopic.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • url

        public SubscriptionTopic.Builder url​(Uri url)
        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.

        This element is required.

        Parameters:
        url - Canonical identifier for this subscription topic definition, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • identifier

        public SubscriptionTopic.Builder identifier​(Identifier... identifier)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Business Identifier for this subscription topic
        Returns:
        A reference to this Builder instance

      • identifier

        public SubscriptionTopic.Builder identifier​(java.util.Collection<Identifier> identifier)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Business Identifier for this subscription topic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public SubscriptionTopic.Builder version​(String version)
        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.
        Parameters:
        version - Business version of the subscription topic
        Returns:
        A reference to this Builder instance

      • title

        public SubscriptionTopic.Builder title​(String title)
        A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
        Parameters:
        title - Name for this subscription topic (Human friendly)
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public SubscriptionTopic.Builder derivedFrom​(Canonical... derivedFrom)
        The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        derivedFrom - Based on FHIR protocol or definition
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public SubscriptionTopic.Builder derivedFrom​(java.util.Collection<Canonical> derivedFrom)
        The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        derivedFrom - Based on FHIR protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public SubscriptionTopic.Builder status​(PublicationStatus status)
        The current state of the SubscriptionTopic.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public SubscriptionTopic.Builder experimental​(Boolean 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.
        Parameters:
        experimental - If for testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public SubscriptionTopic.Builder date​(DateTime 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.
        Parameters:
        date - Date status first applied
        Returns:
        A reference to this Builder instance

      • publisher

        public SubscriptionTopic.Builder publisher​(String publisher)
        Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
        Parameters:
        publisher - The name of the individual or organization that published the SubscriptionTopic
        Returns:
        A reference to this Builder instance

      • contact

        public SubscriptionTopic.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public SubscriptionTopic.Builder contact​(java.util.Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public SubscriptionTopic.Builder description​(Markdown description)
        A free text natural language description of the Topic from the consumer's perspective.
        Parameters:
        description - Natural language description of the SubscriptionTopic
        Returns:
        A reference to this Builder instance

      • useContext

        public SubscriptionTopic.Builder useContext​(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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - Content intends to support these contexts
        Returns:
        A reference to this Builder instance

      • useContext

        public SubscriptionTopic.Builder useContext​(java.util.Collection<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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - Content intends to support these contexts
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public SubscriptionTopic.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A jurisdiction in which the Topic is intended to be used.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction of the SubscriptionTopic (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public SubscriptionTopic.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A jurisdiction in which the Topic is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction of the SubscriptionTopic (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public SubscriptionTopic.Builder purpose​(Markdown purpose)
        Explains why this Topic is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this SubscriptionTopic is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public SubscriptionTopic.Builder copyright​(Markdown 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.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • approvalDate

        public SubscriptionTopic.Builder approvalDate​(Date approvalDate)
        The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Parameters:
        approvalDate - When SubscriptionTopic is/was approved by publisher
        Returns:
        A reference to this Builder instance

      • lastReviewDate

        public SubscriptionTopic.Builder lastReviewDate​(Date lastReviewDate)
        The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
        Parameters:
        lastReviewDate - Date the Subscription Topic was last reviewed by the publisher
        Returns:
        A reference to this Builder instance

      • effectivePeriod

        public SubscriptionTopic.Builder effectivePeriod​(Period effectivePeriod)
        The period during which the SubscriptionTopic content was or is planned to be effective.
        Parameters:
        effectivePeriod - The effective date range for the SubscriptionTopic
        Returns:
        A reference to this Builder instance

      • resourceTrigger

        public SubscriptionTopic.Builder resourceTrigger​(SubscriptionTopic.ResourceTrigger... 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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        resourceTrigger - Definition of a resource-based trigger for the subscription topic
        Returns:
        A reference to this Builder instance

      • resourceTrigger

        public SubscriptionTopic.Builder resourceTrigger​(java.util.Collection<SubscriptionTopic.ResourceTrigger> 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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        resourceTrigger - Definition of a resource-based trigger for the subscription topic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • eventTrigger

        public SubscriptionTopic.Builder eventTrigger​(SubscriptionTopic.EventTrigger... eventTrigger)
        Event definition which can be used to trigger the SubscriptionTopic.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        eventTrigger - Event definitions the SubscriptionTopic
        Returns:
        A reference to this Builder instance

      • eventTrigger

        public SubscriptionTopic.Builder eventTrigger​(java.util.Collection<SubscriptionTopic.EventTrigger> eventTrigger)
        Event definition which can be used to trigger the SubscriptionTopic.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        eventTrigger - Event definitions the SubscriptionTopic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • canFilterBy

        public SubscriptionTopic.Builder canFilterBy​(SubscriptionTopic.CanFilterBy... canFilterBy)
        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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        canFilterBy - Properties by which a Subscription can filter notifications from the SubscriptionTopic
        Returns:
        A reference to this Builder instance

      • canFilterBy

        public SubscriptionTopic.Builder canFilterBy​(java.util.Collection<SubscriptionTopic.CanFilterBy> canFilterBy)
        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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        canFilterBy - Properties by which a Subscription can filter notifications from the SubscriptionTopic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • notificationShape

        public SubscriptionTopic.Builder notificationShape​(SubscriptionTopic.NotificationShape... notificationShape)
        List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        notificationShape - Properties for describing the shape of notifications generated by this topic
        Returns:
        A reference to this Builder instance

      • notificationShape

        public SubscriptionTopic.Builder notificationShape​(java.util.Collection<SubscriptionTopic.NotificationShape> notificationShape)
        List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        notificationShape - Properties for describing the shape of notifications generated by this topic
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null