CarePlan (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.CarePlan

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class CarePlan
extends DomainResource
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CarePlan.CarePlanActivityComponent`
`static class`	`CarePlan.CarePlanActivityDetailComponent`
`static class`	`CarePlan.CarePlanActivityStatus`
`static class`	`CarePlan.CarePlanActivityStatusEnumFactory`
`static class`	`CarePlan.CarePlanParticipantComponent`
`static class`	`CarePlan.CarePlanRelatedPlanComponent`
`static class`	`CarePlan.CarePlanRelationship`
`static class`	`CarePlan.CarePlanRelationshipEnumFactory`
`static class`	`CarePlan.CarePlanStatus`
`static class`	`CarePlan.CarePlanStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CarePlan.CarePlanActivityComponent>`	`activity` Identifies a planned action to occur as part of the plan.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACTIVITYCODE` Fluent Client search parameter constant for activitycode
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`ACTIVITYDATE` Fluent Client search parameter constant for activitydate
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ACTIVITYREFERENCE` Fluent Client search parameter constant for activityreference
`protected List<Reference>`	`addresses` Identifies the conditions/problems/concerns/diagnoses/etc.
`protected List<Condition>`	`addressesTarget` The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc.
`protected List<Reference>`	`author` Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
`protected List<Resource>`	`authorTarget` The actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
`protected List<CodeableConcept>`	`category` Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`CONDITION` Fluent Client search parameter constant for condition
`protected Reference`	`context` Identifies the context in which this particular CarePlan is defined.
`protected Resource`	`contextTarget` The actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.)
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected StringType`	`description` A description of the scope and nature of the plan.
`protected List<Reference>`	`goal` Describes the intended objective(s) of carrying out the care plan.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`GOAL` Fluent Client search parameter constant for goal
`protected List<Goal>`	`goalTarget` The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)
`protected List<Identifier>`	`identifier` 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.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ACTIVITYREFERENCE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_CONDITION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_GOAL` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PARTICIPANT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PERFORMER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RELATEDPLAN` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected DateTimeType`	`modified` Identifies the most recent date on which the plan has been revised.
`protected Annotation`	`note` General notes about the care plan not covered elsewhere.
`protected List<CarePlan.CarePlanParticipantComponent>`	`participant` Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PARTICIPANT` Fluent Client search parameter constant for participant
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PERFORMER` Fluent Client search parameter constant for performer
`protected Period`	`period` Indicates when the plan did (or is intended to) come into effect and end.
`static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.ReferenceClientParam>`	`RELATED` Fluent Client search parameter constant for related
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`RELATEDCODE` Fluent Client search parameter constant for relatedcode
`protected List<CarePlan.CarePlanRelatedPlanComponent>`	`relatedPlan` Identifies CarePlans with some sort of formal relationship to the current plan.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RELATEDPLAN` Fluent Client search parameter constant for relatedplan
`static String`	`SP_ACTIVITYCODE` Search parameter: activitycode
`static String`	`SP_ACTIVITYDATE` Search parameter: activitydate
`static String`	`SP_ACTIVITYREFERENCE` Search parameter: activityreference
`static String`	`SP_CONDITION` Search parameter: condition
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_GOAL` Search parameter: goal
`static String`	`SP_PARTICIPANT` Search parameter: participant
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PERFORMER` Search parameter: performer
`static String`	`SP_RELATED` Search parameter: related
`static String`	`SP_RELATEDCODE` Search parameter: relatedcode
`static String`	`SP_RELATEDPLAN` Search parameter: relatedplan
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Enumeration<CarePlan.CarePlanStatus>`	`status` Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
`protected Reference`	`subject` Identifies the patient or group whose intended care is described by the plan.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)
`protected List<Reference>`	`support` Identifies portions of the patient's record that specifically influenced the formation of the plan.
`protected List<Resource>`	`supportTarget` The actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan.

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
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()
Constructor

CarePlan(Enumeration<CarePlan.CarePlanStatus> status)
Constructor

Constructors
Constructor and Description
`CarePlan()` Constructor
`CarePlan(Enumeration<CarePlan.CarePlanStatus> status)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CarePlan.CarePlanActivityComponent`	`addActivity()`
`CarePlan`	`addActivity(CarePlan.CarePlanActivityComponent t)`
`Reference`	`addAddresses()`
`CarePlan`	`addAddresses(Reference t)`
`Condition`	`addAddressesTarget()`
`Reference`	`addAuthor()`
`CarePlan`	`addAuthor(Reference t)`
`CodeableConcept`	`addCategory()`
`CarePlan`	`addCategory(CodeableConcept t)`
`Base`	`addChild(String name)`
`Reference`	`addGoal()`
`CarePlan`	`addGoal(Reference t)`
`Goal`	`addGoalTarget()`
`Identifier`	`addIdentifier()`
`CarePlan`	`addIdentifier(Identifier t)`
`CarePlan.CarePlanParticipantComponent`	`addParticipant()`
`CarePlan`	`addParticipant(CarePlan.CarePlanParticipantComponent t)`
`CarePlan.CarePlanRelatedPlanComponent`	`addRelatedPlan()`
`CarePlan`	`addRelatedPlan(CarePlan.CarePlanRelatedPlanComponent t)`
`Reference`	`addSupport()`
`CarePlan`	`addSupport(Reference t)`
`CarePlan`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<CarePlan.CarePlanActivityComponent>`	`getActivity()`
`List<Reference>`	`getAddresses()`
`List<Condition>`	`getAddressesTarget()`
`List<Reference>`	`getAuthor()`
`List<Resource>`	`getAuthorTarget()`
`List<CodeableConcept>`	`getCategory()`
`Reference`	`getContext()`
`Resource`	`getContextTarget()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Reference>`	`getGoal()`
`List<Goal>`	`getGoalTarget()`
`List<Identifier>`	`getIdentifier()`
`Date`	`getModified()`
`DateTimeType`	`getModifiedElement()`
`Annotation`	`getNote()`
`List<CarePlan.CarePlanParticipantComponent>`	`getParticipant()`
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CarePlan.CarePlanRelatedPlanComponent>`	`getRelatedPlan()`
`ResourceType`	`getResourceType()`
`CarePlan.CarePlanStatus`	`getStatus()`
`Enumeration<CarePlan.CarePlanStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`List<Reference>`	`getSupport()`
`List<Resource>`	`getSupportTarget()`
`boolean`	`hasActivity()`
`boolean`	`hasAddresses()`
`boolean`	`hasAuthor()`
`boolean`	`hasCategory()`
`boolean`	`hasContext()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasGoal()`
`boolean`	`hasIdentifier()`
`boolean`	`hasModified()`
`boolean`	`hasModifiedElement()`
`boolean`	`hasNote()`
`boolean`	`hasParticipant()`
`boolean`	`hasPeriod()`
`boolean`	`hasRelatedPlan()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasSupport()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`CarePlan`	`setContext(Reference value)`
`CarePlan`	`setContextTarget(Resource value)`
`CarePlan`	`setDescription(String value)`
`CarePlan`	`setDescriptionElement(StringType value)`
`CarePlan`	`setModified(Date value)`
`CarePlan`	`setModifiedElement(DateTimeType value)`
`CarePlan`	`setNote(Annotation value)`
`CarePlan`	`setPeriod(Period value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`CarePlan`	`setStatus(CarePlan.CarePlanStatus value)`
`CarePlan`	`setStatusElement(Enumeration<CarePlan.CarePlanStatus> value)`
`CarePlan`	`setSubject(Reference value)`
`CarePlan`	`setSubjectTarget(Resource value)`
`protected CarePlan`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    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).
  - subject
