Class CarePlan.Activity.Detail
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.CarePlan.Activity.Detail
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- CarePlan.Activity
public static class CarePlan.Activity.Detail extends BackboneElement
A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CarePlan.Activity.Detail.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static CarePlan.Activity.Detail.Builder
builder()
boolean
equals(java.lang.Object obj)
CodeableConcept
getCode()
Detailed description of the type of planned activity; e.g.SimpleQuantity
getDailyAmount()
Identifies the quantity expected to be consumed in a given day.String
getDescription()
This provides a textual description of constraints on the intended activity occurrence, including relation to other activities.Boolean
getDoNotPerform()
If true, indicates that the described activity is one that must NOT be engaged in when following the plan.java.util.List<Reference>
getGoal()
Internal reference that identifies the goals that this activity is intended to contribute towards meeting.java.util.List<Canonical>
getInstantiatesCanonical()
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.java.util.List<Uri>
getInstantiatesUri()
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.CarePlanActivityKind
getKind()
A description of the kind of resource the in-line definition of a care plan activity is representing.Reference
getLocation()
Identifies the facility where the activity will occur; e.g.java.util.List<Reference>
getPerformer()
Identifies who's expected to be involved in the activity.Element
getProduct()
Identifies the food, drug or other product to be consumed or supplied in the activity.SimpleQuantity
getQuantity()
Identifies the quantity expected to be supplied, administered or consumed by the subject.java.util.List<CodeableConcept>
getReasonCode()
Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.java.util.List<Reference>
getReasonReference()
Indicates 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.Element
getScheduled()
The period, timing or frequency upon which the described activity is to occur.CarePlanActivityStatus
getStatus()
Identifies what progress is being made for the specific activity.CodeableConcept
getStatusReason()
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.boolean
hasChildren()
int
hashCode()
CarePlan.Activity.Detail.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getKind
public CarePlanActivityKind getKind()
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.- Returns:
- An immutable object of type
CarePlanActivityKind
that may be null.
-
getInstantiatesCanonical
public java.util.List<Canonical> getInstantiatesCanonical()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getInstantiatesUri
public java.util.List<Uri> getInstantiatesUri()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getCode
public CodeableConcept getCode()
Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Indicates 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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getGoal
public java.util.List<Reference> getGoal()
Internal reference that identifies the goals that this activity is intended to contribute towards meeting.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getStatus
public CarePlanActivityStatus getStatus()
Identifies what progress is being made for the specific activity.- Returns:
- An immutable object of type
CarePlanActivityStatus
that is non-null.
-
getStatusReason
public CodeableConcept getStatusReason()
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDoNotPerform
public Boolean getDoNotPerform()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getScheduled
public Element getScheduled()
The period, timing or frequency upon which the described activity is to occur.
-
getLocation
public Reference getLocation()
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPerformer
public java.util.List<Reference> getPerformer()
Identifies who's expected to be involved in the activity.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getProduct
public Element getProduct()
Identifies the food, drug or other product to be consumed or supplied in the activity.- Returns:
- An immutable object of type
CodeableConcept
orReference
that may be null.
-
getDailyAmount
public SimpleQuantity getDailyAmount()
Identifies the quantity expected to be consumed in a given day.- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getQuantity
public SimpleQuantity getQuantity()
Identifies the quantity expected to be supplied, administered or consumed by the subject.- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getDescription
public String getDescription()
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.- Returns:
- An immutable object of type
String
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public CarePlan.Activity.Detail.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static CarePlan.Activity.Detail.Builder builder()
-
-