Package org.hl7.fhir.dstu2.model
Class CarePlan
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.CarePlan
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCarePlan.CarePlanActivityComponentstatic classCarePlan.CarePlanActivityDetailComponentstatic classCarePlan.CarePlanActivityStatusstatic classCarePlan.CarePlanActivityStatusEnumFactorystatic classCarePlan.CarePlanParticipantComponentstatic classCarePlan.CarePlanRelatedPlanComponentstatic classCarePlan.CarePlanRelationshipstatic classCarePlan.CarePlanRelationshipEnumFactorystatic classCarePlan.CarePlanStatusstatic classCarePlan.CarePlanStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<CarePlan.CarePlanActivityComponent>activityIdentifies a planned action to occur as part of the plan.protected List<Reference>addressesIdentifies the conditions/problems/concerns/diagnoses/etc.protected List<Condition>addressesTargetThe actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc.protected List<Reference>authorIdentifies the individual(s) or ogranization who is responsible for the content of the care plan.protected List<Resource>authorTargetThe actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)protected List<CodeableConcept>categoryIdentifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.protected ReferencecontextIdentifies the context in which this particular CarePlan is defined.protected ResourcecontextTargetThe actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.)protected StringTypedescriptionA description of the scope and nature of the plan.protected List<Reference>goalDescribes the intended objective(s) of carrying out the care plan.protected List<Goal>goalTargetThe actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)protected List<Identifier>identifierThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g.protected DateTimeTypemodifiedIdentifies the most recent date on which the plan has been revised.protected AnnotationnoteGeneral notes about the care plan not covered elsewhere.protected List<CarePlan.CarePlanParticipantComponent>participantIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.protected PeriodperiodIndicates when the plan did (or is intended to) come into effect and end.protected List<CarePlan.CarePlanRelatedPlanComponent>relatedPlanIdentifies CarePlans with some sort of formal relationship to the current plan.static StringSP_ACTIVITYCODEstatic StringSP_ACTIVITYDATEstatic StringSP_ACTIVITYREFERENCEstatic StringSP_CONDITIONstatic StringSP_DATEstatic StringSP_GOALstatic StringSP_PARTICIPANTstatic StringSP_PATIENTstatic StringSP_PERFORMERstatic StringSP_RELATEDstatic StringSP_RELATEDCODEstatic StringSP_RELATEDPLANstatic StringSP_SUBJECTprotected Enumeration<CarePlan.CarePlanStatus>statusIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.protected ReferencesubjectIdentifies the patient or group whose intended care is described by the plan.protected ResourcesubjectTargetThe actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)protected List<Reference>supportIdentifies portions of the patient's record that specifically influenced the formation of the plan.protected List<Resource>supportTargetThe actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CarePlan()CarePlan(Enumeration<CarePlan.CarePlanStatus> status)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
subject
protected Reference subject
Identifies the patient or group whose intended care is described by the plan.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)
-
status
protected Enumeration<CarePlan.CarePlanStatus> status
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
context
protected Reference context
Identifies the context in which this particular CarePlan is defined.
-
contextTarget
protected Resource contextTarget
The actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.)
-
period
protected Period period
Indicates when the plan did (or is intended to) come into effect and end.
-
author
protected List<Reference> author
Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
-
authorTarget
protected List<Resource> authorTarget
The actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
-
modified
protected DateTimeType modified
Identifies the most recent date on which the plan has been revised.
-
category
protected List<CodeableConcept> category
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.
-
description
protected StringType description
A description of the scope and nature of the plan.
-
addresses
protected List<Reference> addresses
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
-
addressesTarget
protected List<Condition> addressesTarget
The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
support
protected List<Reference> support
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
-
supportTarget
protected List<Resource> supportTarget
The actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
-
relatedPlan
protected List<CarePlan.CarePlanRelatedPlanComponent> relatedPlan
Identifies CarePlans with some sort of formal relationship to the current plan.
-
participant
protected List<CarePlan.CarePlanParticipantComponent> participant
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
-
goal
protected List<Reference> goal
Describes the intended objective(s) of carrying out the care plan.
-
goalTarget
protected List<Goal> goalTarget
The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)
-
activity
protected List<CarePlan.CarePlanActivityComponent> activity
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.
-
note
protected Annotation note
General notes about the care plan not covered elsewhere.
-
SP_DATE
public static final String SP_DATE
- See Also:
- Constant Field Values
-
SP_ACTIVITYCODE
public static final String SP_ACTIVITYCODE
- See Also:
- Constant Field Values
-
SP_ACTIVITYDATE
public static final String SP_ACTIVITYDATE
- See Also:
- Constant Field Values
-
SP_ACTIVITYREFERENCE
public static final String SP_ACTIVITYREFERENCE
- See Also:
- Constant Field Values
-
SP_PERFORMER
public static final String SP_PERFORMER
- See Also:
- Constant Field Values
-
SP_GOAL
public static final String SP_GOAL
- See Also:
- Constant Field Values
-
SP_SUBJECT
public static final String SP_SUBJECT
- See Also:
- Constant Field Values
-
SP_RELATEDCODE
public static final String SP_RELATEDCODE
- See Also:
- Constant Field Values
-
SP_PARTICIPANT
public static final String SP_PARTICIPANT
- See Also:
- Constant Field Values
-
SP_RELATEDPLAN
public static final String SP_RELATEDPLAN
- See Also:
- Constant Field Values
-
SP_CONDITION
public static final String SP_CONDITION
- See Also:
- Constant Field Values
-
SP_RELATED
public static final String SP_RELATED
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CarePlan
public CarePlan()
-
CarePlan
public CarePlan(Enumeration<CarePlan.CarePlanStatus> status)
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)
-
addIdentifier
public CarePlan addIdentifier(Identifier t)
-
getSubject
public Reference getSubject()
- Returns:
subject(Identifies the patient or group whose intended care is described by the plan.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public CarePlan setSubject(Reference value)
- Parameters:
value-subject(Identifies the patient or group whose intended care is described by the plan.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe 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 patient or group whose intended care is described by the plan.)
-
setSubjectTarget
public CarePlan setSubjectTarget(Resource value)
- Parameters:
value-subjectThe 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 patient or group whose intended care is described by the plan.)
-
getStatusElement
public Enumeration<CarePlan.CarePlanStatus> getStatusElement()
- Returns:
status(Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). 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 setStatusElement(Enumeration<CarePlan.CarePlanStatus> value)
- Parameters:
value-status(Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public CarePlan.CarePlanStatus getStatus()
- Returns:
- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
setStatus
public CarePlan setStatus(CarePlan.CarePlanStatus value)
- Parameters:
value- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
getContext
public Reference getContext()
- Returns:
context(Identifies the context in which this particular CarePlan is defined.)
-
hasContext
public boolean hasContext()
-
setContext
public CarePlan setContext(Reference value)
- Parameters:
value-context(Identifies the context in which this particular CarePlan is defined.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
contextThe 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 context in which this particular CarePlan is defined.)
-
setContextTarget
public CarePlan setContextTarget(Resource value)
- Parameters:
value-contextThe 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 context in which this particular CarePlan is defined.)
-
getPeriod
public Period getPeriod()
- Returns:
period(Indicates when the plan did (or is intended to) come into effect and end.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public CarePlan setPeriod(Period value)
- Parameters:
value-period(Indicates when the plan did (or is intended to) come into effect and end.)
-
getAuthor
public List<Reference> getAuthor()
- Returns:
author(Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
-
hasAuthor
public boolean hasAuthor()
-
addAuthor
public Reference addAuthor()
- Returns:
author(Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
-
getAuthorTarget
public List<Resource> getAuthorTarget()
- Returns:
author(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 the individual(s) or ogranization who is responsible for the content of the care plan.)
-
getModifiedElement
public DateTimeType getModifiedElement()
- Returns:
modified(Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
-
hasModifiedElement
public boolean hasModifiedElement()
-
hasModified
public boolean hasModified()
-
setModifiedElement
public CarePlan setModifiedElement(DateTimeType value)
- Parameters:
value-modified(Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
-
getModified
public Date getModified()
- Returns:
- Identifies the most recent date on which the plan has been revised.
-
setModified
public CarePlan setModified(Date value)
- Parameters:
value- Identifies the most recent date on which the plan has been revised.
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(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.)
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
- Returns:
category(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.)
-
addCategory
public CarePlan addCategory(CodeableConcept t)
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(A description of the scope and nature of the plan.). 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 setDescriptionElement(StringType value)
- Parameters:
value-description(A description of the scope and nature of the plan.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A description of the scope and nature of the plan.
-
setDescription
public CarePlan setDescription(String value)
- Parameters:
value- A description of the scope and nature of the plan.
-
getAddresses
public List<Reference> getAddresses()
- Returns:
addresses(Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
hasAddresses
public boolean hasAddresses()
-
addAddresses
public Reference addAddresses()
- Returns:
addresses(Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
addAddresses
public CarePlan addAddresses(Reference t)
-
getAddressesTarget
public List<Condition> getAddressesTarget()
- Returns:
addresses(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 the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
addAddressesTarget
public Condition addAddressesTarget()
- Returns:
addresses(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. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
getSupport
public List<Reference> getSupport()
- Returns:
support(Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
-
hasSupport
public boolean hasSupport()
-
addSupport
public Reference addSupport()
- Returns:
support(Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
-
addSupport
public CarePlan addSupport(Reference t)
-
getSupportTarget
public List<Resource> getSupportTarget()
- Returns:
support(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 portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
-
getRelatedPlan
public List<CarePlan.CarePlanRelatedPlanComponent> getRelatedPlan()
- Returns:
relatedPlan(Identifies CarePlans with some sort of formal relationship to the current plan.)
-
hasRelatedPlan
public boolean hasRelatedPlan()
-
addRelatedPlan
public CarePlan.CarePlanRelatedPlanComponent addRelatedPlan()
- Returns:
relatedPlan(Identifies CarePlans with some sort of formal relationship to the current plan.)
-
addRelatedPlan
public CarePlan addRelatedPlan(CarePlan.CarePlanRelatedPlanComponent t)
-
getParticipant
public List<CarePlan.CarePlanParticipantComponent> getParticipant()
- Returns:
participant(Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public CarePlan.CarePlanParticipantComponent addParticipant()
- Returns:
participant(Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
-
addParticipant
public CarePlan addParticipant(CarePlan.CarePlanParticipantComponent t)
-
getGoal
public List<Reference> getGoal()
- Returns:
goal(Describes the intended objective(s) of carrying out the care plan.)
-
hasGoal
public boolean hasGoal()
-
addGoal
public Reference addGoal()
- Returns:
goal(Describes the intended objective(s) of carrying out the care plan.)
-
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. Describes the intended objective(s) of carrying out the care plan.)
-
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. Describes the intended objective(s) of carrying out the care plan.)
-
getActivity
public List<CarePlan.CarePlanActivityComponent> getActivity()
- Returns:
activity(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.)
-
hasActivity
public boolean hasActivity()
-
addActivity
public CarePlan.CarePlanActivityComponent addActivity()
- Returns:
activity(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.)
-
addActivity
public CarePlan addActivity(CarePlan.CarePlanActivityComponent t)
-
getNote
public Annotation getNote()
- Returns:
note(General notes about the care plan not covered elsewhere.)
-
hasNote
public boolean hasNote()
-
setNote
public CarePlan setNote(Annotation value)
- Parameters:
value-note(General notes about the care plan not covered elsewhere.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public CarePlan copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-