```
protected Reference subject
```
    Identifies the patient or group whose intended care is described by the plan.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)
  - status
```
protected Enumeration<CarePlan.CarePlanStatus> status
```
    Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - context
```
protected Reference context
```
    Identifies the context in which this particular CarePlan is defined.
  - contextTarget
```
protected Resource contextTarget
```
    The actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.)
  - period
```
protected Period period
```
    Indicates when the plan did (or is intended to) come into effect and end.
  - author
```
protected List<Reference> author
```
    Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
  - authorTarget
```
protected List<Resource> authorTarget
```
    The actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
  - modified
```
protected DateTimeType modified
```
    Identifies the most recent date on which the plan has been revised.
  - category
```
protected List<CodeableConcept> category
```
    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.
  - description
```
protected StringType description
```
    A description of the scope and nature of the plan.
  - addresses
```
protected List<Reference> addresses
```
    Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
  - addressesTarget
```
protected List<Condition> addressesTarget
```
    The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
  - support
```
protected List<Reference> support
```
    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.
  - supportTarget
```
protected List<Resource> supportTarget
```
    The actual objects that are the target of the reference (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.)
  - relatedPlan
```
protected List<CarePlan.CarePlanRelatedPlanComponent> relatedPlan
```
    Identifies CarePlans with some sort of formal relationship to the current plan.
  - participant
