Class CarePlan
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.CarePlan
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class CarePlan extends DomainResource
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CarePlan.Activity
Identifies a planned action to occur as part of the plan.static class
CarePlan.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
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.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<CarePlan.Activity>
getActivity()
Identifies a planned action to occur as part of the plan.java.util.List<Reference>
getAddresses()
Identifies the conditions/problems/concerns/diagnoses/etc.Reference
getAuthor()
When populated, the author is responsible for the care plan.java.util.List<Reference>
getBasedOn()
A care plan that is fulfilled in whole or in part by this care plan.java.util.List<Reference>
getCareTeam()
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.java.util.List<CodeableConcept>
getCategory()
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.java.util.List<Reference>
getContributor()
Identifies the individual(s) or organization who provided the contents of the care plan.DateTime
getCreated()
Represents when this particular CarePlan record was created in the system, which is often a system-generated date.String
getDescription()
A description of the scope and nature of the plan.Reference
getEncounter()
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.java.util.List<Reference>
getGoal()
Describes the intended objective(s) of carrying out the care plan.java.util.List<Identifier>
getIdentifier()
Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.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.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.CarePlanIntent
getIntent()
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.java.util.List<Annotation>
getNote()
General notes about the care plan not covered elsewhere.java.util.List<Reference>
getPartOf()
A larger care plan of which this particular care plan is a component or step.Period
getPeriod()
Indicates when the plan did (or is intended to) come into effect and end.java.util.List<Reference>
getReplaces()
Completed or terminated care plan whose function is taken by this new care plan.CarePlanStatus
getStatus()
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.Reference
getSubject()
Identifies the patient or group whose intended care is described by the plan.java.util.List<Reference>
getSupportingInfo()
Identifies portions of the patient's record that specifically influenced the formation of the plan.String
getTitle()
Human-friendly name for the care plan.boolean
hasChildren()
int
hashCode()
CarePlan.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
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.- 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.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getBasedOn
public java.util.List<Reference> getBasedOn()
A care plan that is fulfilled in whole or in part by this care plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getReplaces
public java.util.List<Reference> getReplaces()
Completed or terminated care plan whose function is taken by this new care plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getPartOf
public java.util.List<Reference> getPartOf()
A larger care plan of which this particular care plan is a component or step.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getStatus
public CarePlanStatus getStatus()
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.- Returns:
- An immutable object of type
CarePlanStatus
that is non-null.
-
getIntent
public CarePlanIntent getIntent()
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.- Returns:
- An immutable object of type
CarePlanIntent
that is non-null.
-
getCategory
public java.util.List<CodeableConcept> getCategory()
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getTitle
public String getTitle()
Human-friendly name for the care plan.- Returns:
- An immutable object of type
String
that may be null.
-
getDescription
public String getDescription()
A description of the scope and nature of the plan.- Returns:
- An immutable object of type
String
that may be null.
-
getSubject
public Reference getSubject()
Identifies the patient or group whose intended care is described by the plan.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getEncounter
public Reference getEncounter()
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPeriod
public Period getPeriod()
Indicates when the plan did (or is intended to) come into effect and end.- Returns:
- An immutable object of type
Period
that may be null.
-
getCreated
public DateTime getCreated()
Represents when this particular CarePlan record was created in the system, which is often a system-generated date.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getAuthor
public Reference getAuthor()
When populated, the author is responsible for the care plan. The care plan is attributed to the author.- Returns:
- An immutable object of type
Reference
that may be null.
-
getContributor
public java.util.List<Reference> getContributor()
Identifies the individual(s) or organization who provided the contents of the care plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getCareTeam
public java.util.List<Reference> getCareTeam()
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAddresses
public java.util.List<Reference> getAddresses()
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getSupportingInfo
public java.util.List<Reference> getSupportingInfo()
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getGoal
public java.util.List<Reference> getGoal()
Describes the intended objective(s) of carrying out the care plan.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getActivity
public java.util.List<CarePlan.Activity> getActivity()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CarePlan.Activity
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
General notes about the care plan not covered elsewhere.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
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.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static CarePlan.Builder builder()
-
-