Class Goal

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 Goal extends DomainResource
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
See Also:
  • Field Details

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

      Indicates whether the goal has been reached and is still considered relevant.
    • category

      Indicates a category the goal falls within.
    • priority

      Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
    • description

      Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
    • subject

      protected Reference subject
      Identifies the patient, group or organization for whom the goal is being established.
    • subjectTarget

      The actual object that is the target of the reference (Identifies the patient, group or organization for whom the goal is being established.)
    • start

      protected Type start
      The date or event after which the goal should begin being pursued.
    • target

      Indicates what should be done by when.
    • statusDate

      protected DateType statusDate
      Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
    • statusReason

      Captures the reason for the current status.
    • expressedBy

      Indicates whose goal this is - patient goal, practitioner goal, etc.
    • expressedByTarget

      The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)
    • addresses

      protected List<Reference> addresses
      The identified conditions and other health record elements that are intended to be addressed by the goal.
    • addressesTarget

      The actual objects that are the target of the reference (The identified conditions and other health record elements that are intended to be addressed by the goal.)
    • note

      protected List<Annotation> note
      Any comments related to the goal.
    • outcomeCode

      Identifies the change (or lack of change) at the point when the status of the goal is assessed.
    • outcomeReference

      Details of what's changed (or not changed).
    • outcomeReferenceTarget

      The actual objects that are the target of the reference (Details of what's changed (or not changed).)
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External Ids for this goal
      Type: token
      Path: Goal.identifier

      See Also:
    • IDENTIFIER

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

      Description: External Ids for this goal
      Type: token
      Path: Goal.identifier

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Who this goal is intended for
      Type: reference
      Path: Goal.subject

      See Also:
    • PATIENT

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

      Description: Who this goal is intended for
      Type: reference
      Path: Goal.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 "Goal:patient".
    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Who this goal is intended for
      Type: reference
      Path: Goal.subject

      See Also:
    • SUBJECT

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

      Description: Who this goal is intended for
      Type: reference
      Path: Goal.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 "Goal:subject".
    • SP_START_DATE

      public static final String SP_START_DATE
      Search parameter: start-date

      Description: When goal pursuit begins
      Type: date
      Path: Goal.startDate

      See Also:
    • START_DATE

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

      Description: When goal pursuit begins
      Type: date
      Path: Goal.startDate

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: E.g. Treatment, dietary, behavioral, etc.
      Type: token
      Path: Goal.category

      See Also:
    • CATEGORY

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

      Description: E.g. Treatment, dietary, behavioral, etc.
      Type: token
      Path: Goal.category

    • SP_TARGET_DATE

      public static final String SP_TARGET_DATE
      Search parameter: target-date

      Description: Reach goal on or before
      Type: date
      Path: Goal.target.dueDate

      See Also:
    • TARGET_DATE

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

      Description: Reach goal on or before
      Type: date
      Path: Goal.target.dueDate

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
      Type: token
      Path: Goal.status

      See Also:
    • STATUS

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

      Description: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
      Type: token
      Path: Goal.status

  • Constructor Details

  • Method Details