Class Goal.GoalTargetComponent

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
    Enclosing class:
    Goal

    public static class Goal.GoalTargetComponent
    extends BackboneElement
    implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
    See Also:
    Serialized Form
    • Field Detail

      • measure

        protected CodeableConcept measure
        The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
      • detail

        protected Type detail
        The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
      • due

        protected Type due
        Indicates either the date or the duration after start by which the goal should be met.
    • Method Detail

      • getMeasure

        public CodeableConcept getMeasure()
        Returns:
        measure (The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.)
      • getDetail

        public Type getDetail()
        Returns:
        detail (The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.)
      • getDetailQuantity

        public Quantity getDetailQuantity()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        detail (The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getDetailRange

        public Range getDetailRange()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        detail (The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getDetailCodeableConcept

        public CodeableConcept getDetailCodeableConcept()
                                                 throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        detail (The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setDetail

        public Goal.GoalTargetComponent setDetail​(Type value)
                                           throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - detail (The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • getDue

        public Type getDue()
        Returns:
        due (Indicates either the date or the duration after start by which the goal should be met.)
      • getDueDateType

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

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

        public boolean hasDue()
      • setDue

        public Goal.GoalTargetComponent setDue​(Type value)
                                        throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - due (Indicates either the date or the duration after start by which the goal should be met.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • isEmpty

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