Package org.hl7.fhir.dstu2.model

Class CarePlan.CarePlanActivityDetailComponent

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.BackboneElement

org.hl7.fhir.dstu2.model.CarePlan.CarePlanActivityDetailComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

CarePlan

public static class CarePlan.CarePlanActivityDetailComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	category	High-level categorization of the type of activity in a care plan.
protected CodeableConcept	code	Detailed description of the type of planned activity; e.g.
protected SimpleQuantity	dailyAmount	Identifies the quantity expected to be consumed in a given day.
protected StringType	description	This provides a textual description of constraints on the intended activity occurrence, including relation to other activities.
protected List<Reference>	goal	Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
protected List<Goal>	goalTarget	The actual objects that are the target of the reference (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
protected Reference	location	Identifies the facility where the activity will occur; e.g.
protected Location	locationTarget	The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g.
protected List<Reference>	performer	Identifies who's expected to be involved in the activity.
protected List<Resource>	performerTarget	The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.)
protected Type	product	Identifies the food, drug or other product to be consumed or supplied in the activity.
protected BooleanType	prohibited	If true, indicates that the described activity is one that must NOT be engaged in when following the plan.
protected SimpleQuantity	quantity	Identifies the quantity expected to be supplied, administered or consumed by the subject.
protected List<CodeableConcept>	reasonCode	Provides the rationale that drove the inclusion of this particular activity as part of the plan.
protected List<Reference>	reasonReference	Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.
protected List<Condition>	reasonReferenceTarget	The actual objects that are the target of the reference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
protected Type	scheduled	The period, timing or frequency upon which the described activity is to occur.
protected Enumeration<CarePlan.CarePlanActivityStatus>	status	Identifies what progress is being made for the specific activity.
protected CodeableConcept	statusReason	Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Fields inherited from class org.hl7.fhir.dstu2.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.dstu2.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
CarePlanActivityDetailComponent()
CarePlanActivityDetailComponent(BooleanType prohibited)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addGoal()
CarePlan.CarePlanActivityDetailComponent	addGoal(Reference t)
Goal	addGoalTarget()
Reference	addPerformer()
CarePlan.CarePlanActivityDetailComponent	addPerformer(Reference t)
CodeableConcept	addReasonCode()
CarePlan.CarePlanActivityDetailComponent	addReasonCode(CodeableConcept t)
Reference	addReasonReference()
CarePlan.CarePlanActivityDetailComponent	addReasonReference(Reference t)
Condition	addReasonReferenceTarget()
CarePlan.CarePlanActivityDetailComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getCategory()
CodeableConcept	getCode()
SimpleQuantity	getDailyAmount()
String	getDescription()
StringType	getDescriptionElement()
List<Reference>	getGoal()
List<Goal>	getGoalTarget()
Reference	getLocation()
Location	getLocationTarget()
List<Reference>	getPerformer()
List<Resource>	getPerformerTarget()
Type	getProduct()
CodeableConcept	getProductCodeableConcept()
Reference	getProductReference()
boolean	getProhibited()
BooleanType	getProhibitedElement()
SimpleQuantity	getQuantity()
List<CodeableConcept>	getReasonCode()
List<Reference>	getReasonReference()
List<Condition>	getReasonReferenceTarget()
Type	getScheduled()
Period	getScheduledPeriod()
StringType	getScheduledStringType()
Timing	getScheduledTiming()
CarePlan.CarePlanActivityStatus	getStatus()
Enumeration<CarePlan.CarePlanActivityStatus>	getStatusElement()
CodeableConcept	getStatusReason()
boolean	hasCategory()
boolean	hasCode()
boolean	hasDailyAmount()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasGoal()
boolean	hasLocation()
boolean	hasPerformer()
boolean	hasProduct()
boolean	hasProductCodeableConcept()
boolean	hasProductReference()
boolean	hasProhibited()
boolean	hasProhibitedElement()
boolean	hasQuantity()
boolean	hasReasonCode()
boolean	hasReasonReference()
boolean	hasScheduled()
boolean	hasScheduledPeriod()
boolean	hasScheduledStringType()
boolean	hasScheduledTiming()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStatusReason()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
CarePlan.CarePlanActivityDetailComponent	setCategory(CodeableConcept value)
CarePlan.CarePlanActivityDetailComponent	setCode(CodeableConcept value)
CarePlan.CarePlanActivityDetailComponent	setDailyAmount(SimpleQuantity value)
CarePlan.CarePlanActivityDetailComponent	setDescription(String value)
CarePlan.CarePlanActivityDetailComponent	setDescriptionElement(StringType value)
CarePlan.CarePlanActivityDetailComponent	setLocation(Reference value)
CarePlan.CarePlanActivityDetailComponent	setLocationTarget(Location value)
CarePlan.CarePlanActivityDetailComponent	setProduct(Type value)
CarePlan.CarePlanActivityDetailComponent	setProhibited(boolean value)
CarePlan.CarePlanActivityDetailComponent	setProhibitedElement(BooleanType value)
void	setProperty(String name, Base value)
CarePlan.CarePlanActivityDetailComponent	setQuantity(SimpleQuantity value)
CarePlan.CarePlanActivityDetailComponent	setScheduled(Type value)
CarePlan.CarePlanActivityDetailComponent	setStatus(CarePlan.CarePlanActivityStatus value)
CarePlan.CarePlanActivityDetailComponent	setStatusElement(Enumeration<CarePlan.CarePlanActivityStatus> value)
CarePlan.CarePlanActivityDetailComponent	setStatusReason(CodeableConcept value)

