CarePlan (HAPI FHIR - Core Library 0.7 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class CarePlan
extends BaseResource
implements IResource
```
HAPI/FHIR CarePlan Resource (Healthcare plan for patient)
Definition: Describes the intention of how one or more practitioners intend to deliver care for a particular patient 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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CarePlan.Activity` Block class for child element: CarePlan.activity (Action to occur as part of plan)
`static class`	`CarePlan.ActivitySimple` Block class for child element: CarePlan.activity.simple (Activity details summarised here)
`static class`	`CarePlan.Goal` Block class for child element: CarePlan.goal (Desired outcome of plan)
`static class`	`CarePlan.Participant` Block class for child element: CarePlan.participant (Who's involved in plan?)

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`	`ACTIVITYDETAIL` Fluent Client search parameter constant for activitydetail
`static ReferenceClientParam`	`CONDITION` Fluent Client search parameter constant for condition
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static Include`	`INCLUDE_ACTIVITY_DETAIL` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_CONCERN` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PARTICIPANT_MEMBER` 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 ReferenceClientParam`	`PARTICIPANT` Fluent Client search parameter constant for participant
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_ACTIVITYCODE` Search parameter constant for activitycode
`static String`	`SP_ACTIVITYDATE` Search parameter constant for activitydate
`static String`	`SP_ACTIVITYDETAIL` Search parameter constant for activitydetail
`static String`	`SP_CONDITION` Search parameter constant for condition
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_PARTICIPANT` Search parameter constant for participant
`static String`	`SP_PATIENT` Search parameter constant for patient

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

CarePlan()

Constructors
Constructor and Description
`CarePlan()`

Method Summary

Methods
Modifier and Type	Method and Description
`CarePlan.Activity`	`addActivity()` Adds and returns a new value for activity (Action to occur as part of plan)
`ResourceReferenceDt`	`addConcern()` Adds and returns a new value for concern (Health issues this plan addresses)
`CarePlan.Goal`	`addGoal()` Adds and returns a new value for goal (Desired outcome of plan)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Ids for this plan)
`CarePlan`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Ids for this plan)
`CarePlan`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Ids for this plan)
`CarePlan.Participant`	`addParticipant()` Adds and returns a new value for participant (Who's involved in plan?)
`List<CarePlan.Activity>`	`getActivity()` Gets the value(s) for activity (Action to occur as part of plan).
`CarePlan.Activity`	`getActivityFirstRep()` Gets the first repetition for activity (Action to occur as part of plan), creating it if it does not already exist.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<ResourceReferenceDt>`	`getConcern()` Gets the value(s) for concern (Health issues this plan addresses).
`List<CarePlan.Goal>`	`getGoal()` Gets the value(s) for goal (Desired outcome of plan).
`CarePlan.Goal`	`getGoalFirstRep()` Gets the first repetition for goal (Desired outcome of plan), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External Ids for this plan).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External Ids for this plan), creating it if it does not already exist.
`DateTimeDt`	`getModified()` Gets the value(s) for modified (When last updated).
`StringDt`	`getNotes()` Gets the value(s) for notes (Comments about the plan).
`List<CarePlan.Participant>`	`getParticipant()` Gets the value(s) for participant (Who's involved in plan?).
`CarePlan.Participant`	`getParticipantFirstRep()` Gets the first repetition for participant (Who's involved in plan?), creating it if it does not already exist.
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (Who care plan is for).
`PeriodDt`	`getPeriod()` Gets the value(s) for period (Time period plan covers).
`BoundCodeDt<CarePlanStatusEnum>`	`getStatus()` Gets the value(s) for status (planned \| active \| completed).
`boolean`	`isEmpty()`
`CarePlan`	`setActivity(List<CarePlan.Activity> theValue)` Sets the value(s) for activity (Action to occur as part of plan)
`CarePlan`	`setConcern(List<ResourceReferenceDt> theValue)` Sets the value(s) for concern (Health issues this plan addresses)
`CarePlan`	`setGoal(List<CarePlan.Goal> theValue)` Sets the value(s) for goal (Desired outcome of plan)
`CarePlan`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Ids for this plan)
`CarePlan`	`setModified(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for modified (When last updated)
`CarePlan`	`setModified(DateTimeDt theValue)` Sets the value(s) for modified (When last updated)
`CarePlan`	`setModifiedWithSecondsPrecision(Date theDate)` Sets the value for modified (When last updated)
`CarePlan`	`setNotes(String theString)` Sets the value for notes (Comments about the plan)
`CarePlan`	`setNotes(StringDt theValue)` Sets the value(s) for notes (Comments about the plan)
`CarePlan`	`setParticipant(List<CarePlan.Participant> theValue)` Sets the value(s) for participant (Who's involved in plan?)
`CarePlan`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (Who care plan is for)
`CarePlan`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period (Time period plan covers)
`CarePlan`	`setStatus(BoundCodeDt<CarePlanStatusEnum> theValue)` Sets the value(s) for status (planned \| active \| completed)
`CarePlan`	`setStatus(CarePlanStatusEnum theValue)` Sets the value(s) for status (planned \| active \| completed)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- Field Detail
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: CarePlan.patient
    
    See Also:
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: CarePlan.patient
  - 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".
  - SP_CONDITION
```
public static final String SP_CONDITION
```
    Search parameter constant for condition
    Description:
    Type: reference
    Path: CarePlan.concern
    
    See Also:
    Constant Field Values
  - CONDITION
```
public static final ReferenceClientParam CONDITION
```
    Fluent Client search parameter constant for condition
    Description:
    Type: reference
    Path: CarePlan.concern
  - INCLUDE_CONCERN
```
public static final Include INCLUDE_CONCERN
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan.concern".
  - 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
  - INCLUDE_PARTICIPANT_MEMBER
```
public static final Include INCLUDE_PARTICIPANT_MEMBER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan.participant.member".
  - SP_ACTIVITYCODE
```
public static final String SP_ACTIVITYCODE
```
    Search parameter constant for activitycode
    Description:
    Type: token
    Path: CarePlan.activity.simple.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.simple.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.simple.timing[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.simple.timing[x]
  - SP_ACTIVITYDETAIL
```
public static final String SP_ACTIVITYDETAIL
```
    Search parameter constant for activitydetail
    Description:
    Type: reference
    Path: CarePlan.activity.detail
    
    See Also:
    Constant Field Values
  - ACTIVITYDETAIL
```
public static final ReferenceClientParam ACTIVITYDETAIL
```
    Fluent Client search parameter constant for activitydetail
    Description:
    Type: reference
    Path: CarePlan.activity.detail
  - INCLUDE_ACTIVITY_DETAIL
```
public static final Include INCLUDE_ACTIVITY_DETAIL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan.activity.detail".
- Constructor Detail
  - CarePlan
```
public CarePlan()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External Ids for this plan). 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 processed 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 (External Ids for this plan)
    Definition: This records identifiers associated with this care plan that are defined by business processed 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 (External Ids for this plan)
    Definition: This records identifiers associated with this care plan that are defined by business processed 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)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External Ids for this plan), creating it if it does not already exist.
    Definition: This records identifiers associated with this care plan that are defined by business processed 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(IdentifierUseEnum theUse,
                     String theSystem,
                     String theValue,
                     String theLabel)
```
    Adds a new value for identifier (External Ids for this plan)
    Definition: This records identifiers associated with this care plan that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public CarePlan addIdentifier(String theSystem,
                     String theValue)
```
    Adds a new value for identifier (External Ids for this plan)
    Definition: This records identifiers associated with this care plan that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (Who care plan is for). creating it if it does not exist. Will not return null.
    Definition: Identifies the patient/subject whose intended care is described by the plan.
  - setPatient
```
public CarePlan setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (Who care plan is for)
    Definition: Identifies the patient/subject whose intended care is described by the plan.
  - getStatus
```
public BoundCodeDt<CarePlanStatusEnum> getStatus()
```
    Gets the value(s) for status (planned | active | completed). 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 just historical record.
  - setStatus
```
public CarePlan setStatus(BoundCodeDt<CarePlanStatusEnum> theValue)
```
    Sets the value(s) for status (planned | active | completed)
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.
  - setStatus
```
public CarePlan setStatus(CarePlanStatusEnum theValue)
```
    Sets the value(s) for status (planned | active | completed)
    Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (Time period plan covers). 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 (Time period plan covers)
    Definition: Indicates when the plan did (or is intended to) come into effect and end.
  - getModified
```
public DateTimeDt getModified()
```
    Gets the value(s) for modified (When last updated). 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 (When last updated)
    Definition: Identifies the most recent date on which the plan has been revised.
  - setModifiedWithSecondsPrecision
```
public CarePlan setModifiedWithSecondsPrecision(Date theDate)
```
    Sets the value for modified (When last updated)
    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 (When last updated)
    Definition: Identifies the most recent date on which the plan has been revised.
  - getConcern
```
public List<ResourceReferenceDt> getConcern()
```
    Gets the value(s) for concern (Health issues this plan 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.
  - setConcern
```
public CarePlan setConcern(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for concern (Health issues this plan addresses)
    Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - addConcern
```
public ResourceReferenceDt addConcern()
```
    Adds and returns a new value for concern (Health issues this plan addresses)
    Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - getParticipant
```
public List<CarePlan.Participant> getParticipant()
```
    Gets the value(s) for participant (Who's involved in plan?). 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 (Who's involved in plan?)
    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 (Who's involved in plan?)
    Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - getParticipantFirstRep
```
public CarePlan.Participant getParticipantFirstRep()
```
    Gets the first repetition for participant (Who's involved in plan?), 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<CarePlan.Goal> getGoal()
```
    Gets the value(s) for goal (Desired outcome of plan). 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<CarePlan.Goal> theValue)
```
    Sets the value(s) for goal (Desired outcome of plan)
    Definition: Describes the intended objective(s) of carrying out the Care Plan.
  - addGoal
```
public CarePlan.Goal addGoal()
```
    Adds and returns a new value for goal (Desired outcome of plan)
    Definition: Describes the intended objective(s) of carrying out the Care Plan.
  - getGoalFirstRep
```
public CarePlan.Goal getGoalFirstRep()
```
    Gets the first repetition for goal (Desired outcome of plan), creating it if it does not already exist.
    Definition: Describes the intended objective(s) of carrying out the Care Plan.
  - getActivity
```
public List<CarePlan.Activity> getActivity()
```
    Gets the value(s) for activity (Action to occur as part of plan). 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 (Action to occur as part of plan)
    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 (Action to occur as part of plan)
    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.
  - getActivityFirstRep
```
public CarePlan.Activity getActivityFirstRep()
```
    Gets the first repetition for activity (Action to occur as part of plan), 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.
  - getNotes
```
public StringDt getNotes()
```
    Gets the value(s) for notes (Comments about the plan). creating it if it does not exist. Will not return null.
    Definition: General notes about the care plan not covered elsewhere
  - setNotes
```
public CarePlan setNotes(StringDt theValue)
```
    Sets the value(s) for notes (Comments about the plan)
    Definition: General notes about the care plan not covered elsewhere
  - setNotes
```
public CarePlan setNotes(String theString)
```
    Sets the value for notes (Comments about the plan)
    Definition: General notes about the care plan not covered elsewhere

Class CarePlan

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_CONDITION

CONDITION

INCLUDE_CONCERN

SP_DATE

DATE

SP_PARTICIPANT

PARTICIPANT

INCLUDE_PARTICIPANT_MEMBER

SP_ACTIVITYCODE

ACTIVITYCODE

SP_ACTIVITYDATE

ACTIVITYDATE

SP_ACTIVITYDETAIL

ACTIVITYDETAIL

INCLUDE_ACTIVITY_DETAIL

Constructor Detail

CarePlan

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getPatient

setPatient

getStatus

setStatus

setStatus

getPeriod

setPeriod

getModified

setModified

setModifiedWithSecondsPrecision

setModified

getConcern

setConcern

addConcern

getParticipant

setParticipant

addParticipant

getParticipantFirstRep

getGoal

setGoal

addGoal

getGoalFirstRep

getActivity

setActivity

addActivity

getActivityFirstRep

getNotes

setNotes

setNotes