Package org.linuxforhealth.fhir.model.resource

Class CarePlan.Builder

    • Method Detail

      • id

        public CarePlan.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

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

      • language

        public CarePlan.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public CarePlan.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 CarePlan.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

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

      • contained

        public CarePlan.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public CarePlan.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

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

      • extension

        public CarePlan.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public CarePlan.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

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

      • modifierExtension

        public CarePlan.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public CarePlan.Builder identifier​(Identifier... 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.

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

        Parameters:
        identifier - External Ids for this plan
        Returns:
        A reference to this Builder instance

      • identifier

        public CarePlan.Builder identifier​(java.util.Collection<Identifier> 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.

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

        Parameters:
        identifier - External Ids for this plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • instantiatesCanonical

        public CarePlan.Builder instantiatesCanonical​(Canonical... 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.

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

        Parameters:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesCanonical

        public CarePlan.Builder instantiatesCanonical​(java.util.Collection<Canonical> 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.

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

        Parameters:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • instantiatesUri

        public CarePlan.Builder instantiatesUri​(Uri... 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.

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

        Parameters:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public CarePlan.Builder instantiatesUri​(java.util.Collection<Uri> 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.

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

        Parameters:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • basedOn

        public CarePlan.Builder basedOn​(Reference... basedOn)
        A care plan that is fulfilled in whole or in part by this care plan.

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

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfills CarePlan
        Returns:
        A reference to this Builder instance

      • basedOn

        public CarePlan.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A care plan that is fulfilled in whole or in part by this care plan.

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

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfills CarePlan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • replaces

        public CarePlan.Builder replaces​(Reference... replaces)
        Completed or terminated care plan whose function is taken by this new care plan.

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

        Allowed resource types for the references:

        Parameters:
        replaces - CarePlan replaced by this CarePlan
        Returns:
        A reference to this Builder instance

      • replaces

        public CarePlan.Builder replaces​(java.util.Collection<Reference> replaces)
        Completed or terminated care plan whose function is taken by this new care plan.

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

        Allowed resource types for the references:

        Parameters:
        replaces - CarePlan replaced by this CarePlan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • partOf

        public CarePlan.Builder partOf​(Reference... partOf)
        A larger care plan of which this particular care plan is a component or step.

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

        Allowed resource types for the references:

        Parameters:
        partOf - Part of referenced CarePlan
        Returns:
        A reference to this Builder instance

      • partOf

        public CarePlan.Builder partOf​(java.util.Collection<Reference> partOf)
        A larger care plan of which this particular care plan is a component or step.

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

        Allowed resource types for the references:

        Parameters:
        partOf - Part of referenced CarePlan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public CarePlan.Builder status​(CarePlanStatus status)
        Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

        This element is required.

        Parameters:
        status - draft | active | on-hold | revoked | completed | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • intent

        public CarePlan.Builder intent​(CarePlanIntent intent)
        Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

        This element is required.

        Parameters:
        intent - proposal | plan | order | option
        Returns:
        A reference to this Builder instance

      • category

        public CarePlan.Builder category​(CodeableConcept... 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.

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

        Parameters:
        category - Type of plan
        Returns:
        A reference to this Builder instance

      • category

        public CarePlan.Builder category​(java.util.Collection<CodeableConcept> 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.

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

        Parameters:
        category - Type of plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • title

        public CarePlan.Builder title​(String title)
        Human-friendly name for the care plan.
        Parameters:
        title - Human-friendly name for the care plan
        Returns:
        A reference to this Builder instance

      • description

        public CarePlan.Builder description​(String description)
        A description of the scope and nature of the plan.
        Parameters:
        description - Summary of nature of plan
        Returns:
        A reference to this Builder instance

      • subject

        public CarePlan.Builder subject​(Reference subject)
        Identifies the patient or group whose intended care is described by the plan.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Who the care plan is for
        Returns:
        A reference to this Builder instance

      • encounter

        public CarePlan.Builder encounter​(Reference encounter)
        The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter created as part of
        Returns:
        A reference to this Builder instance

      • period

        public CarePlan.Builder period​(Period period)
        Indicates when the plan did (or is intended to) come into effect and end.
        Parameters:
        period - Time period plan covers
        Returns:
        A reference to this Builder instance

      • created

        public CarePlan.Builder created​(DateTime created)
        Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
        Parameters:
        created - Date record was first recorded
        Returns:
        A reference to this Builder instance

      • contributor

        public CarePlan.Builder contributor​(java.util.Collection<Reference> contributor)
        Identifies the individual(s) or organization who provided the contents of the care plan.

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

        Allowed resource types for the references:

        Parameters:
        contributor - Who provided the content of the care plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • careTeam

        public CarePlan.Builder careTeam​(Reference... careTeam)
        Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

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

        Allowed resource types for the references:

        Parameters:
        careTeam - Who's involved in plan?
        Returns:
        A reference to this Builder instance

      • careTeam

        public CarePlan.Builder careTeam​(java.util.Collection<Reference> careTeam)
        Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

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

        Allowed resource types for the references:

        Parameters:
        careTeam - Who's involved in plan?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • addresses

        public CarePlan.Builder addresses​(Reference... addresses)
        Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

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

        Allowed resource types for the references:

        Parameters:
        addresses - Health issues this plan addresses
        Returns:
        A reference to this Builder instance

      • addresses

        public CarePlan.Builder addresses​(java.util.Collection<Reference> addresses)
        Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

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

        Allowed resource types for the references:

        Parameters:
        addresses - Health issues this plan addresses
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • supportingInfo

        public CarePlan.Builder supportingInfo​(Reference... 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.

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

        Parameters:
        supportingInfo - Information considered as part of plan
        Returns:
        A reference to this Builder instance

      • supportingInfo

        public CarePlan.Builder supportingInfo​(java.util.Collection<Reference> 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.

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

        Parameters:
        supportingInfo - Information considered as part of plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • goal

        public CarePlan.Builder goal​(Reference... goal)
        Describes the intended objective(s) of carrying out the care plan.

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

        Allowed resource types for the references:

        Parameters:
        goal - Desired outcome of plan
        Returns:
        A reference to this Builder instance

      • goal

        public CarePlan.Builder goal​(java.util.Collection<Reference> goal)
        Describes the intended objective(s) of carrying out the care plan.

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

        Allowed resource types for the references:

        Parameters:
        goal - Desired outcome of plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • activity

        public CarePlan.Builder activity​(CarePlan.Activity... 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.

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

        Parameters:
        activity - Action to occur as part of plan
        Returns:
        A reference to this Builder instance

      • activity

        public CarePlan.Builder activity​(java.util.Collection<CarePlan.Activity> 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.

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

        Parameters:
        activity - Action to occur as part of plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public CarePlan.Builder note​(Annotation... note)
        General notes about the care plan not covered elsewhere.

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

        Parameters:
        note - Comments about the plan
        Returns:
        A reference to this Builder instance

      • note

        public CarePlan.Builder note​(java.util.Collection<Annotation> note)
        General notes about the care plan not covered elsewhere.

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

        Parameters:
        note - Comments about the plan
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public CarePlan build()
        Build the CarePlan

        Required elements:

        • status
        • intent
        • subject
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type CarePlan
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid CarePlan per the base specification

      • validate

        protected void validate​(CarePlan carePlan)