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).
      • 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 context in which this particular CarePlan is defined.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.)
      • period

        protected Period period
        Indicates when the plan did (or is intended to) come into effect and end.
      • author

        protected List<Reference> author
        Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
      • authorTarget

        protected List<Resource> authorTarget
        The actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
      • modified

        protected DateTimeType modified
        Identifies the most recent date on which the plan has been revised.
      • category

        protected List<CodeableConcept> category
        Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
      • addresses

        protected List<Reference> addresses
        Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
      • addressesTarget

        protected List<Condition> addressesTarget
        The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
      • support

        protected List<Reference> support
        Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
      • supportTarget

        protected List<Resource> supportTarget
        The actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
      • 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 Annotation note
        General notes about the care plan not covered elsewhere.
      • ACTIVITYCODE

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

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

      • 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".
      • 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_ACTIVITYDATE

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

      • 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

      • 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".
      • SP_RELATED

        public static final String SP_RELATED
        Search parameter: related

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

        See Also:
        Constant Field Values
      • RELATED

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.ReferenceClientParam> RELATED
        Fluent Client search parameter constant for related

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

      • SP_RELATEDCODE

        public static final String SP_RELATEDCODE
        Search parameter: relatedcode

        Description: includes | replaces | fulfills
        Type: token
        Path: CarePlan.relatedPlan.code

        See Also:
        Constant Field Values
      • RELATEDCODE

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

        Description: includes | replaces | fulfills
        Type: token
        Path: CarePlan.relatedPlan.code

      • 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".
      • PARTICIPANT

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

        Description: Who is involved
        Type: reference
        Path: CarePlan.participant.member

      • 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".
      • 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_ACTIVITYREFERENCE

        public static final String SP_ACTIVITYREFERENCE
        Search parameter: activityreference

        Description: Activity details defined in specific resource
        Type: reference
        Path: CarePlan.activity.reference

        See Also:
        Constant Field Values
      • ACTIVITYREFERENCE

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

        Description: Activity details defined in specific resource
        Type: reference
        Path: CarePlan.activity.reference

      • 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".
      • SP_RELATEDPLAN

        public static final String SP_RELATEDPLAN
        Search parameter: relatedplan

        Description: Plan relationship exists with
        Type: reference
        Path: CarePlan.relatedPlan.plan

        See Also:
        Constant Field Values
      • RELATEDPLAN

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

        Description: Plan relationship exists with
        Type: reference
        Path: CarePlan.relatedPlan.plan

      • 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".
    • Method Detail

      • getIdentifier

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

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

        public Reference getSubject()
        Returns:
        subject (Identifies the patient or group whose intended care is described by the plan.)
      • 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:
        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

        public CarePlan setSubjectTarget​(Resource value)
        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.)
      • getStatusElement

        public Enumeration<CarePlan.CarePlanStatusgetStatusElement()
        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
      • setStatusElement

        public CarePlan setStatusElement​(Enumeration<CarePlan.CarePlanStatus> value)
        Parameters:
        value - status (Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      • getStatus

        public CarePlan.CarePlanStatus getStatus()
        Returns:
        Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
      • setStatus

        public CarePlan setStatus​(CarePlan.CarePlanStatus value)
        Parameters:
        value - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
      • getContext

        public Reference getContext()
        Returns:
        context (Identifies the context in which this particular CarePlan is defined.)
      • getContextTarget

        public Resource getContextTarget()
        Returns:
        context 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 context in which this particular CarePlan is defined.)
      • setContextTarget

        public CarePlan setContextTarget​(Resource value)
        Parameters:
        value - context 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 context in which this particular CarePlan is defined.)
      • getPeriod

        public Period getPeriod()
        Returns:
        period (Indicates when the plan did (or is intended to) come into effect and end.)
      • 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<ReferencegetAuthor()
        Returns:
        author (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
      • addAuthor

        public Reference addAuthor()
        Returns:
        author (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
      • getAuthorTarget

        public List<ResourcegetAuthorTarget()
        Returns:
        author (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies the individual(s) or ogranization who is responsible for the content of the care plan.)
      • getModifiedElement

        public DateTimeType getModifiedElement()
        Returns:
        modified (Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
      • setModifiedElement

        public CarePlan setModifiedElement​(DateTimeType value)
        Parameters:
        value - modified (Identifies the most recent date on which the plan has been revised.). This is the underlying object with id, value and extensions. The accessor "getModified" gives direct access to the value
      • getModified

        public Date getModified()
        Returns:
        Identifies the most recent date on which the plan has been revised.
      • setModified

        public CarePlan setModified​(Date value)
        Parameters:
        value - Identifies the most recent date on which the plan has been revised.
      • getCategory

        public List<CodeableConceptgetCategory()
        Returns:
        category (Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.)
      • addCategory

        public CodeableConcept addCategory()
        Returns:
        category (Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.)
      • 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
      • 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.
      • getAddresses

        public List<ReferencegetAddresses()
        Returns:
        addresses (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
      • addAddresses

        public Reference addAddresses()
        Returns:
        addresses (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
      • getAddressesTarget

        public List<ConditiongetAddressesTarget()
        Returns:
        addresses (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
      • addAddressesTarget

        public Condition addAddressesTarget()
        Returns:
        addresses (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
      • getSupport

        public List<ReferencegetSupport()
        Returns:
        support (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
      • addSupport

        public Reference addSupport()
        Returns:
        support (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
      • getSupportTarget

        public List<ResourcegetSupportTarget()
        Returns:
        support (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.)
      • getGoal

        public List<ReferencegetGoal()
        Returns:
        goal (Describes the intended objective(s) of carrying out the care plan.)
      • hasGoal

        public boolean hasGoal()
      • addGoal

        public Reference addGoal()
        Returns:
        goal (Describes the intended objective(s) of carrying out the care plan.)
      • getGoalTarget

        public List<GoalgetGoalTarget()
        Returns:
        goal (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Describes the intended objective(s) of carrying out the care plan.)
      • addGoalTarget

        public Goal addGoalTarget()
        Returns:
        goal (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Describes the intended objective(s) of carrying out the care plan.)
      • getNote

        public Annotation getNote()
        Returns:
        note (General notes about the care plan not covered elsewhere.)
      • hasNote

        public boolean hasNote()
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource