Package com.babylonhealth.lit.hl7_java.builders

Class ResearchStudyBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.RESEARCH_STUDY_STATUS status)
        Required fields for ResearchStudy
        Parameters:
        status - - The current state of the study.

    • Method Detail

      • withId

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

      • withMeta

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

      • withMeta

        public ResearchStudyBuilder.Impl withMeta​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

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

      • withSite

        public ResearchStudyBuilder.Impl withSite​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Reference... site)
        Parameters:
        site - - A facility in which study activities are conducted.

      • withSite

        public ResearchStudyBuilder.Impl withSite​(@NonNull
                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> site)
        Parameters:
        site - - A facility in which study activities are conducted.

      • withSite

        public ResearchStudyBuilder.Impl withSite​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... site)

      • withNote

        public ResearchStudyBuilder.Impl withNote​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Annotation... note)
        Parameters:
        note - - Comments made about the study by the performer, subject or other participants.

      • withNote

        public ResearchStudyBuilder.Impl withNote​(@NonNull
                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Annotation> note)
        Parameters:
        note - - Comments made about the study by the performer, subject or other participants.

      • withNote

        public ResearchStudyBuilder.Impl withNote​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.AnnotationBuilder... note)

      • withTitle

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

      • withPhase

        public ResearchStudyBuilder.Impl withPhase​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.CodeableConcept phase)
        Parameters:
        phase - - The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

      • withPhase

        public ResearchStudyBuilder.Impl withPhase​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder phase)

      • withFocus

        public ResearchStudyBuilder.Impl withFocus​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.CodeableConcept... focus)
        Parameters:
        focus - - The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

      • withFocus

        public ResearchStudyBuilder.Impl withFocus​(@NonNull
                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> focus)
        Parameters:
        focus - - The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

      • withFocus

        public ResearchStudyBuilder.Impl withFocus​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... focus)

      • withPartOf

        public ResearchStudyBuilder.Impl withPartOf​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.Reference... partOf)
        Parameters:
        partOf - - A larger research study of which this particular study is a component or step.

      • withPartOf

        public ResearchStudyBuilder.Impl withPartOf​(@NonNull
                                            @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> partOf)
        Parameters:
        partOf - - A larger research study of which this particular study is a component or step.

      • withPartOf

        public ResearchStudyBuilder.Impl withPartOf​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... partOf)

      • withPeriod

        public ResearchStudyBuilder.Impl withPeriod​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.Period period)
        Parameters:
        period - - Identifies the start date and the expected (or actual, depending on status) end date for the study.

      • withPeriod

        public ResearchStudyBuilder.Impl withPeriod​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.PeriodBuilder period)

      • withContact

        public ResearchStudyBuilder.Impl withContact​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.ContactDetail... contact)
        Parameters:
        contact - - Contact details to assist a user in learning more about or engaging with the study.

      • withContact

        public ResearchStudyBuilder.Impl withContact​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> contact)
        Parameters:
        contact - - Contact details to assist a user in learning more about or engaging with the study.

      • withContact

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

      • withKeyword

        public ResearchStudyBuilder.Impl withKeyword​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.CodeableConcept... keyword)
        Parameters:
        keyword - - Key terms to aid in searching for or filtering the study.

      • withKeyword

        public ResearchStudyBuilder.Impl withKeyword​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> keyword)
        Parameters:
        keyword - - Key terms to aid in searching for or filtering the study.

      • withKeyword

        public ResearchStudyBuilder.Impl withKeyword​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... keyword)

      • withSponsor

        public ResearchStudyBuilder.Impl withSponsor​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference sponsor)
        Parameters:
        sponsor - - An organization that initiates the investigation and is legally responsible for the study.

      • withSponsor

        public ResearchStudyBuilder.Impl withSponsor​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder sponsor)

      • withLanguage

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

      • withProtocol

        public ResearchStudyBuilder.Impl withProtocol​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Reference... protocol)
        Parameters:
        protocol - - The set of steps expected to be performed as part of the execution of the study.

      • withProtocol

        public ResearchStudyBuilder.Impl withProtocol​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> protocol)
        Parameters:
        protocol - - The set of steps expected to be performed as part of the execution of the study.

      • withProtocol

        public ResearchStudyBuilder.Impl withProtocol​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... protocol)

      • withCategory

        public ResearchStudyBuilder.Impl withCategory​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.CodeableConcept... category)
        Parameters:
        category - - Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

      • withCategory

        public ResearchStudyBuilder.Impl withCategory​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> category)
        Parameters:
        category - - Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

      • withCategory

        public ResearchStudyBuilder.Impl withCategory​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... category)

      • withLocation

        public ResearchStudyBuilder.Impl withLocation​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.CodeableConcept... location)
        Parameters:
        location - - Indicates a country, state or other region where the study is taking place.

      • withLocation

        public ResearchStudyBuilder.Impl withLocation​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> location)
        Parameters:
        location - - Indicates a country, state or other region where the study is taking place.

      • withLocation

        public ResearchStudyBuilder.Impl withLocation​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... location)

      • withContained

        public ResearchStudyBuilder.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 ResearchStudyBuilder.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 ResearchStudyBuilder.Impl withContained​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public ResearchStudyBuilder.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 ResearchStudyBuilder.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 ResearchStudyBuilder.Impl withExtension​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withCondition

        public ResearchStudyBuilder.Impl withCondition​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.CodeableConcept... condition)
        Parameters:
        condition - - The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

      • withCondition

        public ResearchStudyBuilder.Impl withCondition​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> condition)
        Parameters:
        condition - - The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

      • withCondition

        public ResearchStudyBuilder.Impl withCondition​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... condition)

      • withIdentifier

        public ResearchStudyBuilder.Impl withIdentifier​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - Identifiers assigned to this research study by the sponsor or other systems.

      • withIdentifier

        public ResearchStudyBuilder.Impl withIdentifier​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - Identifiers assigned to this research study by the sponsor or other systems.

      • withIdentifier

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

      • withEnrollment

        public ResearchStudyBuilder.Impl withEnrollment​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.Reference... enrollment)
        Parameters:
        enrollment - - Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".

      • withEnrollment

        public ResearchStudyBuilder.Impl withEnrollment​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> enrollment)
        Parameters:
        enrollment - - Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".

      • withEnrollment

        public ResearchStudyBuilder.Impl withEnrollment​(@NonNull
                                                @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... enrollment)

      • withDescription

        public ResearchStudyBuilder.Impl withDescription​(@NonNull
                                                 @NonNull java.lang.String description)
        Parameters:
        description - - A full description of how the study is being conducted.

      • withImplicitRules

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

      • withReasonStopped

        public ResearchStudyBuilder.Impl withReasonStopped​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.CodeableConcept reasonStopped)
        Parameters:
        reasonStopped - - A description and/or code explaining the premature termination of the study.

      • withReasonStopped

        public ResearchStudyBuilder.Impl withReasonStopped​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder reasonStopped)

      • withRelatedArtifact

        public ResearchStudyBuilder.Impl withRelatedArtifact​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.RelatedArtifact... relatedArtifact)
        Parameters:
        relatedArtifact - - Citations, references and other related documents.

      • withRelatedArtifact

        public ResearchStudyBuilder.Impl withRelatedArtifact​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.RelatedArtifact> relatedArtifact)
        Parameters:
        relatedArtifact - - Citations, references and other related documents.

      • withRelatedArtifact

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

      • withModifierExtension

        public ResearchStudyBuilder.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 ResearchStudyBuilder.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 ResearchStudyBuilder.Impl withModifierExtension​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withPrimaryPurposeType

        public ResearchStudyBuilder.Impl withPrimaryPurposeType​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core.model.CodeableConcept primaryPurposeType)
        Parameters:
        primaryPurposeType - - The type of study based upon the intent of the study's activities. A classification of the intent of the study.

      • withPrimaryPurposeType

        public ResearchStudyBuilder.Impl withPrimaryPurposeType​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder primaryPurposeType)

      • withPrincipalInvestigator

        public ResearchStudyBuilder.Impl withPrincipalInvestigator​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core.model.Reference principalInvestigator)
        Parameters:
        principalInvestigator - - A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.

      • withPrincipalInvestigator

        public ResearchStudyBuilder.Impl withPrincipalInvestigator​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder principalInvestigator)

      • withArm

        public ResearchStudyBuilder.Impl withArm​(@NonNull
                                         @NonNull com.babylonhealth.lit.hl7.model.ResearchStudy.Arm... arm)
        Parameters:
        arm - - Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

      • withArm

        public ResearchStudyBuilder.Impl withArm​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ResearchStudy.Arm> arm)
        Parameters:
        arm - - Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

      • withObjective

        public ResearchStudyBuilder.Impl withObjective​(@NonNull
                                               @NonNull com.babylonhealth.lit.hl7.model.ResearchStudy.Objective... objective)
        Parameters:
        objective - - A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

      • withObjective

        public ResearchStudyBuilder.Impl withObjective​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ResearchStudy.Objective> objective)
        Parameters:
        objective - - A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

      • build

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