CarePlan.ActivityDetail (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.CarePlan.ActivityDetail

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

CarePlan
```
public static class CarePlan.ActivityDetail
extends BaseIdentifiableElement
implements 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

Constructor Summary

Constructors
Constructor and Description

ActivityDetail()

Constructors
Constructor and Description
`ActivityDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addGoal()` Adds and returns a new value for goal ()
`ResourceReferenceDt`	`addPerformer()` Adds and returns a new value for performer ()
`CodeableConceptDt`	`addReasonCode()` Adds and returns a new value for reasonCode ()
`CarePlan.ActivityDetail`	`addReasonCode(CodeableConceptDt theValue)` Adds a given new value for reasonCode ()
`ResourceReferenceDt`	`addReasonReference()` Adds and returns a new value for reasonReference ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`BoundCodeableConceptDt<CarePlanActivityCategoryEnum>`	`getCategory()` Gets the value(s) for category ().
`CodeableConceptDt`	`getCode()` Gets the value(s) for code ().
`SimpleQuantityDt`	`getDailyAmount()` Gets the value(s) for dailyAmount ().
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`List<ResourceReferenceDt>`	`getGoal()` Gets the value(s) for goal ().
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location ().
`List<ResourceReferenceDt>`	`getPerformer()` Gets the value(s) for performer ().
`IDatatype`	`getProduct()` Gets the value(s) for product[x] ().
`Boolean`	`getProhibited()` Gets the value(s) for prohibited ().
`BooleanDt`	`getProhibitedElement()` Gets the value(s) for prohibited ().
`SimpleQuantityDt`	`getQuantity()` Gets the value(s) for quantity ().
`List<CodeableConceptDt>`	`getReasonCode()` Gets the value(s) for reasonCode ().
`CodeableConceptDt`	`getReasonCodeFirstRep()` Gets the first repetition for reasonCode (), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getReasonReference()` Gets the value(s) for reasonReference ().
`IDatatype`	`getScheduled()` Gets the value(s) for scheduled[x] ().
`String`	`getStatus()` Gets the value(s) for status ().
`BoundCodeDt<CarePlanActivityStatusEnum>`	`getStatusElement()` Gets the value(s) for status ().
`CodeableConceptDt`	`getStatusReason()` Gets the value(s) for statusReason ().
`boolean`	`isEmpty()`
`CarePlan.ActivityDetail`	`setCategory(BoundCodeableConceptDt<CarePlanActivityCategoryEnum> theValue)` Sets the value(s) for category ()
`CarePlan.ActivityDetail`	`setCategory(CarePlanActivityCategoryEnum theValue)` Sets the value(s) for category ()
`CarePlan.ActivityDetail`	`setCode(CodeableConceptDt theValue)` Sets the value(s) for code ()
`CarePlan.ActivityDetail`	`setDailyAmount(SimpleQuantityDt theValue)` Sets the value(s) for dailyAmount ()
`CarePlan.ActivityDetail`	`setDescription(String theString)` Sets the value for description ()
`CarePlan.ActivityDetail`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`CarePlan.ActivityDetail`	`setGoal(List<ResourceReferenceDt> theValue)` Sets the value(s) for goal ()
`CarePlan.ActivityDetail`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location ()
`CarePlan.ActivityDetail`	`setPerformer(List<ResourceReferenceDt> theValue)` Sets the value(s) for performer ()
`CarePlan.ActivityDetail`	`setProduct(IDatatype theValue)` Sets the value(s) for product[x] ()
`CarePlan.ActivityDetail`	`setProhibited(boolean theBoolean)` Sets the value for prohibited ()
`CarePlan.ActivityDetail`	`setProhibited(BooleanDt theValue)` Sets the value(s) for prohibited ()
`CarePlan.ActivityDetail`	`setQuantity(SimpleQuantityDt theValue)` Sets the value(s) for quantity ()
`CarePlan.ActivityDetail`	`setReasonCode(List<CodeableConceptDt> theValue)` Sets the value(s) for reasonCode ()
`CarePlan.ActivityDetail`	`setReasonReference(List<ResourceReferenceDt> theValue)` Sets the value(s) for reasonReference ()
`CarePlan.ActivityDetail`	`setScheduled(IDatatype theValue)` Sets the value(s) for scheduled[x] ()
`CarePlan.ActivityDetail`	`setStatus(BoundCodeDt<CarePlanActivityStatusEnum> theValue)` Sets the value(s) for status ()
`CarePlan.ActivityDetail`	`setStatus(CarePlanActivityStatusEnum theValue)` Sets the value(s) for status ()
`CarePlan.ActivityDetail`	`setStatusReason(CodeableConceptDt theValue)` Sets the value(s) for statusReason ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

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

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - ActivityDetail
```
public ActivityDetail()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getCategory
```
public BoundCodeableConceptDt<CarePlanActivityCategoryEnum> 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.
  - setCategory
```
public CarePlan.ActivityDetail setCategory(BoundCodeableConceptDt<CarePlanActivityCategoryEnum> theValue)
```
    Sets the value(s) for category ()
    Definition: High-level categorization of the type of activity in a care plan.
  - setCategory
```
public CarePlan.ActivityDetail setCategory(CarePlanActivityCategoryEnum theValue)
```
    Sets the value(s) for category ()
    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<CodeableConceptDt> getReasonCode()
```
    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.
  - setReasonCode
```
public CarePlan.ActivityDetail setReasonCode(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for reasonCode ()
    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<ResourceReferenceDt> getReasonReference()
```
    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.
  - setReasonReference
```
public CarePlan.ActivityDetail setReasonReference(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for reasonReference ()
    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<ResourceReferenceDt> getGoal()
```
    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
  - setGoal
```
public CarePlan.ActivityDetail setGoal(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for goal ()
    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 BoundCodeDt<CarePlanActivityStatusEnum> getStatusElement()
```
    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. Will not return null.
    Definition: Identifies what progress is being made for the specific activity.
  - setStatus
```
public CarePlan.ActivityDetail setStatus(BoundCodeDt<CarePlanActivityStatusEnum> theValue)
```
    Sets the value(s) for status ()
    Definition: Identifies what progress is being made for the specific activity.
  - setStatus
```
public CarePlan.ActivityDetail setStatus(CarePlanActivityStatusEnum theValue)
```
    Sets the value(s) for status ()
    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.
  - setStatusReason
```
public CarePlan.ActivityDetail setStatusReason(CodeableConceptDt theValue)
```
    Sets the value(s) for statusReason ()
    Definition: Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
  - getProhibitedElement
```
public 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. Will not 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(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 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(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.
  - setLocation
```
public CarePlan.ActivityDetail setLocation(ResourceReferenceDt theValue)
```
    Sets the value(s) for location ()
    Definition: Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
  - getPerformer
```
public List<ResourceReferenceDt> getPerformer()
```
    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.
  - setPerformer
```
public CarePlan.ActivityDetail setPerformer(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for performer ()
    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 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(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.
  - setDailyAmount
```
public CarePlan.ActivityDetail setDailyAmount(SimpleQuantityDt theValue)
```
    Sets the value(s) for dailyAmount ()
    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
  - setQuantity
```
public CarePlan.ActivityDetail setQuantity(SimpleQuantityDt theValue)
```
    Sets the value(s) for quantity ()
    Definition: Identifies the quantity expected to be supplied, administered or consumed by the subject
  - getDescriptionElement
```
public 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. 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.
  - setDescription
```
public CarePlan.ActivityDetail setDescription(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.

Class CarePlan.ActivityDetail

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

ActivityDetail

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getCategory

setCategory

setCategory

getCode

setCode

getReasonCode

setReasonCode

addReasonCode

addReasonCode

getReasonCodeFirstRep

getReasonReference

setReasonReference

addReasonReference

getGoal

setGoal

addGoal

getStatusElement

getStatus

setStatus

setStatus

getStatusReason

setStatusReason

getProhibitedElement

getProhibited

setProhibited

setProhibited

getScheduled

setScheduled

getLocation

setLocation

getPerformer

setPerformer

addPerformer

getProduct

setProduct

getDailyAmount

setDailyAmount

getQuantity

setQuantity

getDescriptionElement

getDescription

setDescription

setDescription