```
protected List<CarePlan.CarePlanParticipantComponent> participant
```
    Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
  - goal
```
protected List<Reference> goal
```
    Describes the intended objective(s) of carrying out the care plan.
  - goalTarget
```
protected List<Goal> goalTarget
```
    The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)
  - activity
```
protected List<CarePlan.CarePlanActivityComponent> activity
```
    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.
  - note
```
protected Annotation note
```
    General notes about the care plan not covered elsewhere.
  - SP_ACTIVITYCODE
```
public static final String SP_ACTIVITYCODE
```
    Search parameter: activitycode
    Description: Detail type of activity
    Type: token
    Path: CarePlan.activity.detail.code
    
    See Also:
    
    Constant Field Values
  - ACTIVITYCODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVITYCODE
```
    Fluent Client search parameter constant for activitycode
    Description: Detail type of activity
    Type: token
    Path: CarePlan.activity.detail.code
  - SP_CONDITION
```
public static final String SP_CONDITION
```
    Search parameter: condition
    Description: Health issues this plan addresses
    Type: reference
    Path: CarePlan.addresses
    
    See Also:
    
    Constant Field Values
  - CONDITION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
```
    Fluent Client search parameter constant for condition
    Description: Health issues this plan addresses
    Type: reference
    Path: CarePlan.addresses
  - INCLUDE_CONDITION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONDITION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:condition".
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: Who care plan is for
    Type: reference
    Path: CarePlan.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: Who care plan is for
    Type: reference
    Path: CarePlan.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:subject".
  - SP_ACTIVITYDATE
```
public static final String SP_ACTIVITYDATE
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Time period plan covers
    Type: date
    Path: CarePlan.period
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Time period plan covers
    Type: date
    Path: CarePlan.period
  - SP_GOAL
```
public static final String SP_GOAL
```
    Search parameter: goal
    Description: Desired outcome of plan
    Type: reference
    Path: CarePlan.goal
    
    See Also:
    
    Constant Field Values
  - GOAL
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GOAL
```
    Fluent Client search parameter constant for goal
    Description: Desired outcome of plan
    Type: reference
    Path: CarePlan.goal
  - INCLUDE_GOAL
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_GOAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:goal".
  - SP_RELATED
```
public static final String SP_RELATED
```
    Search parameter: related
    Description: A combination of the type of relationship and the related plan
    Type: composite
    Path:
    
    See Also:
    
    Constant Field Values
  - RELATED
```
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.ReferenceClientParam> RELATED
```
    Fluent Client search parameter constant for related
    Description: A combination of the type of relationship and the related plan
    Type: composite
    Path:
  - SP_RELATEDCODE
```
public static final String SP_RELATEDCODE
```
    Search parameter: relatedcode
    Description: includes | replaces | fulfills
    Type: token
    Path: CarePlan.relatedPlan.code
    
    See Also:
    
    Constant Field Values
  - RELATEDCODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATEDCODE
```
    Fluent Client search parameter constant for relatedcode
    Description: includes | replaces | fulfills
    Type: token
    Path: CarePlan.relatedPlan.code
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Who care plan is for
    Type: reference
    Path: CarePlan.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Who care plan is for
    Type: reference
    Path: CarePlan.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:patient".
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    Search parameter: participant
    Description: Who is involved
    Type: reference
    Path: CarePlan.participant.member
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
```
    Fluent Client search parameter constant for participant
    Description: Who is involved
    Type: reference
    Path: CarePlan.participant.member
  - INCLUDE_PARTICIPANT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:participant".
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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
  - INCLUDE_PERFORMER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:performer".
  - SP_ACTIVITYREFERENCE
```
public static final String SP_ACTIVITYREFERENCE
```
    Search parameter: activityreference
    Description: Activity details defined in specific resource
    Type: reference
    Path: CarePlan.activity.reference
    
    See Also:
    
    Constant Field Values
  - ACTIVITYREFERENCE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTIVITYREFERENCE
