Package com.babylonhealth.lit.hl7_java.builders

Class ResearchDefinitionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            com.babylonhealth.lit.core.model.Reference population)
        Required fields for ResearchDefinition
        Parameters:
        status - - The status of this research definition. Enables tracking the life-cycle of the content.
        population - - A reference to a ResearchElementDefinition resource that defines the population for the research.

    • Method Detail

      • withId

        public ResearchDefinitionBuilder.Impl withId​(@NonNull
                                             @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withUrl

        public ResearchDefinitionBuilder.Impl withUrl​(@NonNull
                                              @NonNull java.lang.String url)
        Parameters:
        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.

      • withMeta

        public ResearchDefinitionBuilder.Impl withMeta​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        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.

      • withText

        public ResearchDefinitionBuilder.Impl withText​(@NonNull
                                               @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        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.

      • withName

        public ResearchDefinitionBuilder.Impl withName​(@NonNull
                                               @NonNull java.lang.String name)
        Parameters:
        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.

      • withDate

        public ResearchDefinitionBuilder.Impl withDate​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.FHIRDateTime date)
        Parameters:
        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.

      • withTitle

        public ResearchDefinitionBuilder.Impl withTitle​(@NonNull
                                                @NonNull java.lang.String title)
        Parameters:
        title - - A short, descriptive, user-friendly title for the research definition.

      • withUsage

        public ResearchDefinitionBuilder.Impl withUsage​(@NonNull
                                                @NonNull java.lang.String usage)
        Parameters:
        usage - - A detailed description, from a clinical perspective, of how the ResearchDefinition is used.

      • withTopic

        public ResearchDefinitionBuilder.Impl withTopic​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.CodeableConcept... topic)
        Parameters:
        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.

      • withTopic

        public ResearchDefinitionBuilder.Impl withTopic​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> topic)
        Parameters:
        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.

      • withTopic

        public ResearchDefinitionBuilder.Impl withTopic​(@NonNull
                                                @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... topic)

      • withAuthor

        public ResearchDefinitionBuilder.Impl withAuthor​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.ContactDetail... author)
        Parameters:
        author - - An individiual or organization primarily involved in the creation and maintenance of the content.

      • withAuthor

        public ResearchDefinitionBuilder.Impl withAuthor​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> author)
        Parameters:
        author - - An individiual or organization primarily involved in the creation and maintenance of the content.

      • withAuthor

        public ResearchDefinitionBuilder.Impl withAuthor​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... author)

      • withEditor

        public ResearchDefinitionBuilder.Impl withEditor​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.ContactDetail... editor)
        Parameters:
        editor - - An individual or organization primarily responsible for internal coherence of the content.

      • withEditor

        public ResearchDefinitionBuilder.Impl withEditor​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> editor)
        Parameters:
        editor - - An individual or organization primarily responsible for internal coherence of the content.

      • withEditor

        public ResearchDefinitionBuilder.Impl withEditor​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... editor)

      • withVersion

        public ResearchDefinitionBuilder.Impl withVersion​(@NonNull
                                                  @NonNull java.lang.String version)
        Parameters:
        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.

      • withContact

        public ResearchDefinitionBuilder.Impl withContact​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.ContactDetail... contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public ResearchDefinitionBuilder.Impl withContact​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public ResearchDefinitionBuilder.Impl withContact​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... contact)

      • withComment

        public ResearchDefinitionBuilder.Impl withComment​(@NonNull
                                                  @NonNull java.lang.String... comment)
        Parameters:
        comment - - A human-readable string to clarify or explain concepts about the resource.

      • withComment

        public ResearchDefinitionBuilder.Impl withComment​(@NonNull
                                                  @NonNull java.util.Collection<java.lang.String> comment)
        Parameters:
        comment - - A human-readable string to clarify or explain concepts about the resource.

      • withPurpose

        public ResearchDefinitionBuilder.Impl withPurpose​(@NonNull
                                                  @NonNull java.lang.String purpose)
        Parameters:
        purpose - - Explanation of why this research definition is needed and why it has been designed as it has.

      • withLibrary

        public ResearchDefinitionBuilder.Impl withLibrary​(@NonNull
                                                  @NonNull java.lang.String... library)
        Parameters:
        library - - A reference to a Library resource containing the formal logic used by the ResearchDefinition.

      • withLibrary

        public ResearchDefinitionBuilder.Impl withLibrary​(@NonNull
                                                  @NonNull java.util.Collection<java.lang.String> library)
        Parameters:
        library - - A reference to a Library resource containing the formal logic used by the ResearchDefinition.

      • withOutcome

        public ResearchDefinitionBuilder.Impl withOutcome​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.Reference outcome)
        Parameters:
        outcome - - A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

      • withOutcome

        public ResearchDefinitionBuilder.Impl withOutcome​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder outcome)

      • withLanguage

        public ResearchDefinitionBuilder.Impl withLanguage​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withSubtitle

        public ResearchDefinitionBuilder.Impl withSubtitle​(@NonNull
                                                   @NonNull java.lang.String subtitle)
        Parameters:
        subtitle - - An explanatory or alternate title for the ResearchDefinition giving additional information about its content.

      • withReviewer

        public ResearchDefinitionBuilder.Impl withReviewer​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.ContactDetail... reviewer)
        Parameters:
        reviewer - - An individual or organization primarily responsible for review of some aspect of the content.

      • withReviewer

        public ResearchDefinitionBuilder.Impl withReviewer​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> reviewer)
        Parameters:
        reviewer - - An individual or organization primarily responsible for review of some aspect of the content.

      • withReviewer

        public ResearchDefinitionBuilder.Impl withReviewer​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... reviewer)

      • withEndorser

        public ResearchDefinitionBuilder.Impl withEndorser​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.ContactDetail... endorser)
        Parameters:
        endorser - - An individual or organization responsible for officially endorsing the content for use in some setting.

      • withEndorser

        public ResearchDefinitionBuilder.Impl withEndorser​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> endorser)
        Parameters:
        endorser - - An individual or organization responsible for officially endorsing the content for use in some setting.

      • withEndorser

        public ResearchDefinitionBuilder.Impl withEndorser​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... endorser)

      • withExposure

        public ResearchDefinitionBuilder.Impl withExposure​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Reference exposure)
        Parameters:
        exposure - - A reference to a ResearchElementDefinition resource that defines the exposure for the research.

      • withExposure

        public ResearchDefinitionBuilder.Impl withExposure​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder exposure)

      • withContained

        public ResearchDefinitionBuilder.Impl withContained​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        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.

      • withContained

        public ResearchDefinitionBuilder.Impl withContained​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        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.

      • withContained

        public ResearchDefinitionBuilder.Impl withContained​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public ResearchDefinitionBuilder.Impl withExtension​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public ResearchDefinitionBuilder.Impl withExtension​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public ResearchDefinitionBuilder.Impl withExtension​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withPublisher

        public ResearchDefinitionBuilder.Impl withPublisher​(@NonNull
                                                    @NonNull java.lang.String publisher)
        Parameters:
        publisher - - The name of the organization or individual that published the research definition.

      • withCopyright

        public ResearchDefinitionBuilder.Impl withCopyright​(@NonNull
                                                    @NonNull java.lang.String copyright)
        Parameters:
        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.

      • withIdentifier

        public ResearchDefinitionBuilder.Impl withIdentifier​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        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.

      • withIdentifier

        public ResearchDefinitionBuilder.Impl withIdentifier​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        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.

      • withIdentifier

        public ResearchDefinitionBuilder.Impl withIdentifier​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder... identifier)

      • withShortTitle

        public ResearchDefinitionBuilder.Impl withShortTitle​(@NonNull
                                                     @NonNull java.lang.String shortTitle)
        Parameters:
        shortTitle - - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

      • withSubject

        public ResearchDefinitionBuilder.Impl withSubject​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.model.Unions.ChoiceCodeableConceptOrReference subject)
        Parameters:
        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. Field is a 'choice' field. Type should be one of CodeableConcept, Reference. To pass the value in, wrap with one of the ResearchDefinitionBuilder.subject static methods

      • withUseContext

        public ResearchDefinitionBuilder.Impl withUseContext​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.UsageContext... useContext)
        Parameters:
        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.

      • withUseContext

        public ResearchDefinitionBuilder.Impl withUseContext​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.UsageContext> useContext)
        Parameters:
        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.

      • withUseContext

        public ResearchDefinitionBuilder.Impl withUseContext​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.UsageContextBuilder... useContext)

      • withDescription

        public ResearchDefinitionBuilder.Impl withDescription​(@NonNull
                                                      @NonNull java.lang.String description)
        Parameters:
        description - - A free text natural language description of the research definition from a consumer's perspective.

      • withExperimental

        public ResearchDefinitionBuilder.Impl withExperimental​(@NonNull
                                                       @NonNull java.lang.Boolean experimental)
        Parameters:
        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.

      • withJurisdiction

        public ResearchDefinitionBuilder.Impl withJurisdiction​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core.model.CodeableConcept... jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the research definition is intended to be used.

      • withJurisdiction

        public ResearchDefinitionBuilder.Impl withJurisdiction​(@NonNull
                                                       @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the research definition is intended to be used.

      • withJurisdiction

        public ResearchDefinitionBuilder.Impl withJurisdiction​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... jurisdiction)

      • withApprovalDate

        public ResearchDefinitionBuilder.Impl withApprovalDate​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core.FHIRDate approvalDate)
        Parameters:
        approvalDate - - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

      • withImplicitRules

        public ResearchDefinitionBuilder.Impl withImplicitRules​(@NonNull
                                                        @NonNull java.lang.String implicitRules)
        Parameters:
        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.

      • withLastReviewDate

        public ResearchDefinitionBuilder.Impl withLastReviewDate​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core.FHIRDate lastReviewDate)
        Parameters:
        lastReviewDate - - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

      • withEffectivePeriod

        public ResearchDefinitionBuilder.Impl withEffectivePeriod​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core.model.Period effectivePeriod)
        Parameters:
        effectivePeriod - - The period during which the research definition content was or is planned to be in active use.

      • withEffectivePeriod

        public ResearchDefinitionBuilder.Impl withEffectivePeriod​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core_java.builders.PeriodBuilder effectivePeriod)

      • withRelatedArtifact

        public ResearchDefinitionBuilder.Impl withRelatedArtifact​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core.model.RelatedArtifact... relatedArtifact)
        Parameters:
        relatedArtifact - - Related artifacts such as additional documentation, justification, or bibliographic references.

      • withRelatedArtifact

        public ResearchDefinitionBuilder.Impl withRelatedArtifact​(@NonNull
                                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.RelatedArtifact> relatedArtifact)
        Parameters:
        relatedArtifact - - Related artifacts such as additional documentation, justification, or bibliographic references.

      • withRelatedArtifact

        public ResearchDefinitionBuilder.Impl withRelatedArtifact​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core_java.builders.RelatedArtifactBuilder... relatedArtifact)

      • withModifierExtension

        public ResearchDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                            @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ResearchDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                            @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ResearchDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                            @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withExposureAlternative

        public ResearchDefinitionBuilder.Impl withExposureAlternative​(@NonNull
                                                              @NonNull com.babylonhealth.lit.core.model.Reference exposureAlternative)
        Parameters:
        exposureAlternative - - A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.

      • withExposureAlternative

        public ResearchDefinitionBuilder.Impl withExposureAlternative​(@NonNull
                                                              @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder exposureAlternative)

      • build

        public com.babylonhealth.lit.hl7.model.ResearchDefinition build()
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface ResearchDefinitionBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder