Package com.babylonhealth.lit.hl7_java.builders

Class CarePlanBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.REQUEST_STATUS status,
            com.babylonhealth.lit.hl7.CARE_PLAN_INTENT intent,
            com.babylonhealth.lit.core.model.Reference subject)
        Required fields for CarePlan
        Parameters:
        status - - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
        intent - - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
        subject - - Identifies the patient or group whose intended care is described by the plan.

    • Method Detail

      • withId

        public CarePlanBuilder.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 CarePlanBuilder.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 CarePlanBuilder.Impl withMeta​(@NonNull
                                     @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

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

      • withGoal

        public CarePlanBuilder.Impl withGoal​(@NonNull
                                     @NonNull com.babylonhealth.lit.core.model.Reference... goal)
        Parameters:
        goal - - Describes the intended objective(s) of carrying out the care plan.

      • withGoal

        public CarePlanBuilder.Impl withGoal​(@NonNull
                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> goal)
        Parameters:
        goal - - Describes the intended objective(s) of carrying out the care plan.

      • withGoal

        public CarePlanBuilder.Impl withGoal​(@NonNull
                                     @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... goal)

      • withNote

        public CarePlanBuilder.Impl withNote​(@NonNull
                                     @NonNull com.babylonhealth.lit.core.model.Annotation... note)
        Parameters:
        note - - General notes about the care plan not covered elsewhere.

      • withNote

        public CarePlanBuilder.Impl withNote​(@NonNull
                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Annotation> note)
        Parameters:
        note - - General notes about the care plan not covered elsewhere.

      • withNote

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

      • withTitle

        public CarePlanBuilder.Impl withTitle​(@NonNull
                                      @NonNull java.lang.String title)
        Parameters:
        title - - Human-friendly name for the care plan.

      • withPartOf

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

      • withPartOf

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

      • withPartOf

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

      • withPeriod

        public CarePlanBuilder.Impl withPeriod​(@NonNull
                                       @NonNull com.babylonhealth.lit.core.model.Period period)
        Parameters:
        period - - Indicates when the plan did (or is intended to) come into effect and end.

      • withPeriod

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

      • withAuthor

        public CarePlanBuilder.Impl withAuthor​(@NonNull
                                       @NonNull com.babylonhealth.lit.core.model.Reference author)
        Parameters:
        author - - When populated, the author is responsible for the care plan. The care plan is attributed to the author.

      • withAuthor

        public CarePlanBuilder.Impl withAuthor​(@NonNull
                                       @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder author)

      • withBasedOn

        public CarePlanBuilder.Impl withBasedOn​(@NonNull
                                        @NonNull com.babylonhealth.lit.core.model.Reference... basedOn)
        Parameters:
        basedOn - - A care plan that is fulfilled in whole or in part by this care plan.

      • withBasedOn

        public CarePlanBuilder.Impl withBasedOn​(@NonNull
                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> basedOn)
        Parameters:
        basedOn - - A care plan that is fulfilled in whole or in part by this care plan.

      • withBasedOn

        public CarePlanBuilder.Impl withBasedOn​(@NonNull
                                        @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... basedOn)

      • withCreated

        public CarePlanBuilder.Impl withCreated​(@NonNull
                                        @NonNull com.babylonhealth.lit.core.FHIRDateTime created)
        Parameters:
        created - - Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

      • withLanguage

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

      • withReplaces

        public CarePlanBuilder.Impl withReplaces​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.Reference... replaces)
        Parameters:
        replaces - - Completed or terminated care plan whose function is taken by this new care plan.

      • withReplaces

        public CarePlanBuilder.Impl withReplaces​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> replaces)
        Parameters:
        replaces - - Completed or terminated care plan whose function is taken by this new care plan.

      • withReplaces

        public CarePlanBuilder.Impl withReplaces​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... replaces)

      • withCategory

        public CarePlanBuilder.Impl withCategory​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.CodeableConcept... category)
        Parameters:
        category - - Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

      • withCategory

        public CarePlanBuilder.Impl withCategory​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> category)
        Parameters:
        category - - Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

      • withCategory

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

      • withCareTeam

        public CarePlanBuilder.Impl withCareTeam​(@NonNull
                                         @NonNull com.babylonhealth.lit.core.model.Reference... careTeam)
        Parameters:
        careTeam - - Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • withCareTeam

        public CarePlanBuilder.Impl withCareTeam​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> careTeam)
        Parameters:
        careTeam - - Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • withCareTeam

        public CarePlanBuilder.Impl withCareTeam​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... careTeam)

      • withContained

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

      • withExtension

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

      • withEncounter

        public CarePlanBuilder.Impl withEncounter​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Reference encounter)
        Parameters:
        encounter - - The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

      • withEncounter

        public CarePlanBuilder.Impl withEncounter​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder encounter)

      • withAddresses

        public CarePlanBuilder.Impl withAddresses​(@NonNull
                                          @NonNull com.babylonhealth.lit.core.model.Reference... addresses)
        Parameters:
        addresses - - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

      • withAddresses

        public CarePlanBuilder.Impl withAddresses​(@NonNull
                                          @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> addresses)
        Parameters:
        addresses - - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

      • withAddresses

        public CarePlanBuilder.Impl withAddresses​(@NonNull
                                          @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... addresses)

      • withIdentifier

        public CarePlanBuilder.Impl withIdentifier​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

      • withIdentifier

        public CarePlanBuilder.Impl withIdentifier​(@NonNull
                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

      • withIdentifier

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

      • withDescription

        public CarePlanBuilder.Impl withDescription​(@NonNull
                                            @NonNull java.lang.String description)
        Parameters:
        description - - A description of the scope and nature of the plan.

      • withContributor

        public CarePlanBuilder.Impl withContributor​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.Reference... contributor)
        Parameters:
        contributor - - Identifies the individual(s) or organization who provided the contents of the care plan.

      • withContributor

        public CarePlanBuilder.Impl withContributor​(@NonNull
                                            @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> contributor)
        Parameters:
        contributor - - Identifies the individual(s) or organization who provided the contents of the care plan.

      • withContributor

        public CarePlanBuilder.Impl withContributor​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... contributor)

      • withImplicitRules

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

      • withSupportingInfo

        public CarePlanBuilder.Impl withSupportingInfo​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Reference... supportingInfo)
        Parameters:
        supportingInfo - - Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

      • withSupportingInfo

        public CarePlanBuilder.Impl withSupportingInfo​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> supportingInfo)
        Parameters:
        supportingInfo - - Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

      • withSupportingInfo

        public CarePlanBuilder.Impl withSupportingInfo​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... supportingInfo)

      • withInstantiatesUri

        public CarePlanBuilder.Impl withInstantiatesUri​(@NonNull
                                                @NonNull java.lang.String... instantiatesUri)
        Parameters:
        instantiatesUri - - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

      • withInstantiatesUri

        public CarePlanBuilder.Impl withInstantiatesUri​(@NonNull
                                                @NonNull java.util.Collection<java.lang.String> instantiatesUri)
        Parameters:
        instantiatesUri - - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

      • withModifierExtension

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

      • withInstantiatesCanonical

        public CarePlanBuilder.Impl withInstantiatesCanonical​(@NonNull
                                                      @NonNull java.lang.String... instantiatesCanonical)
        Parameters:
        instantiatesCanonical - - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

      • withInstantiatesCanonical

        public CarePlanBuilder.Impl withInstantiatesCanonical​(@NonNull
                                                      @NonNull java.util.Collection<java.lang.String> instantiatesCanonical)
        Parameters:
        instantiatesCanonical - - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

      • withActivity

        public CarePlanBuilder.Impl withActivity​(@NonNull
                                         @NonNull com.babylonhealth.lit.hl7.model.CarePlan.Activity... activity)
        Parameters:
        activity - - Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

      • withActivity

        public CarePlanBuilder.Impl withActivity​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.CarePlan.Activity> activity)
        Parameters:
        activity - - Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

      • build

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