Package com.ibm.fhir.model.resource

Class CarePlan.Activity.Builder

    • Method Detail

      • id

        public CarePlan.Activity.Builder id​(java.lang.String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public CarePlan.Activity.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public CarePlan.Activity.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.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.Activity.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public CarePlan.Activity.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • outcomeCodeableConcept

        public CarePlan.Activity.Builder outcomeCodeableConcept​(CodeableConcept... outcomeCodeableConcept)
        Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

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

        Parameters:
        outcomeCodeableConcept - Results of the activity
        Returns:
        A reference to this Builder instance

      • outcomeCodeableConcept

        public CarePlan.Activity.Builder outcomeCodeableConcept​(java.util.Collection<CodeableConcept> outcomeCodeableConcept)
        Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

        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:
        outcomeCodeableConcept - Results of the activity
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • outcomeReference

        public CarePlan.Activity.Builder outcomeReference​(Reference... outcomeReference)
        Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan. activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

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

        Parameters:
        outcomeReference - Appointment, Encounter, Procedure, etc.
        Returns:
        A reference to this Builder instance

      • outcomeReference

        public CarePlan.Activity.Builder outcomeReference​(java.util.Collection<Reference> outcomeReference)
        Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan. activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

        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:
        outcomeReference - Appointment, Encounter, Procedure, etc.
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • progress

        public CarePlan.Activity.Builder progress​(Annotation... progress)
        Notes about the adherence/status/progress of the activity.

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

        Parameters:
        progress - Comments about the activity status/progress
        Returns:
        A reference to this Builder instance

      • progress

        public CarePlan.Activity.Builder progress​(java.util.Collection<Annotation> progress)
        Notes about the adherence/status/progress of the activity.

        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:
        progress - Comments about the activity status/progress
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • detail

        public CarePlan.Activity.Builder detail​(CarePlan.Activity.Detail detail)
        A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
        Parameters:
        detail - In-line definition of activity
        Returns:
        A reference to this Builder instance