Package org.hl7.fhir.dstu3.model
Class CarePlan.CarePlanActivityDetailComponent
java.lang.Object
org.hl7.fhir.dstu3.model.Base
org.hl7.fhir.dstu3.model.Element
org.hl7.fhir.dstu3.model.BackboneElement
org.hl7.fhir.dstu3.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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeableConcept
High-level categorization of the type of activity in a care plan.protected CodeableConcept
Detailed description of the type of planned activity; e.g.protected SimpleQuantity
Identifies the quantity expected to be consumed in a given day.protected Reference
Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.protected Resource
The actual object that is the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.)protected StringType
This provides a textual description of constraints on the intended activity occurrence, including relation to other activities.Internal reference that identifies the goals that this activity is intended to contribute towards meeting.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
Identifies the facility where the activity will occur; e.g.protected Location
The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g.Identifies who's expected to be involved in the activity.The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.)protected Type
Identifies the food, drug or other product to be consumed or supplied in the activity.protected BooleanType
If true, indicates that the described activity is one that must NOT be engaged in when following the plan.protected SimpleQuantity
Identifies the quantity expected to be supplied, administered or consumed by the subject.protected List
<CodeableConcept> Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.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
The period, timing or frequency upon which the described activity is to occur.protected Enumeration
<CarePlan.CarePlanActivityStatus> Identifies what progress is being made for the specific activity.protected StringType
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddGoal()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getGoal()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadboolean
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
hasGoal()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCategory
(CodeableConcept value) setCode
(CodeableConcept value) setDailyAmount
(SimpleQuantity value) setDefinition
(Reference value) setDefinitionTarget
(Resource value) setDescription
(String value) setDescriptionElement
(StringType value) setLocation
(Reference value) setLocationTarget
(Location value) setPerformer
(List<Reference> thePerformer) setProduct
(Type value) setProhibited
(boolean value) setProhibitedElement
(BooleanType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(SimpleQuantity value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setScheduled
(Type value) setStatusReason
(String value) setStatusReasonElement
(StringType value) Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, 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.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
High-level categorization of the type of activity in a care plan. -
definition
Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with. -
definitionTarget
The actual object that is the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.) -
code
Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter. -
reasonCode
Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. -
reasonReference
Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan. -
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
Internal reference that identifies the goals that this activity is intended to contribute towards meeting. -
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
Identifies what progress is being made for the specific activity. -
statusReason
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. -
prohibited
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan. -
scheduled
The period, timing or frequency upon which the described activity is to occur. -
location
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. -
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
Identifies who's expected to be involved in the activity. -
performerTarget
The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.) -
product
Identifies the food, drug or other product to be consumed or supplied in the activity. -
dailyAmount
Identifies the quantity expected to be consumed in a given day. -
quantity
Identifies the quantity expected to be supplied, administered or consumed by the subject. -
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()Constructor -
CarePlanActivityDetailComponent
Constructor
-
-
Method Details
-
getCategory
- Returns:
category
(High-level categorization of the type of activity in a care plan.)
-
hasCategory
-
setCategory
- Parameters:
value
-category
(High-level categorization of the type of activity in a care plan.)
-
getDefinition
- Returns:
definition
(Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.)
-
hasDefinition
-
setDefinition
- Parameters:
value
-definition
(Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.)
-
getDefinitionTarget
- Returns:
definition
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 protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.)
-
setDefinitionTarget
- Parameters:
value
-definition
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 protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.)
-
getCode
- Returns:
code
(Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)
-
hasCode
-
setCode
- Parameters:
value
-code
(Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.)
-
getReasonCode
- Returns:
reasonCode
(Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.)
-
setReasonReference
public CarePlan.CarePlanActivityDetailComponent setReasonReference(List<Reference> theReasonReference) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getGoal
- Returns:
goal
(Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
-
setGoal
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGoal
-
addGoal
-
addGoal
-
getGoalFirstRep
- Returns:
- The first repetition of repeating field
goal
, creating it if it does not already exist
-
getGoalTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addGoalTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
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
- Returns:
- Identifies what progress is being made for the specific activity.
-
setStatus
- Parameters:
value
- Identifies what progress is being made for the specific activity.
-
getStatusReasonElement
- Returns:
statusReason
(Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusReason" gives direct access to the value
-
hasStatusReasonElement
-
hasStatusReason
-
setStatusReasonElement
- Parameters:
value
-statusReason
(Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusReason" gives direct access to the value
-
getStatusReason
- Returns:
- Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
-
setStatusReason
- Parameters:
value
- Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
-
getProhibitedElement
- Returns:
prohibited
(If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should 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
-
hasProhibited
-
setProhibitedElement
- Parameters:
value
-prohibited
(If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should 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
- Returns:
- If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.
-
setProhibited
- Parameters:
value
- If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.
-
getScheduled
- Returns:
scheduled
(The period, timing or frequency upon which the described activity is to occur.)
-
getScheduledTiming
- Returns:
scheduled
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasScheduledTiming
-
getScheduledPeriod
- Returns:
scheduled
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasScheduledPeriod
-
getScheduledStringType
- Returns:
scheduled
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasScheduledStringType
-
hasScheduled
-
setScheduled
public CarePlan.CarePlanActivityDetailComponent setScheduled(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError - Parameters:
value
-scheduled
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getLocation
- Returns:
location
(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
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
- 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
- Returns:
performer
(Identifies who's expected to be involved in the activity.)
-
setPerformer
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getPerformerTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getProduct
- Returns:
product
(Identifies the food, drug or other product to be consumed or supplied in the activity.)
-
getProductCodeableConcept
- Returns:
product
(Identifies the food, drug or other product to be consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductCodeableConcept
-
getProductReference
- Returns:
product
(Identifies the food, drug or other product to be consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductReference
-
hasProduct
-
setProduct
public CarePlan.CarePlanActivityDetailComponent setProduct(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError - Parameters:
value
-product
(Identifies the food, drug or other product to be consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getDailyAmount
- Returns:
dailyAmount
(Identifies the quantity expected to be consumed in a given day.)
-
hasDailyAmount
-
setDailyAmount
- Parameters:
value
-dailyAmount
(Identifies the quantity expected to be consumed in a given day.)
-
getQuantity
- Returns:
quantity
(Identifies the quantity expected to be supplied, administered or consumed by the subject.)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(Identifies the quantity expected to be supplied, administered or consumed by the subject.)
-
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
-
hasDescription
-
setDescriptionElement
- 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
- 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
- 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
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-