```
    Fluent Client search parameter constant for activityreference
    Description: Activity details defined in specific resource
    Type: reference
    Path: CarePlan.activity.reference
  - INCLUDE_ACTIVITYREFERENCE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTIVITYREFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activityreference".
  - SP_RELATEDPLAN
```
public static final String SP_RELATEDPLAN
```
    Search parameter: relatedplan
    Description: Plan relationship exists with
    Type: reference
    Path: CarePlan.relatedPlan.plan
    
    See Also:
    
    Constant Field Values
  - RELATEDPLAN
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATEDPLAN
```
    Fluent Client search parameter constant for relatedplan
    Description: Plan relationship exists with
    Type: reference
    Path: CarePlan.relatedPlan.plan
  - INCLUDE_RELATEDPLAN
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATEDPLAN
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:relatedplan".
- Constructor Detail
  - CarePlan
```
public CarePlan()
```
    Constructor
  - CarePlan
```
public CarePlan(Enumeration<CarePlan.CarePlanStatus> status)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (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).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (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(Identifier t)
```
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Identifies the patient or group whose intended care is described by the plan.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public CarePlan setSubject(Reference value)
```
    Parameters:
    
    value - subject (Identifies the patient or group whose intended care is described by the plan.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject 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 patient or group whose intended care is described by the plan.)
  - setSubjectTarget
```
public CarePlan setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject 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 patient or group whose intended care is described by the plan.)
  - getStatusElement
```
public Enumeration<CarePlan.CarePlanStatus> getStatusElement()
```
    Returns:
    
    status (Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). 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 setStatusElement(Enumeration<CarePlan.CarePlanStatus> value)
```
    Parameters:
    
    value - status (Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public CarePlan.CarePlanStatus getStatus()
```
    Returns:
    
    Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - setStatus
```
public CarePlan setStatus(CarePlan.CarePlanStatus value)
```
    Parameters:
    
    value - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
  - getContext
```
public Reference getContext()
```
    Returns:
    
    context (Identifies the context in which this particular CarePlan is defined.)
  - hasContext
```
public boolean hasContext()
```
  - setContext
```
public CarePlan setContext(Reference value)
```
    Parameters:
    
    value - context (Identifies the context in which this particular CarePlan is defined.)
  - getContextTarget
```
public Resource getContextTarget()
```
    Returns:
    
    context 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 context in which this particular CarePlan is defined.)
  - setContextTarget
