Class PlanDefinition.PlanDefinitionGoalTargetComponent

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

    public static class PlanDefinition.PlanDefinitionGoalTargetComponent
    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 to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level.
      • detail

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

        protected Duration due
        Indicates the timeframe after the start of the goal in which the goal should be met.
    • Method Detail

      • getMeasure

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

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

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

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

        public Duration getDue()
        Returns:
        due (Indicates the timeframe after the start of the goal in which the goal should be met.)
      • hasDue

        public boolean hasDue()
      • isEmpty

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