Package com.ibm.fhir.model.resource

Class EventDefinition.Builder

    • Method Detail

      • id

        public EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.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 EventDefinition.Builder url​(Uri url)
        An absolute URI that is used to identify this event definition 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 event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
        Parameters:
        url - Canonical identifier for this event definition, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • identifier

        public EventDefinition.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

        Parameters:
        identifier - Additional identifier for the event definition
        Returns:
        A reference to this Builder instance

      • identifier

        public EventDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

        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 - Additional identifier for the event definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public EventDefinition.Builder version​(String version)
        The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition 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 can be placed in a lexicographical sequence.
        Parameters:
        version - Business version of the event definition
        Returns:
        A reference to this Builder instance

      • name

        public EventDefinition.Builder name​(String name)
        A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Parameters:
        name - Name for this event definition (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public EventDefinition.Builder title​(String title)
        A short, descriptive, user-friendly title for the event definition.
        Parameters:
        title - Name for this event definition (human friendly)
        Returns:
        A reference to this Builder instance

      • subtitle

        public EventDefinition.Builder subtitle​(String subtitle)
        An explanatory or alternate title for the event definition giving additional information about its content.
        Parameters:
        subtitle - Subordinate title of the event definition
        Returns:
        A reference to this Builder instance

      • status

        public EventDefinition.Builder status​(PublicationStatus status)
        The status of this event definition. Enables tracking the life-cycle of the content.

        This element is required.

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

      • experimental

        public EventDefinition.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • subject

        public EventDefinition.Builder subject​(Element subject)
        A code or group definition that describes the intended subject of the event definition.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        subject - Type of individual the event definition is focused on
        Returns:
        A reference to this Builder instance

      • date

        public EventDefinition.Builder date​(DateTime date)
        The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public EventDefinition.Builder publisher​(String publisher)
        The name of the organization or individual that published the event definition.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public EventDefinition.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 EventDefinition.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 EventDefinition.Builder description​(Markdown description)
        A free text natural language description of the event definition from a consumer's perspective.
        Parameters:
        description - Natural language description of the event definition
        Returns:
        A reference to this Builder instance

      • useContext

        public EventDefinition.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.

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

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public EventDefinition.Builder useContext​(java.util.Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.

        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 - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public EventDefinition.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the event definition 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 for event definition (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public EventDefinition.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the event definition 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 for event definition (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public EventDefinition.Builder purpose​(Markdown purpose)
        Explanation of why this event definition is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this event definition is defined
        Returns:
        A reference to this Builder instance

      • usage

        public EventDefinition.Builder usage​(String usage)
        A detailed description of how the event definition is used from a clinical perspective.
        Parameters:
        usage - Describes the clinical usage of the event definition
        Returns:
        A reference to this Builder instance

      • copyright

        public EventDefinition.Builder copyright​(Markdown copyright)
        A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • approvalDate

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

      • lastReviewDate

        public EventDefinition.Builder lastReviewDate​(Date lastReviewDate)
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Parameters:
        lastReviewDate - When the event definition was last reviewed
        Returns:
        A reference to this Builder instance

      • effectivePeriod

        public EventDefinition.Builder effectivePeriod​(Period effectivePeriod)
        The period during which the event definition content was or is planned to be in active use.
        Parameters:
        effectivePeriod - When the event definition is expected to be used
        Returns:
        A reference to this Builder instance

      • topic

        public EventDefinition.Builder topic​(CodeableConcept... topic)
        Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

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

        Parameters:
        topic - E.g. Education, Treatment, Assessment, etc.
        Returns:
        A reference to this Builder instance

      • topic

        public EventDefinition.Builder topic​(java.util.Collection<CodeableConcept> topic)
        Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

        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:
        topic - E.g. Education, Treatment, Assessment, etc.
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • author

        public EventDefinition.Builder author​(ContactDetail... author)
        An individiual or organization primarily involved in the creation and maintenance of the content.

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

        Parameters:
        author - Who authored the content
        Returns:
        A reference to this Builder instance

      • author

        public EventDefinition.Builder author​(java.util.Collection<ContactDetail> author)
        An individiual or organization primarily involved in the creation and maintenance of the content.

        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:
        author - Who authored the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • editor

        public EventDefinition.Builder editor​(ContactDetail... editor)
        An individual or organization primarily responsible for internal coherence of the content.

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

        Parameters:
        editor - Who edited the content
        Returns:
        A reference to this Builder instance

      • editor

        public EventDefinition.Builder editor​(java.util.Collection<ContactDetail> editor)
        An individual or organization primarily responsible for internal coherence of the content.

        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:
        editor - Who edited the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reviewer

        public EventDefinition.Builder reviewer​(ContactDetail... reviewer)
        An individual or organization primarily responsible for review of some aspect of the content.

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

        Parameters:
        reviewer - Who reviewed the content
        Returns:
        A reference to this Builder instance

      • reviewer

        public EventDefinition.Builder reviewer​(java.util.Collection<ContactDetail> reviewer)
        An individual or organization primarily responsible for review of some aspect of the content.

        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:
        reviewer - Who reviewed the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • endorser

        public EventDefinition.Builder endorser​(ContactDetail... endorser)
        An individual or organization responsible for officially endorsing the content for use in some setting.

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

        Parameters:
        endorser - Who endorsed the content
        Returns:
        A reference to this Builder instance

      • endorser

        public EventDefinition.Builder endorser​(java.util.Collection<ContactDetail> endorser)
        An individual or organization responsible for officially endorsing the content for use in some setting.

        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:
        endorser - Who endorsed the content
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatedArtifact

        public EventDefinition.Builder relatedArtifact​(RelatedArtifact... relatedArtifact)
        Related resources such as additional documentation, justification, or bibliographic references.

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

        Parameters:
        relatedArtifact - Additional documentation, citations, etc.
        Returns:
        A reference to this Builder instance

      • relatedArtifact

        public EventDefinition.Builder relatedArtifact​(java.util.Collection<RelatedArtifact> relatedArtifact)
        Related resources such as additional documentation, justification, or bibliographic references.

        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:
        relatedArtifact - Additional documentation, citations, etc.
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • trigger

        public EventDefinition.Builder trigger​(TriggerDefinition... trigger)
        The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

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

        This element is required.

        Parameters:
        trigger - "when" the event occurs (multiple = 'or')
        Returns:
        A reference to this Builder instance

      • trigger

        public EventDefinition.Builder trigger​(java.util.Collection<TriggerDefinition> trigger)
        The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

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

        This element is required.

        Parameters:
        trigger - "when" the event occurs (multiple = 'or')
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null