Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
static enum
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<CarePlan.CarePlanActivityComponent> Identifies a planned action to occur as part of the plan.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for activity-codestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for activity-datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for activity-referenceIdentifies the conditions/problems/concerns/diagnoses/etc.The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc.protected Reference
When populated, the author is responsible for the care plan.protected Resource
The actual object that is the target of the reference (When populated, the author is responsible for the care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onA care plan that is fulfilled in whole or in part by this care plan.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.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for care-teamIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.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.)protected List
<CodeableConcept> Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categorystatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for conditionIdentifies the individual(s) or organization who provided the contents of the care plan.The actual objects that are the target of the reference (Identifies the individual(s) or organization who provided the contents of the care plan.)protected DateTimeType
Represents when this particular CarePlan record was created in the system, which is often a system-generated date.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected StringType
A description of the scope and nature of the plan.protected Reference
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected Encounter
The actual object that is the target of the reference (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)Describes the intended objective(s) of carrying out the care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for goalThe actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)protected List
<Identifier> 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.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for instantiates-canonicalstatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for instantiates-uriprotected List
<CanonicalType> The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.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.protected Enumeration
<CarePlan.CarePlanIntent> Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for intentprotected List
<Annotation> General notes about the care plan not covered elsewhere.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for part-ofA larger care plan of which this particular care plan is a component or step.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.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerprotected Period
Indicates when the plan did (or is intended to) come into effect and end.Completed or terminated care plan whose function is taken by this new care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for replacesThe actual objects that are the target of the reference (Completed or terminated care plan whose function is taken by this new care plan.)static final String
Search parameter: activity-codestatic final String
Search parameter: activity-datestatic final String
Search parameter: activity-referencestatic final String
Search parameter: based-onstatic final String
Search parameter: care-teamstatic final String
Search parameter: categorystatic final String
Search parameter: conditionstatic final String
Search parameter: datestatic final String
Search parameter: encounterstatic final String
Search parameter: goalstatic final String
Search parameter: identifierstatic final String
Search parameter: instantiates-canonicalstatic final String
Search parameter: instantiates-uristatic final String
Search parameter: intentstatic final String
Search parameter: part-ofstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: replacesstatic final String
Search parameter: statusstatic final String
Search parameter: subjectprotected Enumeration
<CarePlan.CarePlanStatus> Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
Identifies the patient or group whose intended care is described by the plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)Identifies portions of the patient's record that specifically influenced the formation of the plan.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.protected StringType
Human-friendly name for the care plan.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionCarePlan()
ConstructorCarePlan
(Enumeration<CarePlan.CarePlanStatus> status, Enumeration<CarePlan.CarePlanIntent> intent, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddGoal()
Deprecated.Use Reference#setResource(IBaseResource) insteadaddInstantiatesCanonical
(String value) addInstantiatesUri
(String value) addNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(CarePlan dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetGoal()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetTitle()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasGoal()
boolean
boolean
boolean
hasInstantiatesCanonical
(String value) boolean
boolean
hasInstantiatesUri
(String value) boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActivity
(List<CarePlan.CarePlanActivityComponent> theActivity) setAddresses
(List<Reference> theAddresses) setAuthorTarget
(Resource value) setBasedOn
(List<Reference> theBasedOn) setCareTeam
(List<Reference> theCareTeam) setCategory
(List<CodeableConcept> theCategory) setContributor
(List<Reference> theContributor) setCreated
(Date value) setCreatedElement
(DateTimeType value) setDescription
(String value) setDescriptionElement
(StringType value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setIdentifier
(List<Identifier> theIdentifier) setInstantiatesCanonical
(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri
(List<UriType> theInstantiatesUri) setIntent
(CarePlan.CarePlanIntent value) setNote
(List<Annotation> theNote) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReplaces
(List<Reference> theReplaces) setStatus
(CarePlan.CarePlanStatus value) setSubject
(Reference value) setSubjectTarget
(Resource value) setSupportingInfo
(List<Reference> theSupportingInfo) setTitleElement
(StringType value) protected CarePlan
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
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. -
instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. -
basedOn
A care plan that is fulfilled in whole or in part by this care plan. -
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
Completed or terminated care plan whose function is taken by this new care plan. -
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
A larger care plan of which this particular care plan is a component or step. -
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
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. -
intent
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. -
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
Human-friendly name for the care plan. -
description
A description of the scope and nature of the plan. -
subject
Identifies the patient or group whose intended care is described by the plan. -
subjectTarget
The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.) -
encounter
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. -
encounterTarget
The actual object that is the target of the reference (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.) -
period
Indicates when the plan did (or is intended to) come into effect and end. -
created
Represents when this particular CarePlan record was created in the system, which is often a system-generated date. -
author
When populated, the author is responsible for the care plan. The care plan is attributed to the author. -
authorTarget
The actual object that is the target of the reference (When populated, the author is responsible for the care plan. The care plan is attributed to the author.) -
contributor
Identifies the individual(s) or organization who provided the contents of the care plan. -
contributorTarget
The actual objects that are the target of the reference (Identifies the individual(s) or organization who provided the contents of the care plan.) -
careTeam
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. -
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
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. -
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
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. -
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 comorbidities, recent procedures, limitations, recent assessments, etc.) -
goal
Describes the intended objective(s) of carrying out the care plan. -
goalTarget
The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.) -
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
General notes about the care plan not covered elsewhere. -
SP_DATE
Search parameter: dateDescription: Time period plan covers
Type: date
Path: CarePlan.period
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Time period plan covers
Type: date
Path: CarePlan.period
-
SP_CARE_TEAM
Search parameter: care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
- See Also:
-
CARE_TEAM
Fluent Client search parameter constant for care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
-
INCLUDE_CARE_TEAM
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:care-team". -
SP_IDENTIFIER
Search parameter: identifierDescription: External Ids for this plan
Type: token
Path: CarePlan.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External Ids for this plan
Type: token
Path: CarePlan.identifier
-
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:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:performer". -
SP_GOAL
Search parameter: goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
- See Also:
-
GOAL
Fluent Client search parameter constant for goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
-
INCLUDE_GOAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:goal". -
SP_SUBJECT
Search parameter: subjectDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:subject". -
SP_REPLACES
Search parameter: replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
- See Also:
-
REPLACES
Fluent Client search parameter constant for replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
-
INCLUDE_REPLACES
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:replaces". -
SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: CarePlan.instantiatesCanonical
- See Also:
-
INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: CarePlan.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:instantiates-canonical". -
SP_PART_OF
Search parameter: part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
- See Also:
-
PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
-
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:part-of". -
SP_ENCOUNTER
Search parameter: encounterDescription: Encounter created as part of
Type: reference
Path: CarePlan.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter created as part of
Type: reference
Path: CarePlan.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:encounter". -
SP_INTENT
Search parameter: intentDescription: proposal | plan | order | option
Type: token
Path: CarePlan.intent
- See Also:
-
INTENT
Fluent Client search parameter constant for intentDescription: proposal | plan | order | option
Type: token
Path: CarePlan.intent
-
SP_ACTIVITY_REFERENCE
Search parameter: activity-referenceDescription: Activity details defined in specific resource
Type: reference
Path: CarePlan.activity.reference
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activity-reference". -
SP_CONDITION
Search parameter: conditionDescription: Health issues this plan addresses
Type: reference
Path: CarePlan.addresses
- See Also:
-
CONDITION
Fluent Client search parameter constant for conditionDescription: Health issues this plan addresses
Type: reference
Path: CarePlan.addresses
-
INCLUDE_CONDITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:condition". -
SP_BASED_ON
Search parameter: based-onDescription: Fulfills CarePlan
Type: reference
Path: CarePlan.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Fulfills CarePlan
Type: reference
Path: CarePlan.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:based-on". -
SP_PATIENT
Search parameter: patientDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:patient". -
SP_ACTIVITY_DATE
Search parameter: activity-dateDescription: Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]
Type: date
Path: CarePlan.activity.detail.scheduled[x]
- See Also:
-
ACTIVITY_DATE
Fluent Client search parameter constant for activity-dateDescription: Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]
Type: date
Path: CarePlan.activity.detail.scheduled[x]
-
SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: CarePlan.instantiatesUri
- See Also:
-
INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: CarePlan.instantiatesUri
-
SP_CATEGORY
Search parameter: categoryDescription: Type of plan
Type: token
Path: CarePlan.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Type of plan
Type: token
Path: CarePlan.category
-
SP_ACTIVITY_CODE
Search parameter: activity-codeDescription: Detail type of activity
Type: token
Path: CarePlan.activity.detail.code
- See Also:
-
ACTIVITY_CODE
Fluent Client search parameter constant for activity-codeDescription: Detail type of activity
Type: token
Path: CarePlan.activity.detail.code
-
SP_STATUS
Search parameter: statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CarePlan.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CarePlan.status
-
-
Constructor Details
-
CarePlan
public CarePlan()Constructor -
CarePlan
public CarePlan(Enumeration<CarePlan.CarePlanStatus> status, Enumeration<CarePlan.CarePlanIntent> intent, Reference subject) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(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.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
setInstantiatesCanonical
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
addInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
hasInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
getInstantiatesUri
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
setInstantiatesUri
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
addInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
hasInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
getBasedOn
- Returns:
basedOn
(A care plan that is fulfilled in whole or in part by this care plan.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getReplaces
- Returns:
replaces
(Completed or terminated care plan whose function is taken by this new care plan.)
-
setReplaces
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReplaces
-
addReplaces
-
addReplaces
-
getReplacesFirstRep
- Returns:
- The first repetition of repeating field
replaces
, creating it if it does not already exist
-
getReplacesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addReplacesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPartOf
- Returns:
partOf
(A larger care plan of which this particular care plan is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
setStatus
- Parameters:
value
- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
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
-
hasIntent
-
setIntentElement
- 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
- Returns:
- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
setIntent
- Parameters:
value
- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
getTitleElement
- Returns:
title
(Human-friendly name for the care plan.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(Human-friendly name for the care plan.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- Human-friendly name for the care plan.
-
setTitle
- Parameters:
value
- Human-friendly name for the care plan.
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- A description of the scope and nature of the plan.
-
setDescription
- Parameters:
value
- A description of the scope and nature of the plan.
-
getSubject
- Returns:
subject
(Identifies the patient or group whose intended care is described by the plan.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(Identifies the patient or group whose intended care is described by the plan.)
-
getSubjectTarget
- Returns:
subject
The 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
- Parameters:
value
-subject
The 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.)
-
getEncounter
- Returns:
encounter
(The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
getEncounterTarget
- Returns:
encounter
The 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. (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
setEncounterTarget
- Parameters:
value
-encounter
The 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. (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
getPeriod
- Returns:
period
(Indicates when the plan did (or is intended to) come into effect and end.)
-
hasPeriod
-
setPeriod
- Parameters:
value
-period
(Indicates when the plan did (or is intended to) come into effect and end.)
-
getCreatedElement
- Returns:
created
(Represents when this particular CarePlan record was created in the system, which is often a system-generated date.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
hasCreatedElement
-
hasCreated
-
setCreatedElement
- Parameters:
value
-created
(Represents when this particular CarePlan record was created in the system, which is often a system-generated date.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
getCreated
- Returns:
- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
-
setCreated
- Parameters:
value
- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
-
getAuthor
- Returns:
author
(When populated, the author is responsible for the care plan. The care plan is attributed to the author.)
-
hasAuthor
-
setAuthor
- Parameters:
value
-author
(When populated, the author is responsible for the care plan. The care plan is attributed to the author.)
-
getAuthorTarget
- Returns:
author
The 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. (When populated, the author is responsible for the care plan. The care plan is attributed to the author.)
-
setAuthorTarget
- Parameters:
value
-author
The 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. (When populated, the author is responsible for the care plan. The care plan is attributed to the author.)
-
getContributor
- Returns:
contributor
(Identifies the individual(s) or organization who provided the contents of the care plan.)
-
setContributor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContributor
-
addContributor
-
addContributor
-
getContributorFirstRep
- Returns:
- The first repetition of repeating field
contributor
, creating it if it does not already exist
-
getContributorTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getCareTeam
- Returns:
careTeam
(Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
-
setCareTeam
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCareTeam
-
addCareTeam
-
addCareTeam
-
getCareTeamFirstRep
- Returns:
- The first repetition of repeating field
careTeam
, creating it if it does not already exist
-
getCareTeamTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addCareTeamTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getAddresses
- Returns:
addresses
(Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
setAddresses
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAddresses
-
addAddresses
-
addAddresses
-
getAddressesFirstRep
- Returns:
- The first repetition of repeating field
addresses
, creating it if it does not already exist
-
getAddressesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addAddressesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getSupportingInfo
- Returns:
supportingInfo
(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.)
-
setSupportingInfo
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo
, creating it if it does not already exist
-
getSupportingInfoTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getGoal
- Returns:
goal
(Describes the intended objective(s) of carrying out the care plan.)
-
setGoal
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGoal
-
addGoal
-
addGoal
-
getGoalFirstRep
- Returns:
- The first repetition of repeating field
goal
, creating it if it does not already exist
-
getGoalTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addGoalTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasActivity
-
addActivity
-
addActivity
-
getActivityFirstRep
- Returns:
- The first repetition of repeating field
activity
, creating it if it does not already exist
-
getNote
- Returns:
note
(General notes about the care plan not covered elsewhere.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-