Package com.ibm.fhir.model.resource

Class ResearchDefinition.Builder

    • Method Detail

      • id

        public ResearchDefinition.Builder id​(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 ResearchDefinition.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 ResearchDefinition.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 ResearchDefinition.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 ResearchDefinition.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

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

      • contained

        public ResearchDefinition.Builder contained​(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

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

      • extension

        public ResearchDefinition.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

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

      • extension

        public ResearchDefinition.Builder extension​(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

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

      • modifierExtension

        public ResearchDefinition.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

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

      • modifierExtension

        public ResearchDefinition.Builder modifierExtension​(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

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

      • url

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

      • identifier

        public ResearchDefinition.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this research 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

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

      • identifier

        public ResearchDefinition.Builder identifier​(Collection<Identifier> identifier)
        A formal identifier that is used to identify this research 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

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

      • version

        public ResearchDefinition.Builder version​(String version)
        The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
        Parameters:
        version - Business version of the research definition
        Returns:
        A reference to this Builder instance

      • name

        public ResearchDefinition.Builder name​(String name)
        A natural language name identifying the research 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 research definition (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

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

      • shortTitle

        public ResearchDefinition.Builder shortTitle​(String shortTitle)
        The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
        Parameters:
        shortTitle - Title for use in informal contexts
        Returns:
        A reference to this Builder instance

      • subtitle

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

      • status

        public ResearchDefinition.Builder status​(PublicationStatus status)
        The status of this research 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 ResearchDefinition.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this research 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 ResearchDefinition.Builder subject​(Element subject)
        The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.

        This is a choice element with the following allowed types:

        Parameters:
        subject - E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
        Returns:
        A reference to this Builder instance

      • date

        public ResearchDefinition.Builder date​(DateTime date)
        The date (and optionally time) when the research 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 research definition changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

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

      • contact

        public ResearchDefinition.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

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

      • contact

        public ResearchDefinition.Builder contact​(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

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

      • description

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

      • comment

        public ResearchDefinition.Builder comment​(String... comment)
        A human-readable string to clarify or explain concepts about the resource.

        Adds new element(s) to the existing list

        Parameters:
        comment - Used for footnotes or explanatory notes
        Returns:
        A reference to this Builder instance

      • comment

        public ResearchDefinition.Builder comment​(Collection<String> comment)
        A human-readable string to clarify or explain concepts about the resource.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        comment - Used for footnotes or explanatory notes
        Returns:
        A reference to this Builder instance

      • useContext

        public ResearchDefinition.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 research definition instances.

        Adds new element(s) to the existing list

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

      • useContext

        public ResearchDefinition.Builder useContext​(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 research definition instances.

        Replaces the existing list with a new one containing elements from the Collection

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

      • jurisdiction

        public ResearchDefinition.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the research definition is intended to be used.

        Adds new element(s) to the existing list

        Parameters:
        jurisdiction - Intended jurisdiction for research definition (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public ResearchDefinition.Builder jurisdiction​(Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the research definition is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        jurisdiction - Intended jurisdiction for research definition (if applicable)
        Returns:
        A reference to this Builder instance

      • purpose

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

      • usage

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

      • copyright

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

      • approvalDate

        public ResearchDefinition.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 research definition was approved by publisher
        Returns:
        A reference to this Builder instance

      • lastReviewDate

        public ResearchDefinition.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 research definition was last reviewed
        Returns:
        A reference to this Builder instance

      • effectivePeriod

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

      • topic

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

        Adds new element(s) to the existing list

        Parameters:
        topic - The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
        Returns:
        A reference to this Builder instance

      • topic

        public ResearchDefinition.Builder topic​(Collection<CodeableConcept> topic)
        Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        topic - The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
        Returns:
        A reference to this Builder instance

      • author

        public ResearchDefinition.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

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

      • author

        public ResearchDefinition.Builder author​(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

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

      • editor

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

        Adds new element(s) to the existing list

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

      • editor

        public ResearchDefinition.Builder editor​(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

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

      • reviewer

        public ResearchDefinition.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

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

      • reviewer

        public ResearchDefinition.Builder reviewer​(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

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

      • endorser

        public ResearchDefinition.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

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

      • endorser

        public ResearchDefinition.Builder endorser​(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

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

      • relatedArtifact

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

        Adds new element(s) to the existing list

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

      • relatedArtifact

        public ResearchDefinition.Builder relatedArtifact​(Collection<RelatedArtifact> relatedArtifact)
        Related artifacts such as additional documentation, justification, or bibliographic references.

        Replaces the existing list with a new one containing elements from the Collection

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

      • library

        public ResearchDefinition.Builder library​(Canonical... library)
        A reference to a Library resource containing the formal logic used by the ResearchDefinition.

        Adds new element(s) to the existing list

        Parameters:
        library - Logic used by the ResearchDefinition
        Returns:
        A reference to this Builder instance

      • library

        public ResearchDefinition.Builder library​(Collection<Canonical> library)
        A reference to a Library resource containing the formal logic used by the ResearchDefinition.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        library - Logic used by the ResearchDefinition
        Returns:
        A reference to this Builder instance

      • population

        public ResearchDefinition.Builder population​(Reference population)
        A reference to a ResearchElementDefinition resource that defines the population for the research.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        population - What population?
        Returns:
        A reference to this Builder instance

      • exposure

        public ResearchDefinition.Builder exposure​(Reference exposure)
        A reference to a ResearchElementDefinition resource that defines the exposure for the research.

        Allowed resource types for this reference:

        Parameters:
        exposure - What exposure?
        Returns:
        A reference to this Builder instance

      • exposureAlternative

        public ResearchDefinition.Builder exposureAlternative​(Reference exposureAlternative)
        A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.

        Allowed resource types for this reference:

        Parameters:
        exposureAlternative - What alternative exposure state?
        Returns:
        A reference to this Builder instance

      • outcome

        public ResearchDefinition.Builder outcome​(Reference outcome)
        A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

        Allowed resource types for this reference:

        Parameters:
        outcome - What outcome?
        Returns:
        A reference to this Builder instance