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

    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
    • 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.)
      • 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.
      • 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.)
      • note

        protected List<Annotation> note
        General notes about the care plan not covered elsewhere.
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

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

        Description: Time period plan covers
        Type: date
        Path: CarePlan.period

      • CARE_TEAM

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CARE_TEAM
        Fluent Client search parameter constant for care-team

        Description: 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".
      • IDENTIFIER

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

        Description: External Ids for this plan
        Type: token
        Path: CarePlan.identifier

      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: 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

      • 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: goal

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

        Description: 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".
      • SUBJECT

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

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

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

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

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

        Description: 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".
      • ENCOUNTER

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

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

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

        Description: proposal | plan | order | option
        Type: token
        Path: CarePlan.intent

      • SP_ACTIVITY_REFERENCE

        public static final String SP_ACTIVITY_REFERENCE
        Search parameter: activity-reference

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

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

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

        Description: 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".
      • BASED_ON

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
        Fluent Client search parameter constant for based-on

        Description: 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".
      • PATIENT

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

        Description: 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".
      • CONTEXT

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

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

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

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

      • DEFINITION

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

        Description: 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".
      • CATEGORY

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

        Description: Type of plan
        Type: token
        Path: CarePlan.category

      • ACTIVITY_CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVITY_CODE
        Fluent Client search parameter constant for activity-code

        Description: Detail type of activity
        Type: token
        Path: CarePlan.activity.detail.code

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

        Description: draft | active | suspended | completed | entered-in-error | cancelled | unknown
        Type: token
        Path: CarePlan.status