Package com.ibm.fhir.model.resource

Class CarePlan.Activity.Detail

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    CarePlan.Activity
    public static class CarePlan.Activity.Detail
extends BackboneElement
    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.

    • Method Detail

      • getKind

        public CarePlanActivityKind getKind()
        A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan. activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
        Returns:
        An immutable object of type CarePlanActivityKind that may be null.

      • getInstantiatesCanonical

        public List<Canonical> getInstantiatesCanonical()
        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 activity.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getInstantiatesUri

        public List<Uri> getInstantiatesUri()
        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 activity.
        Returns:
        An unmodifiable list containing immutable objects of type Uri that may be empty.

      • getCode

        public CodeableConcept getCode()
        Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getReasonCode

        public List<CodeableConcept> getReasonCode()
        Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReasonReference

        public List<Reference> getReasonReference()
        Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getGoal

        public List<Reference> getGoal()
        Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getStatusReason

        public CodeableConcept getStatusReason()
        Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDoNotPerform

        public Boolean getDoNotPerform()
        If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
        Returns:
        An immutable object of type Boolean that may be null.

      • getScheduled

        public Element getScheduled()
        The period, timing or frequency upon which the described activity is to occur.
        Returns:
        An immutable object of type Timing, Period or String that may be null.

      • getLocation

        public Reference getLocation()
        Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
        Returns:
        An immutable object of type Reference that may be null.

      • getPerformer

        public List<Reference> getPerformer()
        Identifies who's expected to be involved in the activity.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getProduct

        public Element getProduct()
        Identifies the food, drug or other product to be consumed or supplied in the activity.
        Returns:
        An immutable object of type CodeableConcept or Reference that may be null.

      • getDailyAmount

        public SimpleQuantity getDailyAmount()
        Identifies the quantity expected to be consumed in a given day.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getQuantity

        public SimpleQuantity getQuantity()
        Identifies the quantity expected to be supplied, administered or consumed by the subject.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getDescription

        public String getDescription()
        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.
        Returns:
        An immutable object of type String that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object