ca.uhn.fhir.model.dstu.resource

Class CarePlan.Activity

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.CarePlan.Activity

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

CarePlan

public static class CarePlan.Activity
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: CarePlan.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.

Constructor Summary

Constructors

Constructor and Description
CarePlan.Activity()

Method Summary

Methods

Modifier and Type	Method and Description
ResourceReferenceDt	addActionResulting() Adds and returns a new value for actionResulting (Appointments, orders, etc.)
IdrefDt	addGoal() Adds and returns a new value for goal (Goals this activity relates to)
List<ResourceReferenceDt>	getActionResulting() Gets the value(s) for actionResulting (Appointments, orders, etc.).
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getDetail() Gets the value(s) for detail (Activity details defined in specific resource).
List<IdrefDt>	getGoal() Gets the value(s) for goal (Goals this activity relates to).
IdrefDt	getGoalFirstRep() Gets the first repetition for goal (Goals this activity relates to), creating it if it does not already exist.
StringDt	getNotes() Gets the value(s) for notes (Comments about the activity).
BooleanDt	getProhibited() Gets the value(s) for prohibited (Do NOT do).
CarePlan.ActivitySimple	getSimple() Gets the value(s) for simple (Activity details summarised here).
BoundCodeDt<CarePlanActivityStatusEnum>	getStatus() Gets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled).
boolean	isEmpty()
CarePlan.Activity	setActionResulting(List<ResourceReferenceDt> theValue) Sets the value(s) for actionResulting (Appointments, orders, etc.)
CarePlan.Activity	setDetail(ResourceReferenceDt theValue) Sets the value(s) for detail (Activity details defined in specific resource)
CarePlan.Activity	setGoal(List<IdrefDt> theValue) Sets the value(s) for goal (Goals this activity relates to)
CarePlan.Activity	setNotes(String theString) Sets the value for notes (Comments about the activity)
CarePlan.Activity	setNotes(StringDt theValue) Sets the value(s) for notes (Comments about the activity)
CarePlan.Activity	setProhibited(boolean theBoolean) Sets the value for prohibited (Do NOT do)
CarePlan.Activity	setProhibited(BooleanDt theValue) Sets the value(s) for prohibited (Do NOT do)
CarePlan.Activity	setSimple(CarePlan.ActivitySimple theValue) Sets the value(s) for simple (Activity details summarised here)
CarePlan.Activity	setStatus(BoundCodeDt<CarePlanActivityStatusEnum> theValue) Sets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled)
CarePlan.Activity	setStatus(CarePlanActivityStatusEnum theValue) Sets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled)

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

getElementSpecificId, getId, setElementSpecificId, setId, setId

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

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getElementSpecificId, getId, setElementSpecificId, setId, setId

Constructor Detail

CarePlan.Activity

public CarePlan.Activity()

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

getGoal

public List<IdrefDt> getGoal()

Gets the value(s) for goal (Goals this activity relates to). creating it if it does not exist. Will not return null.

Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

setGoal

public CarePlan.Activity setGoal(List<IdrefDt> theValue)

Sets the value(s) for goal (Goals this activity relates to)

Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

addGoal

public IdrefDt addGoal()

Adds and returns a new value for goal (Goals this activity relates to)

Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

getGoalFirstRep

public IdrefDt getGoalFirstRep()

Gets the first repetition for goal (Goals this activity relates to), creating it if it does not already exist.

Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting

getStatus

public BoundCodeDt<CarePlanActivityStatusEnum> getStatus()

Gets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled). creating it if it does not exist. Will not return null.

Definition: Identifies what progress is being made for the specific activity.

setStatus

public CarePlan.Activity setStatus(BoundCodeDt<CarePlanActivityStatusEnum> theValue)

Sets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled)

Definition: Identifies what progress is being made for the specific activity.

setStatus

public CarePlan.Activity setStatus(CarePlanActivityStatusEnum theValue)

Sets the value(s) for status (not started | scheduled | in progress | on hold | completed | cancelled)

Definition: Identifies what progress is being made for the specific activity.

getProhibited

public BooleanDt getProhibited()

Gets the value(s) for prohibited (Do NOT do). creating it if it does not exist. Will not return null.

Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

setProhibited

public CarePlan.Activity setProhibited(BooleanDt theValue)

Sets the value(s) for prohibited (Do NOT do)

Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

setProhibited

public CarePlan.Activity setProhibited(boolean theBoolean)

Sets the value for prohibited (Do NOT do)

Definition: If true, indicates that the described activity is one that must NOT be engaged in when following the plan.

getActionResulting

public List<ResourceReferenceDt> getActionResulting()

Gets the value(s) for actionResulting (Appointments, orders, etc.). creating it if it does not exist. Will not return null.

Definition: Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.

setActionResulting

public CarePlan.Activity setActionResulting(List<ResourceReferenceDt> theValue)

Sets the value(s) for actionResulting (Appointments, orders, etc.)

Definition: Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.

addActionResulting

public ResourceReferenceDt addActionResulting()

Adds and returns a new value for actionResulting (Appointments, orders, etc.)

Definition: Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.

getNotes

public StringDt getNotes()

Gets the value(s) for notes (Comments about the activity). creating it if it does not exist. Will not return null.

Definition: Notes about the execution of the activity

setNotes

public CarePlan.Activity setNotes(StringDt theValue)

Sets the value(s) for notes (Comments about the activity)

Definition: Notes about the execution of the activity

setNotes

public CarePlan.Activity setNotes(String theString)

Sets the value for notes (Comments about the activity)

Definition: Notes about the execution of the activity

getDetail

public ResourceReferenceDt getDetail()

Gets the value(s) for detail (Activity details defined in specific resource). creating it if it does not exist. Will not return null.

Definition: The details of the proposed activity represented in a specific resource

setDetail

public CarePlan.Activity setDetail(ResourceReferenceDt theValue)

Sets the value(s) for detail (Activity details defined in specific resource)

Definition: The details of the proposed activity represented in a specific resource

getSimple

public CarePlan.ActivitySimple getSimple()

Gets the value(s) for simple (Activity details summarised here). creating it if it does not exist. Will not return null.

Definition: A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc

setSimple

public CarePlan.Activity setSimple(CarePlan.ActivitySimple theValue)

Sets the value(s) for simple (Activity details summarised here)

Definition: A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc