CarePlan.CarePlanActivityDetailComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.Element
  - - org.hl7.fhir.instance.model.BackboneElement
    - - org.hl7.fhir.instance.model.CarePlan.CarePlanActivityDetailComponent

All Implemented Interfaces:

Serializable, IBase, IBaseBackboneElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

CarePlan
```
public static class CarePlan.CarePlanActivityDetailComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CarePlanActivityDetailComponent()

CarePlanActivityDetailComponent(BooleanType prohibited)

Constructors
Constructor and Description
`CarePlanActivityDetailComponent()`
`CarePlanActivityDetailComponent(BooleanType prohibited)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`addGoal()`
`CarePlan.CarePlanActivityDetailComponent`	`addGoal(Reference t)`
`Goal`	`addGoalTarget()`
`Reference`	`addPerformer()`
`CarePlan.CarePlanActivityDetailComponent`	`addPerformer(Reference t)`
`CodeableConcept`	`addReasonCode()`
`CarePlan.CarePlanActivityDetailComponent`	`addReasonCode(CodeableConcept t)`
`Reference`	`addReasonReference()`
`CarePlan.CarePlanActivityDetailComponent`	`addReasonReference(Reference t)`
`Condition`	`addReasonReferenceTarget()`
`CarePlan.CarePlanActivityDetailComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`CodeableConcept`	`getCategory()`
`CodeableConcept`	`getCode()`
`SimpleQuantity`	`getDailyAmount()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Reference>`	`getGoal()`
`List<Goal>`	`getGoalTarget()`
`Reference`	`getLocation()`
`Location`	`getLocationTarget()`
`List<Reference>`	`getPerformer()`
`List<Resource>`	`getPerformerTarget()`
`Type`	`getProduct()`
`CodeableConcept`	`getProductCodeableConcept()`
`Reference`	`getProductReference()`
`boolean`	`getProhibited()`
`BooleanType`	`getProhibitedElement()`
`SimpleQuantity`	`getQuantity()`
`List<CodeableConcept>`	`getReasonCode()`
`List<Reference>`	`getReasonReference()`
`List<Condition>`	`getReasonReferenceTarget()`
`Type`	`getScheduled()`
`Period`	`getScheduledPeriod()`
`StringType`	`getScheduledStringType()`
`Timing`	`getScheduledTiming()`
`CarePlan.CarePlanActivityStatus`	`getStatus()`
`Enumeration<CarePlan.CarePlanActivityStatus>`	`getStatusElement()`
`CodeableConcept`	`getStatusReason()`
`boolean`	`hasCategory()`
`boolean`	`hasCode()`
`boolean`	`hasDailyAmount()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasGoal()`
`boolean`	`hasLocation()`
`boolean`	`hasPerformer()`
`boolean`	`hasProduct()`
`boolean`	`hasProductCodeableConcept()`
`boolean`	`hasProductReference()`
`boolean`	`hasProhibited()`
`boolean`	`hasProhibitedElement()`
`boolean`	`hasQuantity()`
`boolean`	`hasReasonCode()`
`boolean`	`hasReasonReference()`
`boolean`	`hasScheduled()`
`boolean`	`hasScheduledPeriod()`
`boolean`	`hasScheduledStringType()`
`boolean`	`hasScheduledTiming()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStatusReason()`
`boolean`	`isEmpty()`
`CarePlan.CarePlanActivityDetailComponent`	`setCategory(CodeableConcept value)`
`CarePlan.CarePlanActivityDetailComponent`	`setCode(CodeableConcept value)`
`CarePlan.CarePlanActivityDetailComponent`	`setDailyAmount(SimpleQuantity value)`
`CarePlan.CarePlanActivityDetailComponent`	`setDescription(String value)`
`CarePlan.CarePlanActivityDetailComponent`	`setDescriptionElement(StringType value)`
`CarePlan.CarePlanActivityDetailComponent`	`setLocation(Reference value)`
`CarePlan.CarePlanActivityDetailComponent`	`setLocationTarget(Location value)`
`CarePlan.CarePlanActivityDetailComponent`	`setProduct(Type value)`
`CarePlan.CarePlanActivityDetailComponent`	`setProhibited(boolean value)`
`CarePlan.CarePlanActivityDetailComponent`	`setProhibitedElement(BooleanType value)`
`CarePlan.CarePlanActivityDetailComponent`	`setQuantity(SimpleQuantity value)`
`CarePlan.CarePlanActivityDetailComponent`	`setScheduled(Type value)`
`CarePlan.CarePlanActivityDetailComponent`	`setStatus(CarePlan.CarePlanActivityStatus value)`
`CarePlan.CarePlanActivityDetailComponent`	`setStatusElement(Enumeration<CarePlan.CarePlanActivityStatus> value)`
`CarePlan.CarePlanActivityDetailComponent`	`setStatusReason(CodeableConcept value)`

Methods inherited from class org.hl7.fhir.instance.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.instance.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getId, getIdElement, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension

- Constructor Detail
  - CarePlanActivityDetailComponent
```
public CarePlanActivityDetailComponent()
```
  - CarePlanActivityDetailComponent
```
public CarePlanActivityDetailComponent(BooleanType prohibited)
```
- Method Detail
  - getCategory
```
public CodeableConcept getCategory()
```
    Returns:
    
    category (High-level categorization of the type of activity in a care plan.)
  - hasCategory
```
public boolean hasCategory()
```
  - setCategory
```
public CarePlan.CarePlanActivityDetailComponent setCategory(CodeableConcept value)
```
    Parameters:
    
    value - category (High-level categorization of the type of activity in a care plan.)
  - getCode
```
public CodeableConcept getCode()
```
    Returns:
    
    code (Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)
  - hasCode
```
public boolean hasCode()
```
  - setCode
```
public CarePlan.CarePlanActivityDetailComponent setCode(CodeableConcept value)
```
    Parameters:
    
    value - code (Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)
  - getReasonCode
```
public List<CodeableConcept> getReasonCode()
```
    Returns:
    
    reasonCode (Provides the rationale that drove the inclusion of this particular activity as part of the plan.)
  - hasReasonCode
```
public boolean hasReasonCode()
```
  - addReasonCode
```
public CodeableConcept addReasonCode()
```
    Returns:
    
    reasonCode (Provides the rationale that drove the inclusion of this particular activity as part of the plan.)
  - addReasonCode
```
public CarePlan.CarePlanActivityDetailComponent addReasonCode(CodeableConcept t)
```
  - getReasonReference
```
public List<Reference> getReasonReference()
```
    Returns:
    
    reasonReference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - addReasonReference
```
public Reference addReasonReference()
```
    Returns:
    
    reasonReference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
  - addReasonReference
```
public CarePlan.CarePlanActivityDetailComponent addReasonReference(Reference t)
```
  - getReasonReferenceTarget
```
public List<Condition> getReasonReferenceTarget()
```
    Returns:
    
    reasonReference (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
  - addReasonReferenceTarget
```
public Condition addReasonReferenceTarget()
```
    Returns:
    
    reasonReference (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
  - getGoal
```
public List<Reference> getGoal()
```
    Returns:
    
    goal (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
  - hasGoal
```
public boolean hasGoal()
```
  - addGoal
```
public Reference addGoal()
```
    Returns:
    
    goal (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
  - addGoal
```
public CarePlan.CarePlanActivityDetailComponent addGoal(Reference t)
```
  - getGoalTarget
```
public List<Goal> getGoalTarget()
```
    Returns:
    
    goal (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
  - addGoalTarget
```
public Goal addGoalTarget()
```
    Returns:
    
    goal (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
  - getStatusElement
```
public Enumeration<CarePlan.CarePlanActivityStatus> getStatusElement()
```
    Returns:
    
    status (Identifies what progress is being made for the specific activity.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public CarePlan.CarePlanActivityDetailComponent setStatusElement(Enumeration<CarePlan.CarePlanActivityStatus> value)
```
    Parameters:
    
    value - status (Identifies what progress is being made for the specific activity.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public CarePlan.CarePlanActivityStatus getStatus()
```
    Returns:
    
    Identifies what progress is being made for the specific activity.
  - setStatus
```
public CarePlan.CarePlanActivityDetailComponent setStatus(CarePlan.CarePlanActivityStatus value)
```
    Parameters:
    
    value - Identifies what progress is being made for the specific activity.
  - getStatusReason
```
public CodeableConcept getStatusReason()
```
    Returns:
    
    statusReason (Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)
  - hasStatusReason
```
public boolean hasStatusReason()
```
  - setStatusReason
```
public CarePlan.CarePlanActivityDetailComponent setStatusReason(CodeableConcept value)
```
    Parameters:
    
    value - statusReason (Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)
  - getProhibitedElement
```
public BooleanType getProhibitedElement()
```
    Returns:
    
    prohibited (If true, indicates that the described activity is one that must NOT be engaged in when following the plan.). This is the underlying object with id, value and extensions. The accessor "getProhibited" gives direct access to the value
  - hasProhibitedElement
```
public boolean hasProhibitedElement()
```
  - hasProhibited
```
public boolean hasProhibited()
```
  - setProhibitedElement
```
public CarePlan.CarePlanActivityDetailComponent setProhibitedElement(BooleanType value)
```
    Parameters:
    
    value - prohibited (If true, indicates that the described activity is one that must NOT be engaged in when following the plan.). This is the underlying object with id, value and extensions. The accessor "getProhibited" gives direct access to the value
  - getProhibited
```
public boolean getProhibited()
```
    Returns:
    
    If true, indicates that the described activity is one that must NOT be engaged in when following the plan.
  - setProhibited
```
public CarePlan.CarePlanActivityDetailComponent setProhibited(boolean value)
```
    Parameters:
    
    value - If true, indicates that the described activity is one that must NOT be engaged in when following the plan.
  - getScheduled
```
public Type getScheduled()
```
    Returns:
    
    scheduled (The period, timing or frequency upon which the described activity is to occur.)
  - getScheduledTiming
```
public Timing getScheduledTiming()
                          throws Exception
```
    Returns:
    
    scheduled (The period, timing or frequency upon which the described activity is to occur.)
    
    Throws:
    
    Exception
  - hasScheduledTiming
```
public boolean hasScheduledTiming()
                           throws Exception
```
    Throws:
    
    Exception
  - getScheduledPeriod
```
public Period getScheduledPeriod()
                          throws Exception
```
    Returns:
    
    scheduled (The period, timing or frequency upon which the described activity is to occur.)
    
    Throws:
    
    Exception
  - hasScheduledPeriod
```
public boolean hasScheduledPeriod()
                           throws Exception
```
    Throws:
    
    Exception
  - getScheduledStringType
```
public StringType getScheduledStringType()
                                  throws Exception
```
    Returns:
    
    scheduled (The period, timing or frequency upon which the described activity is to occur.)
    
    Throws:
    
    Exception
  - hasScheduledStringType
```
public boolean hasScheduledStringType()
                               throws Exception
```
    Throws:
    
    Exception
  - hasScheduled
```
public boolean hasScheduled()
```
  - setScheduled
```
public CarePlan.CarePlanActivityDetailComponent setScheduled(Type value)
```
    Parameters:
    
    value - scheduled (The period, timing or frequency upon which the described activity is to occur.)
  - getLocation
```
public Reference getLocation()
```
    Returns:
    
    location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
  - hasLocation
```
public boolean hasLocation()
```
  - setLocation
```
public CarePlan.CarePlanActivityDetailComponent setLocation(Reference value)
```
    Parameters:
    
    value - location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
  - getLocationTarget
```
public Location getLocationTarget()
```
    Returns:
    
    location The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
  - setLocationTarget
```
public CarePlan.CarePlanActivityDetailComponent setLocationTarget(Location value)
```
    Parameters:
    
    value - location The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
  - getPerformer
```
public List<Reference> getPerformer()
```
    Returns:
    
    performer (Identifies who's expected to be involved in the activity.)
  - hasPerformer
```
public boolean hasPerformer()
```
  - addPerformer
```
public Reference addPerformer()
```
    Returns:
    
    performer (Identifies who's expected to be involved in the activity.)
  - addPerformer
```
public CarePlan.CarePlanActivityDetailComponent addPerformer(Reference t)
```
  - getPerformerTarget
```
public List<Resource> getPerformerTarget()
```
    Returns:
    
    performer (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies who's expected to be involved in the activity.)
  - getProduct
```
public Type getProduct()
```
    Returns:
    
    product (Identifies the food, drug or other product to be consumed or supplied in the activity.)
  - getProductCodeableConcept
```
public CodeableConcept getProductCodeableConcept()
                                          throws Exception
```
    Returns:
    
    product (Identifies the food, drug or other product to be consumed or supplied in the activity.)
    
    Throws:
    
    Exception
  - hasProductCodeableConcept
```
public boolean hasProductCodeableConcept()
                                  throws Exception
```
    Throws:
    
    Exception
  - getProductReference
```
public Reference getProductReference()
                              throws Exception
```
    Returns:
    
    product (Identifies the food, drug or other product to be consumed or supplied in the activity.)
    
    Throws:
    
    Exception
  - hasProductReference
```
public boolean hasProductReference()
                            throws Exception
```
    Throws:
    
    Exception
  - hasProduct
```
public boolean hasProduct()
```
  - setProduct
```
public CarePlan.CarePlanActivityDetailComponent setProduct(Type value)
```
    Parameters:
    
    value - product (Identifies the food, drug or other product to be consumed or supplied in the activity.)
  - getDailyAmount
```
public SimpleQuantity getDailyAmount()
```
    Returns:
    
    dailyAmount (Identifies the quantity expected to be consumed in a given day.)
  - hasDailyAmount
```
public boolean hasDailyAmount()
```
  - setDailyAmount
```
public CarePlan.CarePlanActivityDetailComponent setDailyAmount(SimpleQuantity value)
```
    Parameters:
    
    value - dailyAmount (Identifies the quantity expected to be consumed in a given day.)
  - getQuantity
```
public SimpleQuantity getQuantity()
```
    Returns:
    
    quantity (Identifies the quantity expected to be supplied, administered or consumed by the subject.)
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public CarePlan.CarePlanActivityDetailComponent setQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - quantity (Identifies the quantity expected to be supplied, administered or consumed by the subject.)
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public CarePlan.CarePlanActivityDetailComponent setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    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.CarePlanActivityDetailComponent setDescription(String value)
```
    Parameters:
    
    value - 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.
  - copy
```
public CarePlan.CarePlanActivityDetailComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class BackboneElement

Class CarePlan.CarePlanActivityDetailComponent

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.BackboneElement

Methods inherited from class org.hl7.fhir.instance.model.Element

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Constructor Detail

CarePlanActivityDetailComponent

CarePlanActivityDetailComponent

Method Detail

getCategory

hasCategory

setCategory

getCode

hasCode

setCode

getReasonCode

hasReasonCode

addReasonCode

addReasonCode

getReasonReference

hasReasonReference

addReasonReference

addReasonReference

getReasonReferenceTarget

addReasonReferenceTarget

getGoal

hasGoal

addGoal

addGoal

getGoalTarget

addGoalTarget

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getStatusReason

hasStatusReason

setStatusReason

getProhibitedElement

hasProhibitedElement

hasProhibited

setProhibitedElement

getProhibited

setProhibited

getScheduled

getScheduledTiming

hasScheduledTiming

getScheduledPeriod

hasScheduledPeriod

getScheduledStringType

hasScheduledStringType

hasScheduled

setScheduled

getLocation

hasLocation

setLocation

getLocationTarget

setLocationTarget

getPerformer

hasPerformer

addPerformer

addPerformer

getPerformerTarget

getProduct

getProductCodeableConcept

hasProductCodeableConcept

getProductReference

hasProductReference

hasProduct

setProduct

getDailyAmount

hasDailyAmount

setDailyAmount

getQuantity