Class CarePlan

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class CarePlan
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR CarePlan Resource ()

    Definition: 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.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/CarePlan

    See Also:
    Serialized Form
    • Field Detail

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: CarePlan.subject

      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description:
        Type: reference
        Path: CarePlan.subject

      • CONDITION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
        Fluent Client search parameter constant for condition

        Description:
        Type: reference
        Path: CarePlan.addresses

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description:
        Type: date
        Path: CarePlan.period

      • PARTICIPANT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT
        Fluent Client search parameter constant for participant

        Description:
        Type: reference
        Path: CarePlan.participant.member

      • ACTIVITYCODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVITYCODE
        Fluent Client search parameter constant for activitycode

        Description:
        Type: token
        Path: CarePlan.activity.detail.code

      • SP_ACTIVITYDATE

        public static final String SP_ACTIVITYDATE
        Search parameter constant for activitydate

        Description: Specified date occurs within period specified by CarePlan.activity.timingSchedule
        Type: date
        Path: CarePlan.activity.detail.scheduled[x]

        See Also:
        Constant Field Values
      • ACTIVITYDATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam ACTIVITYDATE
        Fluent Client search parameter constant for activitydate

        Description: Specified date occurs within period specified by CarePlan.activity.timingSchedule
        Type: date
        Path: CarePlan.activity.detail.scheduled[x]

      • ACTIVITYREFERENCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTIVITYREFERENCE
        Fluent Client search parameter constant for activityreference

        Description:
        Type: reference
        Path: CarePlan.activity.reference

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter constant for performer

        Description: 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 performer

        Description: 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

      • GOAL

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GOAL
        Fluent Client search parameter constant for goal

        Description:
        Type: reference
        Path: CarePlan.goal

      • RELATEDCODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATEDCODE
        Fluent Client search parameter constant for relatedcode

        Description:
        Type: token
        Path: CarePlan.relatedPlan.code

      • RELATEDPLAN

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATEDPLAN
        Fluent Client search parameter constant for relatedplan

        Description:
        Type: reference
        Path: CarePlan.relatedPlan.plan

      • SP_RELATEDCODE_RELATEDPLAN

        public static final String SP_RELATEDCODE_RELATEDPLAN
        Search parameter constant for relatedcode-relatedplan

        Description: A combination of the type of relationship and the related plan
        Type: composite
        Path: relatedcode & relatedplan

        See Also:
        Constant Field Values
      • RELATEDCODE_RELATEDPLAN

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.ReferenceClientParam> RELATEDCODE_RELATEDPLAN
        Fluent Client search parameter constant for relatedcode-relatedplan

        Description: A combination of the type of relationship and the related plan
        Type: composite
        Path: relatedcode & relatedplan

      • INCLUDE_ACTIVITYREFERENCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTIVITYREFERENCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activityreference".
      • 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".
      • 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".
      • INCLUDE_PARTICIPANT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:participant".
      • 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".
      • 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".
      • INCLUDE_RELATEDPLAN

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATEDPLAN
        Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:relatedplan".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: 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<IdentifierDt> theValue)
        Sets the value(s) for identifier ()

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier ()

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public CarePlan addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier ()

        Definition: 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)

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (), creating it if it does not already exist.

        Definition: 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)

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

        Definition: Identifies the patient or group whose intended care is described by the plan.

      • setSubject

        public CarePlan setSubject​(ResourceReferenceDt theValue)
        Sets the value(s) for subject ()

        Definition: Identifies the patient or group whose intended care is described by the plan.

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<CarePlanStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

      • setStatus

        public CarePlan setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<CarePlanStatusEnum> theValue)
        Sets the value(s) for status ()

        Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

      • setStatus

        public CarePlan setStatus​(CarePlanStatusEnum theValue)
        Sets the value(s) for status ()

        Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

      • getContext

        public ResourceReferenceDt getContext()
        Gets the value(s) for context (). creating it if it does not exist. Will not return null.

        Definition: Identifies the context in which this particular CarePlan is defined.

      • setContext

        public CarePlan setContext​(ResourceReferenceDt theValue)
        Sets the value(s) for context ()

        Definition: Identifies the context in which this particular CarePlan is defined.

      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (). creating it if it does not exist. Will not return null.

        Definition: Indicates when the plan did (or is intended to) come into effect and end.

      • setPeriod

        public CarePlan setPeriod​(PeriodDt theValue)
        Sets the value(s) for period ()

        Definition: Indicates when the plan did (or is intended to) come into effect and end.

      • getAuthor

        public List<ResourceReferenceDtgetAuthor()
        Gets the value(s) for author (). creating it if it does not exist. Will not return null.

        Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

      • setAuthor

        public CarePlan setAuthor​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for author ()

        Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

      • addAuthor

        public ResourceReferenceDt addAuthor()
        Adds and returns a new value for author ()

        Definition: Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

      • getModifiedElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getModifiedElement()
        Gets the value(s) for modified (). creating it if it does not exist. Will not return null.

        Definition: Identifies the most recent date on which the plan has been revised.

      • getModified

        public Date getModified()
        Gets the value(s) for modified (). creating it if it does not exist. This method may return null.

        Definition: Identifies the most recent date on which the plan has been revised.

      • setModified

        public CarePlan setModified​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for modified ()

        Definition: Identifies the most recent date on which the plan has been revised.

      • setModified

        public CarePlan setModified​(Date theDate,
                                    ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for modified ()

        Definition: Identifies the most recent date on which the plan has been revised.

      • getCategory

        public List<CodeableConceptDtgetCategory()
        Gets the value(s) for category (). creating it if it does not exist. Will not return null.

        Definition: 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<CodeableConceptDt> theValue)
        Sets the value(s) for category ()

        Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.

      • addCategory

        public CodeableConceptDt addCategory()
        Adds and returns a new value for category ()

        Definition: Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.

      • addCategory

        public CarePlan addCategory​(CodeableConceptDt theValue)
        Adds a given new value for category ()

        Definition: 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.

        Parameters:
        theValue - The category to add (must not be null)
      • getCategoryFirstRep

        public CodeableConceptDt getCategoryFirstRep()
        Gets the first repetition for category (), creating it if it does not already exist.

        Definition: 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.

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: A description of the scope and nature of the plan

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: A description of the scope and nature of the plan

      • setDescription

        public CarePlan setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A description of the scope and nature of the plan

      • setDescription

        public CarePlan setDescription​(String theString)
        Sets the value for description ()

        Definition: A description of the scope and nature of the plan

      • getAddresses

        public List<ResourceReferenceDtgetAddresses()
        Gets the value(s) for addresses (). creating it if it does not exist. Will not return null.

        Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

      • setAddresses

        public CarePlan setAddresses​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for addresses ()

        Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

      • addAddresses

        public ResourceReferenceDt addAddresses()
        Adds and returns a new value for addresses ()

        Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

      • getSupport

        public List<ResourceReferenceDtgetSupport()
        Gets the value(s) for support (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setSupport

        public CarePlan setSupport​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for support ()

        Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.

      • addSupport

        public ResourceReferenceDt addSupport()
        Adds and returns a new value for support ()

        Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.

      • getRelatedPlan

        public List<CarePlan.RelatedPlangetRelatedPlan()
        Gets the value(s) for relatedPlan (). creating it if it does not exist. Will not return null.

        Definition: Identifies CarePlans with some sort of formal relationship to the current plan.

      • addRelatedPlan

        public CarePlan.RelatedPlan addRelatedPlan()
        Adds and returns a new value for relatedPlan ()

        Definition: Identifies CarePlans with some sort of formal relationship to the current plan.

      • addRelatedPlan

        public CarePlan addRelatedPlan​(CarePlan.RelatedPlan theValue)
        Adds a given new value for relatedPlan ()

        Definition: Identifies CarePlans with some sort of formal relationship to the current plan.

        Parameters:
        theValue - The relatedPlan to add (must not be null)
      • getRelatedPlanFirstRep

        public CarePlan.RelatedPlan getRelatedPlanFirstRep()
        Gets the first repetition for relatedPlan (), creating it if it does not already exist.

        Definition: Identifies CarePlans with some sort of formal relationship to the current plan.

      • getParticipant

        public List<CarePlan.ParticipantgetParticipant()
        Gets the value(s) for participant (). creating it if it does not exist. Will not return null.

        Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • setParticipant

        public CarePlan setParticipant​(List<CarePlan.Participant> theValue)
        Sets the value(s) for participant ()

        Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • addParticipant

        public CarePlan.Participant addParticipant()
        Adds and returns a new value for participant ()

        Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • addParticipant

        public CarePlan addParticipant​(CarePlan.Participant theValue)
        Adds a given new value for participant ()

        Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

        Parameters:
        theValue - The participant to add (must not be null)
      • getParticipantFirstRep

        public CarePlan.Participant getParticipantFirstRep()
        Gets the first repetition for participant (), creating it if it does not already exist.

        Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

      • getGoal

        public List<ResourceReferenceDtgetGoal()
        Gets the value(s) for goal (). creating it if it does not exist. Will not return null.

        Definition: Describes the intended objective(s) of carrying out the care plan.

      • addGoal

        public ResourceReferenceDt addGoal()
        Adds and returns a new value for goal ()

        Definition: Describes the intended objective(s) of carrying out the care plan.

      • getActivity

        public List<CarePlan.ActivitygetActivity()
        Gets the value(s) for activity (). creating it if it does not exist. Will not return null.

        Definition: 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.Activity> theValue)
        Sets the value(s) for activity ()

        Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

      • addActivity

        public CarePlan.Activity addActivity()
        Adds and returns a new value for activity ()

        Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

      • addActivity

        public CarePlan addActivity​(CarePlan.Activity theValue)
        Adds a given new value for activity ()

        Definition: 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.

        Parameters:
        theValue - The activity to add (must not be null)
      • getActivityFirstRep

        public CarePlan.Activity getActivityFirstRep()
        Gets the first repetition for activity (), creating it if it does not already exist.

        Definition: 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.

      • getNote

        public AnnotationDt getNote()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: General notes about the care plan not covered elsewhere

      • setNote

        public CarePlan setNote​(AnnotationDt theValue)
        Sets the value(s) for note ()

        Definition: General notes about the care plan not covered elsewhere

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource