Package org.hl7.fhir.dstu2.model

Class Goal

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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

      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, group or organization for whom the goal is being established.

    • subjectTarget

      protected Resource 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

      protected Type target
      Indicates either the date or the duration after start by which the goal should be met.

    • category

      protected List<CodeableConcept> category
      Indicates a category the goal falls within.

    • description

      protected StringType description
      Human-readable description of a specific desired objective of care.

    • status

      protected Enumeration<Goal.GoalStatus> status
      Indicates whether the goal has been reached and is still considered relevant.

    • statusDate

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

    • statusReason

      protected CodeableConcept statusReason
      Captures the reason for the current status.

    • author

      protected Reference author
      Indicates whose goal this is - patient goal, practitioner goal, etc.

    • authorTarget

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

    • priority

      protected CodeableConcept priority
      Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

    • addresses

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

    • addressesTarget

      protected List<Resource> 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.

    • outcome

      protected List<Goal.GoalOutcomeComponent> outcome
      Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      See Also:

    • SP_PATIENT

      public static final String SP_PATIENT
      See Also:

    • SP_SUBJECT

      public static final String SP_SUBJECT
      See Also:

    • SP_TARGETDATE

      public static final String SP_TARGETDATE
      See Also:

    • SP_CATEGORY

      public static final String SP_CATEGORY
      See Also:

    • SP_STATUS

      public static final String SP_STATUS
      See Also:

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      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).)

    • hasIdentifier

      public boolean hasIdentifier()

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

    • addIdentifier

      public Goal addIdentifier(Identifier t)

    • getSubject

      public Reference getSubject()
      Returns:
      subject (Identifies the patient, group or organization for whom the goal is being established.)

    • hasSubject

      public boolean hasSubject()

    • setSubject

      public Goal setSubject(Reference value)
      Parameters:
      value - subject (Identifies the patient, group or organization for whom the goal is being established.)

    • 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, group or organization for whom the goal is being established.)

    • setSubjectTarget

      public Goal 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, group or organization for whom the goal is being established.)

    • getStart

      public Type getStart()
      Returns:
      start (The date or event after which the goal should begin being pursued.)

    • getStartDateType

      public DateType getStartDateType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      start (The date or event after which the goal should begin being pursued.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasStartDateType

      public boolean hasStartDateType()

    • getStartCodeableConcept

      public CodeableConcept getStartCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      start (The date or event after which the goal should begin being pursued.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasStartCodeableConcept

      public boolean hasStartCodeableConcept()

    • hasStart

      public boolean hasStart()

    • setStart

      public Goal setStart(Type value)
      Parameters:
      value - start (The date or event after which the goal should begin being pursued.)

    • getTarget

      public Type getTarget()
      Returns:
      target (Indicates either the date or the duration after start by which the goal should be met.)

    • getTargetDateType

      public DateType getTargetDateType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      target (Indicates either the date or the duration after start by which the goal should be met.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTargetDateType

      public boolean hasTargetDateType()

    • getTargetDuration

      public Duration getTargetDuration() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      target (Indicates either the date or the duration after start by which the goal should be met.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTargetDuration

      public boolean hasTargetDuration()

    • hasTarget

      public boolean hasTarget()

    • setTarget

      public Goal setTarget(Type value)
      Parameters:
      value - target (Indicates either the date or the duration after start by which the goal should be met.)

    • getCategory

      public List<CodeableConcept> getCategory()
      Returns:
      category (Indicates a category the goal falls within.)

    • hasCategory

      public boolean hasCategory()

    • addCategory

      public CodeableConcept addCategory()
      Returns:
      category (Indicates a category the goal falls within.)

    • addCategory

      public Goal addCategory(CodeableConcept t)

    • getDescriptionElement

      public StringType getDescriptionElement()
      Returns:
      description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public Goal setDescriptionElement(StringType value)
      Parameters:
      value - description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      Human-readable description of a specific desired objective of care.

    • setDescription

      public Goal setDescription(String value)
      Parameters:
      value - Human-readable description of a specific desired objective of care.

    • getStatusElement

      public Enumeration<Goal.GoalStatus> getStatusElement()
      Returns:
      status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public Goal setStatusElement(Enumeration<Goal.GoalStatus> value)
      Parameters:
      value - status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Goal.GoalStatus getStatus()
      Returns:
      Indicates whether the goal has been reached and is still considered relevant.

    • setStatus

      public Goal setStatus(Goal.GoalStatus value)
      Parameters:
      value - Indicates whether the goal has been reached and is still considered relevant.

    • getStatusDateElement

      public DateType getStatusDateElement()
      Returns:
      statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

    • hasStatusDateElement

      public boolean hasStatusDateElement()

    • hasStatusDate

      public boolean hasStatusDate()

    • setStatusDateElement

      public Goal setStatusDateElement(DateType value)
      Parameters:
      value - statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

    • getStatusDate

      public Date getStatusDate()
      Returns:
      Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

    • setStatusDate

      public Goal setStatusDate(Date value)
      Parameters:
      value - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

    • getStatusReason

      public CodeableConcept getStatusReason()
      Returns:
      statusReason (Captures the reason for the current status.)

    • hasStatusReason

      public boolean hasStatusReason()

    • setStatusReason

      public Goal setStatusReason(CodeableConcept value)
      Parameters:
      value - statusReason (Captures the reason for the current status.)

    • getAuthor

      public Reference getAuthor()
      Returns:
      author (Indicates whose goal this is - patient goal, practitioner goal, etc.)

    • hasAuthor

      public boolean hasAuthor()

    • setAuthor

      public Goal setAuthor(Reference value)
      Parameters:
      value - author (Indicates whose goal this is - patient goal, practitioner goal, etc.)

    • getAuthorTarget

      public Resource 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. (Indicates whose goal this is - patient goal, practitioner goal, etc.)

    • setAuthorTarget

      public Goal setAuthorTarget(Resource value)
      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. (Indicates whose goal this is - patient goal, practitioner goal, etc.)

    • getPriority

      public CodeableConcept getPriority()
      Returns:
      priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)

    • hasPriority

      public boolean hasPriority()

    • setPriority

      public Goal setPriority(CodeableConcept value)
      Parameters:
      value - priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)

    • getAddresses

      public List<Reference> getAddresses()
      Returns:
      addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)

    • hasAddresses

      public boolean hasAddresses()

    • addAddresses

      public Reference addAddresses()
      Returns:
      addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)

    • addAddresses

      public Goal addAddresses(Reference t)

    • getAddressesTarget

      public List<Resource> getAddressesTarget()
      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. The identified conditions and other health record elements that are intended to be addressed by the goal.)

    • getNote

      public List<Annotation> getNote()
      Returns:
      note (Any comments related to the goal.)

    • hasNote

      public boolean hasNote()

    • addNote

      public Annotation addNote()
      Returns:
      note (Any comments related to the goal.)

    • addNote

      public Goal addNote(Annotation t)

    • getOutcome

      public List<Goal.GoalOutcomeComponent> getOutcome()
      Returns:
      outcome (Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.)

    • hasOutcome

      public boolean hasOutcome()

    • addOutcome

      public Goal.GoalOutcomeComponent addOutcome()
      Returns:
      outcome (Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.)

    • addOutcome

      public Goal addOutcome(Goal.GoalOutcomeComponent t)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

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

    • copy

      public Goal copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected Goal typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource