Class PeriodDt

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

    public class PeriodDt
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.ICompositeDatatype
    HAPI/FHIR PeriodDt Datatype ()

    Definition: A time period defined by a start and end date and optionally time.

    Requirements:

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      PeriodDt()
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends ca.uhn.fhir.model.api.IElement>
      List<T>
      getAllPopulatedChildElementsOfType​(Class<T> theType)  
      Date getEnd()
      Gets the value(s) for end ().
      ca.uhn.fhir.model.primitive.DateTimeDt getEndElement()
      Gets the value(s) for end ().
      Date getStart()
      Gets the value(s) for start ().
      ca.uhn.fhir.model.primitive.DateTimeDt getStartElement()
      Gets the value(s) for start ().
      boolean isEmpty()  
      PeriodDt setEnd​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for end ()
      PeriodDt setEnd​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for end ()
      PeriodDt setEndWithSecondsPrecision​(Date theDate)
      Sets the value for end ()
      PeriodDt setStart​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for start ()
      PeriodDt setStart​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for start ()
      PeriodDt setStartWithSecondsPrecision​(Date theDate)
      Sets the value for start ()
      • Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

        getElementSpecificId, getId, setElementSpecificId, setId, setId
      • Methods inherited from class ca.uhn.fhir.model.api.BaseElement

        addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData
      • Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

        fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
    • Constructor Detail

      • PeriodDt

        public PeriodDt()
        Constructor
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getStartElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getStartElement()
        Gets the value(s) for start (). creating it if it does not exist. Will not return null.

        Definition: The start of the period. The boundary is inclusive.

      • getStart

        public Date getStart()
        Gets the value(s) for start (). creating it if it does not exist. This method may return null.

        Definition: The start of the period. The boundary is inclusive.

      • setStart

        public PeriodDt setStart​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for start ()

        Definition: The start of the period. The boundary is inclusive.

      • setStart

        public PeriodDt setStart​(Date theDate,
                                 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for start ()

        Definition: The start of the period. The boundary is inclusive.

      • getEndElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getEndElement()
        Gets the value(s) for end (). creating it if it does not exist. Will not return null.

        Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time

      • getEnd

        public Date getEnd()
        Gets the value(s) for end (). creating it if it does not exist. This method may return null.

        Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time

      • setEnd

        public PeriodDt setEnd​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for end ()

        Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time

      • setEndWithSecondsPrecision

        public PeriodDt setEndWithSecondsPrecision​(Date theDate)
        Sets the value for end ()

        Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time

      • setEnd

        public PeriodDt setEnd​(Date theDate,
                               ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for end ()

        Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time