Methods inherited from class org.hl7.fhir.dstu2.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

category

protected CodeableConcept category

High-level categorization of the type of activity in a care plan.

code

protected CodeableConcept code

Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

reasonCode

protected List<CodeableConcept> reasonCode

Provides the rationale that drove the inclusion of this particular activity as part of the plan.

reasonReference

protected List<Reference> reasonReference

Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

reasonReferenceTarget

protected List<Condition> reasonReferenceTarget

The actual objects that are the target of the reference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)

goal

protected List<Reference> goal

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

goalTarget

protected List<Goal> goalTarget

The actual objects that are the target of the reference (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

status

protected Enumeration<CarePlan.CarePlanActivityStatus> status

Identifies what progress is being made for the specific activity.

statusReason

protected CodeableConcept statusReason

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

prohibited

protected BooleanType prohibited

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

scheduled

protected Type scheduled

The period, timing or frequency upon which the described activity is to occur.

location

protected Reference location

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

locationTarget

protected Location locationTarget

The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

performer

protected List<Reference> performer

Identifies who's expected to be involved in the activity.

performerTarget

protected List<Resource> performerTarget

The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.)

product

protected Type product

Identifies the food, drug or other product to be consumed or supplied in the activity.

dailyAmount

protected SimpleQuantity dailyAmount

Identifies the quantity expected to be consumed in a given day.

quantity

protected SimpleQuantity quantity

Identifies the quantity expected to be supplied, administered or consumed by the subject.

description

protected StringType description

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

Constructor Details

CarePlanActivityDetailComponent

public CarePlanActivityDetailComponent()

CarePlanActivityDetailComponent

public CarePlanActivityDetailComponent(BooleanType prohibited)

Method Details

getCategory

public CodeableConcept getCategory()

Returns:

category (High-level categorization of the type of activity in a care plan.)

hasCategory

public boolean hasCategory()

setCategory

public CarePlan.CarePlanActivityDetailComponent setCategory(CodeableConcept value)

Parameters:

value - category (High-level categorization of the type of activity in a care plan.)

getCode

public CodeableConcept getCode()

Returns:

code (Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)

hasCode

public boolean hasCode()

setCode

public CarePlan.CarePlanActivityDetailComponent setCode(CodeableConcept value)

Parameters:

value - code (Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)

getReasonCode

public List<CodeableConcept> getReasonCode()

Returns:

reasonCode (Provides the rationale that drove the inclusion of this particular activity as part of the plan.)

hasReasonCode

public boolean hasReasonCode()

addReasonCode

public CodeableConcept addReasonCode()

Returns:

reasonCode (Provides the rationale that drove the inclusion of this particular activity as part of the plan.)

addReasonCode

public CarePlan.CarePlanActivityDetailComponent addReasonCode(CodeableConcept t)

getReasonReference

public List<Reference> getReasonReference()

Returns:

reasonReference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)

hasReasonReference

public boolean hasReasonReference()

addReasonReference

public Reference addReasonReference()

Returns:

reasonReference (Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)

addReasonReference

public CarePlan.CarePlanActivityDetailComponent addReasonReference(Reference t)

getReasonReferenceTarget

public List<Condition> getReasonReferenceTarget()

Returns:

reasonReference (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. Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)

addReasonReferenceTarget

public Condition addReasonReferenceTarget()

Returns:

reasonReference (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. Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)

getGoal

public List<Reference> getGoal()

Returns:

goal (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

hasGoal

public boolean hasGoal()

addGoal

public Reference addGoal()

Returns:

goal (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

addGoal

public CarePlan.CarePlanActivityDetailComponent 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. Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

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. Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

getStatusElement

public Enumeration<CarePlan.CarePlanActivityStatus> getStatusElement()

Returns:

status (Identifies what progress is being made for the specific activity.). 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.CarePlanActivityDetailComponent setStatusElement(Enumeration<CarePlan.CarePlanActivityStatus> value)

Parameters:

value - status (Identifies what progress is being made for the specific activity.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public CarePlan.CarePlanActivityStatus getStatus()

Returns:

Identifies what progress is being made for the specific activity.

setStatus

public CarePlan.CarePlanActivityDetailComponent setStatus(CarePlan.CarePlanActivityStatus value)

Parameters:

value - Identifies what progress is being made for the specific activity.

getStatusReason

public CodeableConcept getStatusReason()

Returns:

statusReason (Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)

hasStatusReason

public boolean hasStatusReason()

setStatusReason

public CarePlan.CarePlanActivityDetailComponent setStatusReason(CodeableConcept value)

Parameters:

value - statusReason (Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)

getProhibitedElement

public BooleanType getProhibitedElement()

Returns:

prohibited (If true, indicates that the described activity is one that must NOT be engaged in when following the plan.). This is the underlying object with id, value and extensions. The accessor "getProhibited" gives direct access to the value

hasProhibitedElement

public boolean hasProhibitedElement()

hasProhibited

public boolean hasProhibited()

setProhibitedElement

public CarePlan.CarePlanActivityDetailComponent setProhibitedElement(BooleanType value)

Parameters:

value - prohibited (If true, indicates that the described activity is one that must NOT be engaged in when following the plan.). This is the underlying object with id, value and extensions. The accessor "getProhibited" gives direct access to the value

getProhibited

public boolean getProhibited()

Returns:

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

setProhibited

public CarePlan.CarePlanActivityDetailComponent setProhibited(boolean value)

Parameters:

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

getScheduled

public Type getScheduled()

Returns:

scheduled (The period, timing or frequency upon which the described activity is to occur.)

getScheduledTiming

public Timing getScheduledTiming()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

scheduled (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasScheduledTiming

public boolean hasScheduledTiming()

getScheduledPeriod

public Period getScheduledPeriod()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

scheduled (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasScheduledPeriod

public boolean hasScheduledPeriod()

getScheduledStringType

public StringType getScheduledStringType()
                                  throws org.hl7.fhir.exceptions.FHIRException

Returns:

scheduled (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasScheduledStringType

public boolean hasScheduledStringType()

hasScheduled

public boolean hasScheduled()

setScheduled

public CarePlan.CarePlanActivityDetailComponent setScheduled(Type value)

Parameters:

value - scheduled (The period, timing or frequency upon which the described activity is to occur.)

getLocation

public Reference getLocation()

Returns:

location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

hasLocation

public boolean hasLocation()

setLocation

public CarePlan.CarePlanActivityDetailComponent setLocation(Reference value)

Parameters:

value - location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

getLocationTarget

public Location getLocationTarget()

Returns:

location 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 facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

setLocationTarget

public CarePlan.CarePlanActivityDetailComponent setLocationTarget(Location value)

Parameters:

value - location 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 facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

getPerformer

public List<Reference> getPerformer()

Returns:

performer (Identifies who's expected to be involved in the activity.)

hasPerformer

public boolean hasPerformer()

addPerformer

public Reference addPerformer()

Returns:

performer (Identifies who's expected to be involved in the activity.)

addPerformer

public CarePlan.CarePlanActivityDetailComponent addPerformer(Reference t)

getPerformerTarget

public List<Resource> getPerformerTarget()

Returns:

performer (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 who's expected to be involved in the activity.)

getProduct

public Type getProduct()

Returns:

product (Identifies the food, drug or other product to be consumed or supplied in the activity.)

getProductCodeableConcept

public CodeableConcept getProductCodeableConcept()
                                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

product (Identifies the food, drug or other product to be consumed or supplied in the activity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasProductCodeableConcept

public boolean hasProductCodeableConcept()

getProductReference

public Reference getProductReference()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

product (Identifies the food, drug or other product to be consumed or supplied in the activity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasProductReference

public boolean hasProductReference()

hasProduct

public boolean hasProduct()

setProduct

public CarePlan.CarePlanActivityDetailComponent setProduct(Type value)

Parameters:

value - product (Identifies the food, drug or other product to be consumed or supplied in the activity.)

getDailyAmount

public SimpleQuantity getDailyAmount()

Returns:

dailyAmount (Identifies the quantity expected to be consumed in a given day.)

hasDailyAmount

public boolean hasDailyAmount()

setDailyAmount

public CarePlan.CarePlanActivityDetailComponent setDailyAmount(SimpleQuantity value)

Parameters:

value - dailyAmount (Identifies the quantity expected to be consumed in a given day.)

getQuantity

public SimpleQuantity getQuantity()

Returns:

quantity (Identifies the quantity expected to be supplied, administered or consumed by the subject.)

hasQuantity

public boolean hasQuantity()

setQuantity

public CarePlan.CarePlanActivityDetailComponent setQuantity(SimpleQuantity value)

Parameters:

value - quantity (Identifies the quantity expected to be supplied, administered or consumed by the subject.)

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.). 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.CarePlanActivityDetailComponent setDescriptionElement(StringType value)

Parameters:

value - description (This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

setDescription

public CarePlan.CarePlanActivityDetailComponent setDescription(String value)

Parameters:

value - This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public CarePlan.CarePlanActivityDetailComponent copy()

Specified by:

copy in class BackboneElement

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement