Package org.hl7.fhir.r5.model
Class CarePlan.CarePlanActivityPlannedActivityDetailComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.CarePlan.CarePlanActivityPlannedActivityDetailComponent
- 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.CarePlanActivityPlannedActivityDetailComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CodeableConceptDetailed description of the type of planned activity; e.g.protected QuantityIdentifies the quantity expected to be consumed in a given day.protected StringTypeThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities.protected BooleanTypeIf true, indicates that the described activity is one that must NOT be engaged in when following the plan.Internal reference that identifies the goals that this activity is intended to contribute towards meeting.protected List<CanonicalType>The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.protected Enumeration<CarePlan.CarePlanActivityKind>A description of the kind of resource the in-line definition of a care plan activity is representing.protected CodeableReferenceIdentifies the facility where the activity will occur; e.g.Identifies who's expected to be involved in the activity.protected DataTypeIdentifies the food, drug or other product to be consumed or supplied in the activity.protected QuantityIdentifies the quantity expected to be supplied, administered or consumed by the subject.protected List<CodeableReference>Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.protected DataTypeIndicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.protected DataTypeThe 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 CodeableConceptProvides reason why the activity isn't yet started, is on hold, was cancelled, etc.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension -
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddGoal()addInstantiatesCanonical(String value) addInstantiatesUri(String value) copy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getCode()booleangetGoal()getKind()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanhasCode()booleanbooleanbooleanbooleanbooleanbooleanhasGoal()booleanbooleanhasInstantiatesCanonical(String value) booleanbooleanhasInstantiatesUri(String value) booleanhasKind()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) setCode(CodeableConcept value) setDailyAmount(Quantity value) setDescription(String value) setDescriptionElement(StringType value) setDoNotPerform(boolean value) setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri(List<UriType> theInstantiatesUri) setLocation(CodeableReference value) setPerformer(List<Reference> thePerformer) setProduct(DataType value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setQuantity(Quantity value) setReason(List<CodeableReference> theReason) setReported(DataType value) setScheduled(DataType value) setStatusReason(CodeableConcept value) Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, removeExtension, setModifierExtensionMethods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElementMethods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtensionMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
kind
A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. -
instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. -
code
Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. -
reason
Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or another resource, such as the health condition(s), whose existence justifies this request and 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. -
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. -
doNotPerform
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, 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. -
reported
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report. -
performer
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
-
CarePlanActivityPlannedActivityDetailComponent
Constructor -
CarePlanActivityPlannedActivityDetailComponent
Constructor
-
-
Method Details
-
getKindElement
- Returns:
kind(A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
hasKindElement
-
hasKind
-
setKindElement
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setKindElement(Enumeration<CarePlan.CarePlanActivityKind> value) - Parameters:
value-kind(A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
getKind
- Returns:
- A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
-
setKind
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setKind(CarePlan.CarePlanActivityKind value) - Parameters:
value- A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
setInstantiatesCanonical
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
addInstantiatesCanonical
public CarePlan.CarePlanActivityPlannedActivityDetailComponent addInstantiatesCanonical(String value) - Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
hasInstantiatesCanonical
- Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
getInstantiatesUri
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
setInstantiatesUri
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setInstantiatesUri(List<UriType> theInstantiatesUri) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
addInstantiatesUri
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
hasInstantiatesUri
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.)
-
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.)
-
getReason
- Returns:
reason(Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.)
-
setReason
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setReason(List<CodeableReference> theReason) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason, creating it if it does not already exist {3}
-
getGoal
- Returns:
goal(Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
-
setGoal
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGoal
-
addGoal
-
addGoal
-
getGoalFirstRep
- Returns:
- The first repetition of repeating field
goal, creating it if it does not already exist {3}
-
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.CarePlanActivityPlannedActivityDetailComponent 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
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setStatus(CarePlan.CarePlanActivityStatus value) - Parameters:
value- Identifies what progress is being made for the specific activity.
-
getStatusReason
- Returns:
statusReason(Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)
-
hasStatusReason
-
setStatusReason
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setStatusReason(CodeableConcept value) - Parameters:
value-statusReason(Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.)
-
getDoNotPerformElement
- Returns:
doNotPerform(If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, 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 "getDoNotPerform" gives direct access to the value
-
hasDoNotPerformElement
-
hasDoNotPerform
-
setDoNotPerformElement
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setDoNotPerformElement(BooleanType value) - Parameters:
value-doNotPerform(If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, 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 "getDoNotPerform" gives direct access to the value
-
getDoNotPerform
- Returns:
- If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
-
setDoNotPerform
- Parameters:
value- If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, 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
- Parameters:
value-scheduled(The period, timing or frequency upon which the described activity is to occur.)
-
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.)
-
getReported
- Returns:
reported(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)
-
getReportedBooleanType
- Returns:
reported(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReportedBooleanType
-
getReportedReference
- Returns:
reported(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReportedReference
-
hasReported
-
setReported
- Parameters:
value-reported(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)
-
getPerformer
- Returns:
performer(Identifies who's expected to be involved in the activity.)
-
setPerformer
public CarePlan.CarePlanActivityPlannedActivityDetailComponent setPerformer(List<Reference> thePerformer) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer, creating it if it does not already exist {3}
-
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
- Parameters:
value-product(Identifies the food, drug or other product to be consumed or supplied in the activity.)
-
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
public CarePlan.CarePlanActivityPlannedActivityDetailComponent 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
- 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:
listChildrenin classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copyin classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeepin classBackboneElement
-
equalsShallow
- Overrides:
equalsShallowin classBackboneElement
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneElement
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneElement
-