Class CarePlan.ActivityDetail

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    CarePlan

    public static class CarePlan.ActivityDetail
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: CarePlan.activity.detail ()

    Definition: 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.

    See Also:
    Serialized Form
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getCategory

        public CodeableConceptDt getCategory()
        Gets the value(s) for category (). creating it if it does not exist. Will not return null.

        Definition: High-level categorization of the type of activity in a care plan.

      • getCode

        public CodeableConceptDt getCode()
        Gets the value(s) for code (). creating it if it does not exist. Will not return null.

        Definition: Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

      • setCode

        public CarePlan.ActivityDetail setCode​(CodeableConceptDt theValue)
        Sets the value(s) for code ()

        Definition: Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

      • getReasonCode

        public List<CodeableConceptDtgetReasonCode()
        Gets the value(s) for reasonCode (). creating it if it does not exist. Will not return null.

        Definition: Provides the rationale that drove the inclusion of this particular activity as part of the plan.

      • addReasonCode

        public CodeableConceptDt addReasonCode()
        Adds and returns a new value for reasonCode ()

        Definition: Provides the rationale that drove the inclusion of this particular activity as part of the plan.

      • addReasonCode

        public CarePlan.ActivityDetail addReasonCode​(CodeableConceptDt theValue)
        Adds a given new value for reasonCode ()

        Definition: Provides the rationale that drove the inclusion of this particular activity as part of the plan.

        Parameters:
        theValue - The reasonCode to add (must not be null)
      • getReasonCodeFirstRep

        public CodeableConceptDt getReasonCodeFirstRep()
        Gets the first repetition for reasonCode (), creating it if it does not already exist.

        Definition: Provides the rationale that drove the inclusion of this particular activity as part of the plan.

      • getReasonReference

        public List<ResourceReferenceDtgetReasonReference()
        Gets the value(s) for reasonReference (). creating it if it does not exist. Will not return null.

        Definition: Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

      • addReasonReference

        public ResourceReferenceDt addReasonReference()
        Adds and returns a new value for reasonReference ()

        Definition: Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

      • getGoal

        public List<ResourceReferenceDtgetGoal()
        Gets the value(s) for goal (). creating it if it does not exist. Will not return null.

        Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

      • addGoal

        public ResourceReferenceDt addGoal()
        Adds and returns a new value for goal ()

        Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<CarePlanActivityStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: Identifies what progress is being made for the specific activity.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: Identifies what progress is being made for the specific activity.

      • getStatusReason

        public CodeableConceptDt getStatusReason()
        Gets the value(s) for statusReason (). creating it if it does not exist. Will not return null.

        Definition: Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

      • getProhibitedElement

        public ca.uhn.fhir.model.primitive.BooleanDt getProhibitedElement()
        Gets the value(s) for prohibited (). creating it if it does not exist. Will not return null.

        Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

      • getProhibited

        public Boolean getProhibited()
        Gets the value(s) for prohibited (). creating it if it does not exist. This method may return null.

        Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

      • setProhibited

        public CarePlan.ActivityDetail setProhibited​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for prohibited ()

        Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

      • setProhibited

        public CarePlan.ActivityDetail setProhibited​(boolean theBoolean)
        Sets the value for prohibited ()

        Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

      • getScheduled

        public ca.uhn.fhir.model.api.IDatatype getScheduled()
        Gets the value(s) for scheduled[x] (). creating it if it does not exist. Will not return null.

        Definition: The period, timing or frequency upon which the described activity is to occur.

      • setScheduled

        public CarePlan.ActivityDetail setScheduled​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for scheduled[x] ()

        Definition: The period, timing or frequency upon which the described activity is to occur.

      • getLocation

        public ResourceReferenceDt getLocation()
        Gets the value(s) for location (). creating it if it does not exist. Will not return null.

        Definition: Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

      • getPerformer

        public List<ResourceReferenceDtgetPerformer()
        Gets the value(s) for performer (). creating it if it does not exist. Will not return null.

        Definition: Identifies who's expected to be involved in the activity.

      • addPerformer

        public ResourceReferenceDt addPerformer()
        Adds and returns a new value for performer ()

        Definition: Identifies who's expected to be involved in the activity.

      • getProduct

        public ca.uhn.fhir.model.api.IDatatype getProduct()
        Gets the value(s) for product[x] (). creating it if it does not exist. Will not return null.

        Definition: Identifies the food, drug or other product to be consumed or supplied in the activity.

      • setProduct

        public CarePlan.ActivityDetail setProduct​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for product[x] ()

        Definition: Identifies the food, drug or other product to be consumed or supplied in the activity.

      • getDailyAmount

        public SimpleQuantityDt getDailyAmount()
        Gets the value(s) for dailyAmount (). creating it if it does not exist. Will not return null.

        Definition: Identifies the quantity expected to be consumed in a given day.

      • getQuantity

        public SimpleQuantityDt getQuantity()
        Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

        Definition: Identifies the quantity expected to be supplied, administered or consumed by the subject

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

      • setDescription

        public CarePlan.ActivityDetail setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

      • setDescription

        public CarePlan.ActivityDetail setDescription​(String theString)
        Sets the value for description ()

        Definition: This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.