```
public CarePlan setContextTarget(Resource value)
```
    Parameters:
    
    value - context 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 context in which this particular CarePlan is defined.)
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (Indicates when the plan did (or is intended to) come into effect and end.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public CarePlan setPeriod(Period value)
```
    Parameters:
    
    value - period (Indicates when the plan did (or is intended to) come into effect and end.)
  - getAuthor
```
public List<Reference> getAuthor()
```
    Returns:
    
    author (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - addAuthor
```
public Reference addAuthor()
```
    Returns:
    
    author (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
  - addAuthor
```
public CarePlan addAuthor(Reference t)
```
  - getAuthorTarget
```
public List<Resource> getAuthorTarget()
```
    Returns:
    
    author (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 the individual(s) or ogranization who is responsible for the content of the care plan.)
  - getModifiedElement
```
public DateTimeType getModifiedElement()
```
    Returns:
    
    modified (Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
  - hasModifiedElement
```
public boolean hasModifiedElement()
```
  - hasModified
```
public boolean hasModified()
```
  - setModifiedElement
```
public CarePlan setModifiedElement(DateTimeType value)
```
    Parameters:
    
    value - modified (Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
  - getModified
```
public Date getModified()
```
    Returns:
    
    Identifies the most recent date on which the plan has been revised.
  - setModified
```
public CarePlan setModified(Date value)
```
    Parameters:
    
    value - Identifies the most recent date on which the plan has been revised.
  - getCategory
```
public List<CodeableConcept> getCategory()
```
    Returns:
    
    category (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.)
  - hasCategory
```
public boolean hasCategory()
```
  - addCategory
```
public CodeableConcept addCategory()
```
    Returns:
    
    category (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(CodeableConcept t)
```
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (A description of the scope and nature of the plan.). 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 setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (A description of the scope and nature of the plan.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    A description of the scope and nature of the plan.
  - setDescription
```
public CarePlan setDescription(String value)
```
    Parameters:
    
    value - A description of the scope and nature of the plan.
  - getAddresses
```
public List<Reference> getAddresses()
```
    Returns:
    
    addresses (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
  - hasAddresses
```
public boolean hasAddresses()
```
  - addAddresses
```
public Reference addAddresses()
```
    Returns:
    
    addresses (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
  - addAddresses
```
public CarePlan addAddresses(Reference t)
```
  - getAddressesTarget
```
public List<Condition> getAddressesTarget()
```
    Returns:
    
    addresses (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 the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
  - addAddressesTarget
```
public Condition addAddressesTarget()
```
    Returns:
    
    addresses (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. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
  - getSupport
```
public List<Reference> getSupport()
```
    Returns:
    
    support (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.)
  - hasSupport
```
public boolean hasSupport()
```
  - addSupport
```
public Reference addSupport()
```
    Returns:
    
    support (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 CarePlan addSupport(Reference t)
```
  - getSupportTarget
```
public List<Resource> getSupportTarget()
```
    Returns:
    
    support (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 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.CarePlanRelatedPlanComponent> getRelatedPlan()
```
    Returns:
    
    relatedPlan (Identifies CarePlans with some sort of formal relationship to the current plan.)
  - hasRelatedPlan
```
public boolean hasRelatedPlan()
```
  - addRelatedPlan
```
public CarePlan.CarePlanRelatedPlanComponent addRelatedPlan()
```
    Returns:
    
    relatedPlan (Identifies CarePlans with some sort of formal relationship to the current plan.)
  - addRelatedPlan
```
public CarePlan addRelatedPlan(CarePlan.CarePlanRelatedPlanComponent t)
```
  - getParticipant
```
public List<CarePlan.CarePlanParticipantComponent> getParticipant()
```
    Returns:
    
    participant (Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
  - hasParticipant
```
public boolean hasParticipant()
```
  - addParticipant
```
public CarePlan.CarePlanParticipantComponent addParticipant()
```
    Returns:
    
    participant (Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
  - addParticipant
```
public CarePlan addParticipant(CarePlan.CarePlanParticipantComponent t)
```
  - getGoal
```
public List<Reference> getGoal()
```
    Returns:
    
    goal (Describes the intended objective(s) of carrying out the care plan.)
  - hasGoal
```
public boolean hasGoal()
```
  - addGoal
```
public Reference addGoal()
```
    Returns:
    
    goal (Describes the intended objective(s) of carrying out the care plan.)
  - addGoal
```
public CarePlan 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. Describes the intended objective(s) of carrying out the care plan.)
  - 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. Describes the intended objective(s) of carrying out the care plan.)
  - getActivity
```
public List<CarePlan.CarePlanActivityComponent> getActivity()
```
    Returns:
    
    activity (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.)
  - hasActivity
```
public boolean hasActivity()
```
  - addActivity
```
public CarePlan.CarePlanActivityComponent addActivity()
```
    Returns:
    
    activity (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.CarePlanActivityComponent t)
```
  - getNote
```
public Annotation getNote()
```
    Returns:
    
    note (General notes about the care plan not covered elsewhere.)
  - hasNote
```
public boolean hasNote()
```
  - setNote
```
public CarePlan setNote(Annotation value)
```
    Parameters:
    
    value - note (General notes about the care plan not covered elsewhere.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public CarePlan copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected CarePlan typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class CarePlan

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

subject

subjectTarget

status

context

contextTarget

period

author

authorTarget

modified

category

description

addresses

addressesTarget

support

supportTarget

relatedPlan

participant

goal

goalTarget

activity

note

SP_ACTIVITYCODE

ACTIVITYCODE

SP_CONDITION

CONDITION

INCLUDE_CONDITION

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_ACTIVITYDATE

ACTIVITYDATE

SP_DATE

DATE

SP_GOAL

GOAL

INCLUDE_GOAL

SP_RELATED

RELATED

SP_RELATEDCODE

RELATEDCODE

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_PARTICIPANT

PARTICIPANT

INCLUDE_PARTICIPANT

SP_PERFORMER

PERFORMER

INCLUDE_PERFORMER

SP_ACTIVITYREFERENCE

ACTIVITYREFERENCE

INCLUDE_ACTIVITYREFERENCE

SP_RELATEDPLAN

RELATEDPLAN

INCLUDE_RELATEDPLAN

Constructor Detail

CarePlan

CarePlan

Method Detail

getIdentifier

hasIdentifier