Class CarePlan
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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.CarePlanIntentstatic classCarePlan.CarePlanIntentEnumFactorystatic 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.static ca.uhn.fhir.rest.gclient.TokenClientParamACTIVITY_CODEFluent Client search parameter constant for activity-codestatic ca.uhn.fhir.rest.gclient.DateClientParamACTIVITY_DATEFluent Client search parameter constant for activity-datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamACTIVITY_REFERENCEFluent Client search parameter constant for activity-referenceprotected 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.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamBASED_ONFluent Client search parameter constant for based-onprotected List<Reference>basedOnA care plan that is fulfilled in whole or in part by this care plan.protected List<CarePlan>basedOnTargetThe actual objects that are the target of the reference (A care plan that is fulfilled in whole or in part by this care plan.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamCARE_TEAMFluent Client search parameter constant for care-teamprotected List<Reference>careTeamIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.protected List<CareTeam>careTeamTargetThe actual objects that are the target of the reference (Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)protected List<CodeableConcept>categoryIdentifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categorystatic ca.uhn.fhir.rest.gclient.ReferenceClientParamCONDITIONFluent Client search parameter constant for conditionprotected ReferencecontextIdentifies the original context in which this particular CarePlan was created.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTEXTFluent Client search parameter constant for contextprotected ResourcecontextTargetThe actual object that is the target of the reference (Identifies the original context in which this particular CarePlan was created.)static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Reference>definitionIdentifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDEFINITIONFluent Client search parameter constant for definitionprotected List<Resource>definitionTargetThe actual objects that are the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.)protected StringTypedescriptionA description of the scope and nature of the plan.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected List<Reference>goalDescribes the intended objective(s) of carrying out the care plan.static ca.uhn.fhir.rest.gclient.ReferenceClientParamGOALFluent Client search parameter constant for goalprotected 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.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ACTIVITY_REFERENCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_BASED_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CARE_TEAMConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CONDITIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CONTEXTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DEFINITIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_GOALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PART_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REPLACESConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected Enumeration<CarePlan.CarePlanIntent>intentIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.static ca.uhn.fhir.rest.gclient.TokenClientParamINTENTFluent Client search parameter constant for intentprotected List<Annotation>noteGeneral notes about the care plan not covered elsewhere.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPART_OFFluent Client search parameter constant for part-ofprotected List<Reference>partOfA larger care plan of which this particular care plan is a component or step.protected List<CarePlan>partOfTargetThe actual objects that are the target of the reference (A larger care plan of which this particular care plan is a component or step.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerprotected PeriodperiodIndicates when the plan did (or is intended to) come into effect and end.protected List<Reference>replacesCompleted or terminated care plan whose function is taken by this new care plan.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREPLACESFluent Client search parameter constant for replacesprotected List<CarePlan>replacesTargetThe actual objects that are the target of the reference (Completed or terminated care plan whose function is taken by this new care plan.)static StringSP_ACTIVITY_CODESearch parameter: activity-codestatic StringSP_ACTIVITY_DATESearch parameter: activity-datestatic StringSP_ACTIVITY_REFERENCESearch parameter: activity-referencestatic StringSP_BASED_ONSearch parameter: based-onstatic StringSP_CARE_TEAMSearch parameter: care-teamstatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CONDITIONSearch parameter: conditionstatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_DATESearch parameter: datestatic StringSP_DEFINITIONSearch parameter: definitionstatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_GOALSearch parameter: goalstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INTENTSearch parameter: intentstatic StringSP_PART_OFSearch parameter: part-ofstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REPLACESSearch parameter: replacesstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<CarePlan.CarePlanStatus>statusIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectIdentifies the patient or group whose intended care is described by the plan.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected 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>supportingInfoIdentifies portions of the patient's record that specifically influenced the formation of the plan.protected List<Resource>supportingInfoTargetThe actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan.protected StringTypetitleHuman-friendly name for the CarePlan.-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CarePlan()ConstructorCarePlan(Enumeration<CarePlan.CarePlanStatus> status, Enumeration<CarePlan.CarePlanIntent> intent, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
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, 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.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).
-
definition
protected List<Reference> definition
Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
-
definitionTarget
protected List<Resource> definitionTarget
The actual objects that are the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.)
-
basedOn
protected List<Reference> basedOn
A care plan that is fulfilled in whole or in part by this care plan.
-
basedOnTarget
protected List<CarePlan> basedOnTarget
The actual objects that are the target of the reference (A care plan that is fulfilled in whole or in part by this care plan.)
-
replaces
protected List<Reference> replaces
Completed or terminated care plan whose function is taken by this new care plan.
-
replacesTarget
protected List<CarePlan> replacesTarget
The actual objects that are the target of the reference (Completed or terminated care plan whose function is taken by this new care plan.)
-
partOf
protected List<Reference> partOf
A larger care plan of which this particular care plan is a component or step.
-
partOfTarget
protected List<CarePlan> partOfTarget
The actual objects that are the target of the reference (A larger care plan of which this particular care plan is a component or step.)
-
status
protected Enumeration<CarePlan.CarePlanStatus> status
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
intent
protected Enumeration<CarePlan.CarePlanIntent> intent
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
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.
-
title
protected StringType title
Human-friendly name for the CarePlan.
-
description
protected StringType description
A description of the scope and nature of the plan.
-
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.)
-
context
protected Reference context
Identifies the original context in which this particular CarePlan was created.
-
contextTarget
protected Resource contextTarget
The actual object that is the target of the reference (Identifies the original context in which this particular CarePlan was created.)
-
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.)
-
careTeam
protected List<Reference> careTeam
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
-
careTeamTarget
protected List<CareTeam> careTeamTarget
The actual objects that are the target of the reference (Identifies all people and organizations who are expected to be involved in the care envisioned by this 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.)
-
supportingInfo
protected List<Reference> supportingInfo
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.
-
supportingInfoTarget
protected List<Resource> supportingInfoTarget
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.)
-
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 List<Annotation> note
General notes about the care plan not covered elsewhere.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Time period plan covers
Type: date
Path: CarePlan.period
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Time period plan covers
Type: date
Path: CarePlan.period
-
SP_CARE_TEAM
public static final String SP_CARE_TEAM
Search parameter: care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
- See Also:
- Constant Field Values
-
CARE_TEAM
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CARE_TEAM
Fluent Client search parameter constant for care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
-
INCLUDE_CARE_TEAM
public static final ca.uhn.fhir.model.api.Include INCLUDE_CARE_TEAM
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:care-team".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External Ids for this plan
Type: token
Path: CarePlan.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External Ids for this plan
Type: token
Path: CarePlan.identifier
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
Type: reference
Path: CarePlan.activity.detail.performer
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
Fluent Client search parameter constant for performerDescription: Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
Type: reference
Path: CarePlan.activity.detail.performer
-
INCLUDE_PERFORMER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:performer".
-
SP_GOAL
public static final String SP_GOAL
Search parameter: goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
- See Also:
- Constant Field Values
-
GOAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GOAL
Fluent Client search parameter constant for goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
-
INCLUDE_GOAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_GOAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:goal".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: Who care plan is for
Type: reference
Path: CarePlan.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: Who care plan is for
Type: reference
Path: CarePlan.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:subject".
-
SP_REPLACES
public static final String SP_REPLACES
Search parameter: replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
- See Also:
- Constant Field Values
-
REPLACES
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPLACES
Fluent Client search parameter constant for replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
-
INCLUDE_REPLACES
public static final ca.uhn.fhir.model.api.Include INCLUDE_REPLACES
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:replaces".
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
- See Also:
- Constant Field Values
-
PART_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
-
INCLUDE_PART_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:part-of".
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: Created in context of
Type: reference
Path: CarePlan.context
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Created in context of
Type: reference
Path: CarePlan.context
-
INCLUDE_ENCOUNTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:encounter".
-
SP_INTENT
public static final String SP_INTENT
Search parameter: intentDescription: proposal | plan | order | option
Type: token
Path: CarePlan.intent
- See Also:
- Constant Field Values
-
INTENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
Fluent Client search parameter constant for intentDescription: proposal | plan | order | option
Type: token
Path: CarePlan.intent
-
SP_ACTIVITY_REFERENCE
public static final String SP_ACTIVITY_REFERENCE
Search parameter: activity-referenceDescription: Activity details defined in specific resource
Type: reference
Path: CarePlan.activity.reference
- See Also:
- Constant Field Values
-
ACTIVITY_REFERENCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTIVITY_REFERENCE
Fluent Client search parameter constant for activity-referenceDescription: Activity details defined in specific resource
Type: reference
Path: CarePlan.activity.reference
-
INCLUDE_ACTIVITY_REFERENCE
public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTIVITY_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activity-reference".
-
SP_CONDITION
public static final String SP_CONDITION
Search parameter: conditionDescription: Health issues this plan addresses
Type: reference
Path: CarePlan.addresses
- See Also:
- Constant Field Values
-
CONDITION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
Fluent Client search parameter constant for conditionDescription: Health issues this plan addresses
Type: reference
Path: CarePlan.addresses
-
INCLUDE_CONDITION
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONDITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:condition".
-
SP_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: Fulfills care plan
Type: reference
Path: CarePlan.basedOn
- See Also:
- Constant Field Values
-
BASED_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
Fluent Client search parameter constant for based-onDescription: Fulfills care plan
Type: reference
Path: CarePlan.basedOn
-
INCLUDE_BASED_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:based-on".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Who care plan is for
Type: reference
Path: CarePlan.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Who care plan is for
Type: reference
Path: CarePlan.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:patient".
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Created in context of
Type: reference
Path: CarePlan.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Created in context of
Type: reference
Path: CarePlan.context
-
INCLUDE_CONTEXT
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:context".
-
SP_ACTIVITY_DATE
public static final String SP_ACTIVITY_DATE
Search parameter: activity-dateDescription: Specified date occurs within period specified by CarePlan.activity.timingSchedule
Type: date
Path: CarePlan.activity.detail.scheduled[x]
- See Also:
- Constant Field Values
-
ACTIVITY_DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam ACTIVITY_DATE
Fluent Client search parameter constant for activity-dateDescription: Specified date occurs within period specified by CarePlan.activity.timingSchedule
Type: date
Path: CarePlan.activity.detail.scheduled[x]
-
SP_DEFINITION
public static final String SP_DEFINITION
Search parameter: definitionDescription: Protocol or definition
Type: reference
Path: CarePlan.definition
- See Also:
- Constant Field Values
-
DEFINITION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION
Fluent Client search parameter constant for definitionDescription: Protocol or definition
Type: reference
Path: CarePlan.definition
-
INCLUDE_DEFINITION
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:definition".
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Type of plan
Type: token
Path: CarePlan.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Type of plan
Type: token
Path: CarePlan.category
-
SP_ACTIVITY_CODE
public static final String SP_ACTIVITY_CODE
Search parameter: activity-codeDescription: Detail type of activity
Type: token
Path: CarePlan.activity.detail.code
- See Also:
- Constant Field Values
-
ACTIVITY_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVITY_CODE
Fluent Client search parameter constant for activity-codeDescription: Detail type of activity
Type: token
Path: CarePlan.activity.detail.code
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: draft | active | suspended | completed | entered-in-error | cancelled | unknown
Type: token
Path: CarePlan.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: draft | active | suspended | completed | entered-in-error | cancelled | unknown
Type: token
Path: CarePlan.status
-
-
Constructor Detail
-
CarePlan
public CarePlan()
Constructor
-
CarePlan
public CarePlan(Enumeration<CarePlan.CarePlanStatus> status, Enumeration<CarePlan.CarePlanIntent> intent, Reference subject)
Constructor
-
-
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).)
-
setIdentifier
public CarePlan setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public CarePlan addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getDefinition
public List<Reference> getDefinition()
- Returns:
definition(Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.)
-
setDefinition
public CarePlan setDefinition(List<Reference> theDefinition)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDefinition
public boolean hasDefinition()
-
addDefinition
public Reference addDefinition()
-
addDefinition
public CarePlan addDefinition(Reference t)
-
getDefinitionFirstRep
public Reference getDefinitionFirstRep()
- Returns:
- The first repetition of repeating field
definition, creating it if it does not already exist
-
getDefinitionTarget
@Deprecated public List<Resource> getDefinitionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(A care plan that is fulfilled in whole or in part by this care plan.)
-
setBasedOn
public CarePlan setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public CarePlan addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<CarePlan> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addBasedOnTarget
@Deprecated public CarePlan addBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReplaces
public List<Reference> getReplaces()
- Returns:
replaces(Completed or terminated care plan whose function is taken by this new care plan.)
-
setReplaces
public CarePlan setReplaces(List<Reference> theReplaces)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReplaces
public boolean hasReplaces()
-
addReplaces
public Reference addReplaces()
-
addReplaces
public CarePlan addReplaces(Reference t)
-
getReplacesFirstRep
public Reference getReplacesFirstRep()
- Returns:
- The first repetition of repeating field
replaces, creating it if it does not already exist
-
getReplacesTarget
@Deprecated public List<CarePlan> getReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addReplacesTarget
@Deprecated public CarePlan addReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(A larger care plan of which this particular care plan is a component or step.)
-
setPartOf
public CarePlan setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<CarePlan> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addPartOfTarget
@Deprecated public CarePlan addPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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.
-
getIntentElement
public Enumeration<CarePlan.CarePlanIntent> getIntentElement()
- Returns:
intent(Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
public boolean hasIntentElement()
-
hasIntent
public boolean hasIntent()
-
setIntentElement
public CarePlan setIntentElement(Enumeration<CarePlan.CarePlanIntent> value)
- Parameters:
value-intent(Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
public CarePlan.CarePlanIntent getIntent()
- Returns:
- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
setIntent
public CarePlan setIntent(CarePlan.CarePlanIntent value)
- Parameters:
value- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
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.)
-
setCategory
public CarePlan setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public CarePlan addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist
-
getTitleElement
public StringType getTitleElement()
- Returns:
title(Human-friendly name for the CarePlan.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public CarePlan setTitleElement(StringType value)
- Parameters:
value-title(Human-friendly name for the CarePlan.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
setTitle
public CarePlan setTitle(String value)
- Parameters:
value- Human-friendly name for the CarePlan.
-
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.
-
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.)
-
getContext
public Reference getContext()
- Returns:
context(Identifies the original context in which this particular CarePlan was created.)
-
hasContext
public boolean hasContext()
-
setContext
public CarePlan setContext(Reference value)
- Parameters:
value-context(Identifies the original context in which this particular CarePlan was created.)
-
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 original context in which this particular CarePlan was created.)
-
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 original context in which this particular CarePlan was created.)
-
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.)
-
setAuthor
public CarePlan setAuthor(List<Reference> theAuthor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
-
getAuthorFirstRep
public Reference getAuthorFirstRep()
- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist
-
getAuthorTarget
@Deprecated public List<Resource> getAuthorTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getCareTeam
public List<Reference> getCareTeam()
- Returns:
careTeam(Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
-
setCareTeam
public CarePlan setCareTeam(List<Reference> theCareTeam)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCareTeam
public boolean hasCareTeam()
-
addCareTeam
public Reference addCareTeam()
-
addCareTeam
public CarePlan addCareTeam(Reference t)
-
getCareTeamFirstRep
public Reference getCareTeamFirstRep()
- Returns:
- The first repetition of repeating field
careTeam, creating it if it does not already exist
-
getCareTeamTarget
@Deprecated public List<CareTeam> getCareTeamTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addCareTeamTarget
@Deprecated public CareTeam addCareTeamTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getAddresses
public List<Reference> getAddresses()
- Returns:
addresses(Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
setAddresses
public CarePlan setAddresses(List<Reference> theAddresses)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAddresses
public boolean hasAddresses()
-
addAddresses
public Reference addAddresses()
-
addAddresses
public CarePlan addAddresses(Reference t)
-
getAddressesFirstRep
public Reference getAddressesFirstRep()
- Returns:
- The first repetition of repeating field
addresses, creating it if it does not already exist
-
getAddressesTarget
@Deprecated public List<Condition> getAddressesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addAddressesTarget
@Deprecated public Condition addAddressesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getSupportingInfo
public List<Reference> getSupportingInfo()
- Returns:
supportingInfo(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.)
-
setSupportingInfo
public CarePlan setSupportingInfo(List<Reference> theSupportingInfo)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInfo
public boolean hasSupportingInfo()
-
addSupportingInfo
public Reference addSupportingInfo()
-
addSupportingInfo
public CarePlan addSupportingInfo(Reference t)
-
getSupportingInfoFirstRep
public Reference getSupportingInfoFirstRep()
- Returns:
- The first repetition of repeating field
supportingInfo, creating it if it does not already exist
-
getSupportingInfoTarget
@Deprecated public List<Resource> getSupportingInfoTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getGoal
public List<Reference> getGoal()
- Returns:
goal(Describes the intended objective(s) of carrying out the care plan.)
-
setGoal
public CarePlan setGoal(List<Reference> theGoal)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGoal
public boolean hasGoal()
-
getGoalFirstRep
public Reference getGoalFirstRep()
- Returns:
- The first repetition of repeating field
goal, creating it if it does not already exist
-
getGoalTarget
@Deprecated public List<Goal> getGoalTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addGoalTarget
@Deprecated public Goal addGoalTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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.)
-
setActivity
public CarePlan setActivity(List<CarePlan.CarePlanActivityComponent> theActivity)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasActivity
public boolean hasActivity()
-
addActivity
public CarePlan.CarePlanActivityComponent addActivity()
-
addActivity
public CarePlan addActivity(CarePlan.CarePlanActivityComponent t)
-
getActivityFirstRep
public CarePlan.CarePlanActivityComponent getActivityFirstRep()
- Returns:
- The first repetition of repeating field
activity, creating it if it does not already exist
-
getNote
public List<Annotation> getNote()
- Returns:
note(General notes about the care plan not covered elsewhere.)
-
setNote
public CarePlan setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public CarePlan addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin 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
-
-