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

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class CarePlan
extends BaseResource
implements IResource
```
HAPI/FHIR CarePlan Resource ()
Definition: Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/CarePlan

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CarePlan.Activity` Block class for child element: CarePlan.activity ()
`static class`	`CarePlan.ActivityDetail` Block class for child element: CarePlan.activity.detail ()
`static class`	`CarePlan.Participant` Block class for child element: CarePlan.participant ()
`static class`	`CarePlan.RelatedPlan` Block class for child element: CarePlan.relatedPlan ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTIVITYCODE` Fluent Client search parameter constant for activitycode
`static DateClientParam`	`ACTIVITYDATE` Fluent Client search parameter constant for activitydate
`static ReferenceClientParam`	`ACTIVITYREFERENCE` Fluent Client search parameter constant for activityreference
`static ReferenceClientParam`	`CONDITION` Fluent Client search parameter constant for condition
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ReferenceClientParam`	`GOAL` Fluent Client search parameter constant for goal
`static Include`	`INCLUDE_ACTIVITYREFERENCE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_CONDITION` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_GOAL` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PARTICIPANT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PERFORMER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_RELATEDPLAN` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`PARTICIPANT` Fluent Client search parameter constant for participant
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ReferenceClientParam`	`PERFORMER` Fluent Client search parameter constant for performer
`static TokenClientParam`	`RELATEDCODE` Fluent Client search parameter constant for relatedcode
`static CompositeClientParam<TokenClientParam,ReferenceClientParam>`	`RELATEDCODE_RELATEDPLAN` Fluent Client search parameter constant for relatedcode-relatedplan
`static ReferenceClientParam`	`RELATEDPLAN` Fluent Client search parameter constant for relatedplan
`static String`	`SP_ACTIVITYCODE` Search parameter constant for activitycode
`static String`	`SP_ACTIVITYDATE` Search parameter constant for activitydate
`static String`	`SP_ACTIVITYREFERENCE` Search parameter constant for activityreference
`static String`	`SP_CONDITION` Search parameter constant for condition
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_GOAL` Search parameter constant for goal
`static String`	`SP_PARTICIPANT` Search parameter constant for participant
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PERFORMER` Search parameter constant for performer
`static String`	`SP_RELATEDCODE` Search parameter constant for relatedcode
`static String`	`SP_RELATEDCODE_RELATEDPLAN` Search parameter constant for relatedcode-relatedplan
`static String`	`SP_RELATEDPLAN` Search parameter constant for relatedplan
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

CarePlan()

Constructors
Constructor and Description
`CarePlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CarePlan.Activity`	`addActivity()` Adds and returns a new value for activity ()
`CarePlan`	`addActivity(CarePlan.Activity theValue)` Adds a given new value for activity ()
`ResourceReferenceDt`	`addAddresses()` Adds and returns a new value for addresses ()
`ResourceReferenceDt`	`addAuthor()` Adds and returns a new value for author ()
`CodeableConceptDt`	`addCategory()` Adds and returns a new value for category ()
`CarePlan`	`addCategory(CodeableConceptDt theValue)` Adds a given new value for category ()
`ResourceReferenceDt`	`addGoal()` Adds and returns a new value for goal ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`CarePlan`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`CarePlan.Participant`	`addParticipant()` Adds and returns a new value for participant ()
`CarePlan`	`addParticipant(CarePlan.Participant theValue)` Adds a given new value for participant ()
`CarePlan.RelatedPlan`	`addRelatedPlan()` Adds and returns a new value for relatedPlan ()
`CarePlan`	`addRelatedPlan(CarePlan.RelatedPlan theValue)` Adds a given new value for relatedPlan ()
`ResourceReferenceDt`	`addSupport()` Adds and returns a new value for support ()
`List<CarePlan.Activity>`	`getActivity()` Gets the value(s) for activity ().
`CarePlan.Activity`	`getActivityFirstRep()` Gets the first repetition for activity (), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getAddresses()` Gets the value(s) for addresses ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`List<ResourceReferenceDt>`	`getAuthor()` Gets the value(s) for author ().
`List<CodeableConceptDt>`	`getCategory()` Gets the value(s) for category ().
`CodeableConceptDt`	`getCategoryFirstRep()` Gets the first repetition for category (), creating it if it does not already exist.
`ResourceReferenceDt`	`getContext()` Gets the value(s) for context ().
`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 ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`Date`	`getModified()` Gets the value(s) for modified ().
`DateTimeDt`	`getModifiedElement()` Gets the value(s) for modified ().
`AnnotationDt`	`getNote()` Gets the value(s) for note ().
`List<CarePlan.Participant>`	`getParticipant()` Gets the value(s) for participant ().
`CarePlan.Participant`	`getParticipantFirstRep()` Gets the first repetition for participant (), creating it if it does not already exist.
`PeriodDt`	`getPeriod()` Gets the value(s) for period ().
`List<CarePlan.RelatedPlan>`	`getRelatedPlan()` Gets the value(s) for relatedPlan ().
`CarePlan.RelatedPlan`	`getRelatedPlanFirstRep()` Gets the first repetition for relatedPlan (), creating it if it does not already exist.
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status ().
`BoundCodeDt<CarePlanStatusEnum>`	`getStatusElement()` Gets the value(s) for status ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject ().
`List<ResourceReferenceDt>`	`getSupport()` Gets the value(s) for support ().
`boolean`	`isEmpty()`
`CarePlan`	`setActivity(List<CarePlan.Activity> theValue)` Sets the value(s) for activity ()
`CarePlan`	`setAddresses(List<ResourceReferenceDt> theValue)` Sets the value(s) for addresses ()
`CarePlan`	`setAuthor(List<ResourceReferenceDt> theValue)` Sets the value(s) for author ()
`CarePlan`	`setCategory(List<CodeableConceptDt> theValue)` Sets the value(s) for category ()
`CarePlan`	`setContext(ResourceReferenceDt theValue)` Sets the value(s) for context ()
`CarePlan`	`setDescription(String theString)` Sets the value for description ()
`CarePlan`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`CarePlan`	`setGoal(List<ResourceReferenceDt> theValue)` Sets the value(s) for goal ()
`CarePlan`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`CarePlan`	`setModified(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for modified ()
`CarePlan`	`setModified(DateTimeDt theValue)` Sets the value(s) for modified ()
`CarePlan`	`setModifiedWithSecondsPrecision(Date theDate)` Sets the value for modified ()
`CarePlan`	`setNote(AnnotationDt theValue)` Sets the value(s) for note ()
`CarePlan`	`setParticipant(List<CarePlan.Participant> theValue)` Sets the value(s) for participant ()
`CarePlan`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period ()
`CarePlan`	`setRelatedPlan(List<CarePlan.RelatedPlan> theValue)` Sets the value(s) for relatedPlan ()
`CarePlan`	`setStatus(BoundCodeDt<CarePlanStatusEnum> theValue)` Sets the value(s) for status ()
`CarePlan`	`setStatus(CarePlanStatusEnum theValue)` Sets the value(s) for status ()
`CarePlan`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject ()
`CarePlan`	`setSupport(List<ResourceReferenceDt> theValue)` Sets the value(s) for support ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

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

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: CarePlan.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: CarePlan.subject
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description:
    Type: reference
    Path: CarePlan.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description:
    Type: reference
    Path: CarePlan.subject
  - SP_CONDITION
```
public static final String SP_CONDITION
```
    Search parameter constant for condition
    Description:
    Type: reference
    Path: CarePlan.addresses
    
    See Also:
    
    Constant Field Values
  - CONDITION
```
public static final ReferenceClientParam CONDITION
```
    Fluent Client search parameter constant for condition
    Description:
    Type: reference
    Path: CarePlan.addresses
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: CarePlan.period
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: CarePlan.period
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    Search parameter constant for participant
    Description:
    Type: reference
    Path: CarePlan.participant.member
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final ReferenceClientParam PARTICIPANT
```
    Fluent Client search parameter constant for participant
    Description:
    Type: reference
    Path: CarePlan.participant.member
  - SP_ACTIVITYCODE
```
public static final String SP_ACTIVITYCODE
```
    Search parameter constant for activitycode
    Description:
    Type: token
    Path: CarePlan.activity.detail.code
    
    See Also:
    
    Constant Field Values
  - ACTIVITYCODE
```
public static final TokenClientParam ACTIVITYCODE
```
    Fluent Client search parameter constant for activitycode
    Description:
    Type: token
    Path: CarePlan.activity.detail.code
  - SP_ACTIVITYDATE
```
public static final String SP_ACTIVITYDATE
```
    Search parameter constant for activitydate
    Description: Specified date occurs within period specified by CarePlan.activity.timingSchedule
    Type: date
    Path: CarePlan.activity.detail.scheduled[x]
    
    See Also:
    
    Constant Field Values
  - ACTIVITYDATE
```
public static final DateClientParam ACTIVITYDATE
```
    Fluent Client search parameter constant for activitydate
    Description: Specified date occurs within period specified by CarePlan.activity.timingSchedule
    Type: date
    Path: CarePlan.activity.detail.scheduled[x]
  - SP_ACTIVITYREFERENCE
```
public static final String SP_ACTIVITYREFERENCE
```
    Search parameter constant for activityreference
    Description:
    Type: reference
    Path: CarePlan.activity.reference
    
    See Also:
    
    Constant Field Values
  - ACTIVITYREFERENCE
```
public static final ReferenceClientParam ACTIVITYREFERENCE
```
    Fluent Client search parameter constant for activityreference
    Description:
    Type: reference
    Path: CarePlan.activity.reference
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    Search parameter constant for performer
    Description: Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
    Type: reference
    Path: CarePlan.activity.detail.performer
    
    See Also:
    
    Constant Field Values
  - PERFORMER
```
public static final ReferenceClientParam PERFORMER
```
    Fluent Client search parameter constant for performer
    Description: Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
    Type: reference
    Path: CarePlan.activity.detail.performer
  - SP_GOAL
```
public static final String SP_GOAL
```
    Search parameter constant for goal
    Description:
    Type: reference
    Path: CarePlan.goal
    
    See Also:
    
    Constant Field Values
  - GOAL
```
public static final ReferenceClientParam GOAL
```
    Fluent Client search parameter constant for goal
    Description:
    Type: reference
    Path: CarePlan.goal
  - SP_RELATEDCODE
```
public static final String SP_RELATEDCODE
```
    Search parameter constant for relatedcode
    Description:
    Type: token
    Path: CarePlan.relatedPlan.code
    
    See Also:
    
    Constant Field Values
  - RELATEDCODE
```
public static final TokenClientParam RELATEDCODE
```
    Fluent Client search parameter constant for relatedcode
    Description:
    Type: token
    Path: CarePlan.relatedPlan.code
  - SP_RELATEDPLAN
```
public static final String SP_RELATEDPLAN
```
    Search parameter constant for relatedplan
    Description:
    Type: reference
    Path: CarePlan.relatedPlan.plan
    
    See Also:
    
    Constant Field Values
  - RELATEDPLAN
```
public static final ReferenceClientParam RELATEDPLAN
```
    Fluent Client search parameter constant for relatedplan
    Description:
    Type: reference
    Path: CarePlan.relatedPlan.plan
  - SP_RELATEDCODE_RELATEDPLAN
```
public static final String SP_RELATEDCODE_RELATEDPLAN
```
    Search parameter constant for relatedcode-relatedplan
    Description: A combination of the type of relationship and the related plan
    Type: composite
    Path: relatedcode & relatedplan
    
    See Also:
    
    Constant Field Values
  - RELATEDCODE_RELATEDPLAN
```
public static final CompositeClientParam<TokenClientParam,ReferenceClientParam> RELATEDCODE_RELATEDPLAN
```
    Fluent Client search parameter constant for relatedcode-relatedplan
    Description: A combination of the type of relationship and the related plan
    Type: composite
    Path: relatedcode & relatedplan
  - INCLUDE_ACTIVITYREFERENCE
```
public static final Include INCLUDE_ACTIVITYREFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activityreference".
  - INCLUDE_CONDITION
```
public static final Include INCLUDE_CONDITION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:condition".
  - INCLUDE_GOAL
```
public static final Include INCLUDE_GOAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:goal".
  - INCLUDE_PARTICIPANT
```
public static final Include INCLUDE_PARTICIPANT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:participant".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:patient".
  - INCLUDE_PERFORMER
```
public static final Include INCLUDE_PERFORMER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:performer".
  - INCLUDE_RELATEDPLAN
```
public static final Include INCLUDE_RELATEDPLAN
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:relatedplan".
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:subject".
- Constructor Detail
  - CarePlan
```
public CarePlan()
```
- 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
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - setIdentifier
```
public CarePlan setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - addIdentifier
```
public CarePlan addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (). creating it if it does not exist. Will not return null.
    Definition: Identifies the patient or group whose intended care is described by the plan.
  - setSubject
```
public CarePlan setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject ()
    Definition: Identifies the patient or group whose intended care is described by the plan.
  - getStatusElement
```
public BoundCodeDt<CarePlanStatusEnum> getStatusElement()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (). creating it if it does not exist. Will not return null.
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - setStatus
```
public CarePlan setStatus(BoundCodeDt<CarePlanStatusEnum> theValue)
```
    Sets the value(s) for status ()
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - setStatus
```
public CarePlan setStatus(CarePlanStatusEnum theValue)
```
    Sets the value(s) for status ()
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - getContext
```
public ResourceReferenceDt getContext()
```
    Gets the value(s) for context (). creating it if it does not exist. Will not return null.
    Definition: Identifies the context in which this particular CarePlan is defined.
  - setContext
```
public CarePlan setContext(ResourceReferenceDt theValue)
```
    Sets the value(s) for context ()
    Definition: Identifies the context in which this particular CarePlan is defined.
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (). creating it if it does not exist. Will not return null.
    Definition: Indicates when the plan did (or is intended to) come into effect and end.
  - setPeriod
```
public CarePlan setPeriod(PeriodDt theValue)
```
    Sets the value(s) for period ()
    Definition: Indicates when the plan did (or is intended to) come into effect and end.
  - getAuthor
```
public List<ResourceReferenceDt> getAuthor()
```
    Gets the value(s) for author (). creating it if it does not exist. Will not return null.
    Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
  - setAuthor
```
public CarePlan setAuthor(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for author ()
    Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
  - addAuthor
```
public ResourceReferenceDt addAuthor()
```
    Adds and returns a new value for author ()
    Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
  - getModifiedElement
```
public DateTimeDt getModifiedElement()
```
    Gets the value(s) for modified (). creating it if it does not exist. Will not return null.
    Definition: Identifies the most recent date on which the plan has been revised.
  - getModified
```
public Date getModified()
```
    Gets the value(s) for modified (). creating it if it does not exist. Will not return null.
    Definition: Identifies the most recent date on which the plan has been revised.
  - setModified
```
public CarePlan setModified(DateTimeDt theValue)
```
    Sets the value(s) for modified ()
    Definition: Identifies the most recent date on which the plan has been revised.
  - setModified
```
public CarePlan setModified(Date theDate,
                            TemporalPrecisionEnum thePrecision)
```
    Sets the value for modified ()
    Definition: Identifies the most recent date on which the plan has been revised.
  - setModifiedWithSecondsPrecision
```
public CarePlan setModifiedWithSecondsPrecision(Date theDate)
```
    Sets the value for modified ()
    Definition: Identifies the most recent date on which the plan has been revised.
  - getCategory
```
public List<CodeableConceptDt> getCategory()
```
    Gets the value(s) for category (). creating it if it does not exist. Will not return null.
    Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.
  - setCategory
```
public CarePlan setCategory(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for category ()
    Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.
  - addCategory
```
public CodeableConceptDt addCategory()
```
    Adds and returns a new value for category ()
    Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.
  - addCategory
```
public CarePlan addCategory(CodeableConceptDt theValue)
```
    Adds a given new value for category ()
    Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.
    
    Parameters:
    
    theValue - The category to add (must not be null)
  - getCategoryFirstRep
```
public CodeableConceptDt getCategoryFirstRep()
```
    Gets the first repetition for category (), creating it if it does not already exist.
    Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A description of the scope and nature of the plan
  - getDescription
```
public String getDescription()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A description of the scope and nature of the plan
  - setDescription
```
public CarePlan setDescription(StringDt theValue)
```
    Sets the value(s) for description ()
    Definition: A description of the scope and nature of the plan
  - setDescription
```
public CarePlan setDescription(String theString)
```
    Sets the value for description ()
    Definition: A description of the scope and nature of the plan
  - getAddresses
```
public List<ResourceReferenceDt> getAddresses()
```
    Gets the value(s) for addresses (). creating it if it does not exist. Will not return null.
    Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - setAddresses
```
public CarePlan setAddresses(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for addresses ()
    Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - addAddresses
```
public ResourceReferenceDt addAddresses()
```
    Adds and returns a new value for addresses ()
    Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - getSupport
```
public List<ResourceReferenceDt> getSupport()
```
    Gets the value(s) for support (). creating it if it does not exist. Will not return null.
    Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
  - setSupport
```
public CarePlan setSupport(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for support ()
    Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
  - addSupport
```
public ResourceReferenceDt addSupport()
```
    Adds and returns a new value for support ()
    Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
  - getRelatedPlan
```
public List<CarePlan.RelatedPlan> getRelatedPlan()
```
    Gets the value(s) for relatedPlan (). creating it if it does not exist. Will not return null.
    Definition: Identifies CarePlans with some sort of formal relationship to the current plan.
  - setRelatedPlan
```
public CarePlan setRelatedPlan(List<CarePlan.RelatedPlan> theValue)
```
    Sets the value(s) for relatedPlan ()
    Definition: Identifies CarePlans with some sort of formal relationship to the current plan.
  - addRelatedPlan
```
public CarePlan.RelatedPlan addRelatedPlan()
```
    Adds and returns a new value for relatedPlan ()
    Definition: Identifies CarePlans with some sort of formal relationship to the current plan.
  - addRelatedPlan
```
public CarePlan addRelatedPlan(CarePlan.RelatedPlan theValue)
```
    Adds a given new value for relatedPlan ()
    Definition: Identifies CarePlans with some sort of formal relationship to the current plan.
    
    Parameters:
    
    theValue - The relatedPlan to add (must not be null)
  - getRelatedPlanFirstRep
```
public CarePlan.RelatedPlan getRelatedPlanFirstRep()
```
    Gets the first repetition for relatedPlan (), creating it if it does not already exist.
    Definition: Identifies CarePlans with some sort of formal relationship to the current plan.
  - getParticipant
```
public List<CarePlan.Participant> getParticipant()
```
    Gets the value(s) for participant (). creating it if it does not exist. Will not return null.
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - setParticipant
```
public CarePlan setParticipant(List<CarePlan.Participant> theValue)
```
    Sets the value(s) for participant ()
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - addParticipant
```
public CarePlan.Participant addParticipant()
```
    Adds and returns a new value for participant ()
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - addParticipant
```
public CarePlan addParticipant(CarePlan.Participant theValue)
```
    Adds a given new value for participant ()
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
    
    Parameters:
    
    theValue - The participant to add (must not be null)
  - getParticipantFirstRep
```
public CarePlan.Participant getParticipantFirstRep()
```
    Gets the first repetition for participant (), creating it if it does not already exist.
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - getGoal
```
public List<ResourceReferenceDt> getGoal()
```
    Gets the value(s) for goal (). creating it if it does not exist. Will not return null.
    Definition: Describes the intended objective(s) of carrying out the care plan.
  - setGoal
```
public CarePlan setGoal(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for goal ()
    Definition: Describes the intended objective(s) of carrying out the care plan.
  - addGoal
```
public ResourceReferenceDt addGoal()
```
    Adds and returns a new value for goal ()
    Definition: Describes the intended objective(s) of carrying out the care plan.
  - getActivity
```
public List<CarePlan.Activity> getActivity()
```
    Gets the value(s) for activity (). creating it if it does not exist. Will not return null.
    Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
  - setActivity
```
public CarePlan setActivity(List<CarePlan.Activity> theValue)
```
    Sets the value(s) for activity ()
    Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
  - addActivity
```
public CarePlan.Activity addActivity()
```
    Adds and returns a new value for activity ()
    Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
  - addActivity
```
public CarePlan addActivity(CarePlan.Activity theValue)
```
    Adds a given new value for activity ()
    Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
    
    Parameters:
    
    theValue - The activity to add (must not be null)
  - getActivityFirstRep
```
public CarePlan.Activity getActivityFirstRep()
```
    Gets the first repetition for activity (), creating it if it does not already exist.
    Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
  - getNote
```
public AnnotationDt getNote()
```
    Gets the value(s) for note (). creating it if it does not exist. Will not return null.
    Definition: General notes about the care plan not covered elsewhere
  - setNote
```
public CarePlan setNote(AnnotationDt theValue)
```
    Sets the value(s) for note ()
    Definition: General notes about the care plan not covered elsewhere
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class CarePlan

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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.IResource

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

Field Detail

SP_PATIENT

PATIENT

SP_SUBJECT

SUBJECT

SP_CONDITION

CONDITION

SP_DATE

DATE

SP_PARTICIPANT

PARTICIPANT

SP_ACTIVITYCODE

ACTIVITYCODE

SP_ACTIVITYDATE

ACTIVITYDATE

SP_ACTIVITYREFERENCE

ACTIVITYREFERENCE

SP_PERFORMER

PERFORMER

SP_GOAL

GOAL

SP_RELATEDCODE

RELATEDCODE

SP_RELATEDPLAN

RELATEDPLAN

SP_RELATEDCODE_RELATEDPLAN

RELATEDCODE_RELATEDPLAN

INCLUDE_ACTIVITYREFERENCE

INCLUDE_CONDITION

INCLUDE_GOAL

INCLUDE_PARTICIPANT

INCLUDE_PATIENT

INCLUDE_PERFORMER

INCLUDE_RELATEDPLAN

INCLUDE_SUBJECT

Constructor Detail

CarePlan

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getSubject

setSubject

getStatusElement

getStatus

setStatus

setStatus

getContext

setContext

getPeriod

setPeriod

getAuthor

setAuthor

addAuthor

getModifiedElement

getModified

setModified

setModified

setModifiedWithSecondsPrecision

getCategory

setCategory

addCategory

addCategory

getCategoryFirstRep