Class TimingDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.composite.TimingDt
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 TimingDt
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.ICompositeDatatype
HAPI/FHIR TimingDt Datatype ()

Definition: Specifies an event that may occur multiple times. Timing schedules are used to record when things are expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds

Requirements: Need to able to track proposed timing schedules. There are several different ways to do this: one or more specified times, a simple rules like three times a day, or before/after meals

See Also:
Serialized Form
  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  TimingDt.Repeat
    Block class for child element: Timing.repeat ()
  • Constructor Summary

    Constructors
    Constructor Description
    TimingDt()
    Constructor
  • Method Summary

    Modifier and Type Method Description
    ca.uhn.fhir.model.primitive.DateTimeDt addEvent()
    Adds and returns a new value for event ()
    TimingDt addEvent​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
    Adds a given new value for event ()
    TimingDt addEvent​(Date theDate)
    Adds a new value for event ()
    TimingDt addEvent​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
    Adds a new value for event ()
    <T extends ca.uhn.fhir.model.api.IElement>
    List<T>
    getAllPopulatedChildElementsOfType​(Class<T> theType)  
    BoundCodeableConceptDt<TimingAbbreviationEnum> getCode()
    Gets the value(s) for code ().
    List<ca.uhn.fhir.model.primitive.DateTimeDt> getEvent()
    Gets the value(s) for event ().
    ca.uhn.fhir.model.primitive.DateTimeDt getEventFirstRep()
    Gets the first repetition for event (), creating it if it does not already exist.
    TimingDt.Repeat getRepeat()
    Gets the value(s) for repeat ().
    boolean isEmpty()  
    TimingDt setCode​(BoundCodeableConceptDt<TimingAbbreviationEnum> theValue)
    Sets the value(s) for code ()
    TimingDt setCode​(TimingAbbreviationEnum theValue)
    Sets the value(s) for code ()
    TimingDt setEvent​(List<ca.uhn.fhir.model.primitive.DateTimeDt> theValue)
    Sets the value(s) for event ()
    TimingDt setRepeat​(TimingDt.Repeat theValue)
    Sets the value(s) for repeat ()

    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 class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

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

    • TimingDt

      public TimingDt()
      Constructor
  • Method Details

    • 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
    • getEvent

      public List<ca.uhn.fhir.model.primitive.DateTimeDt> getEvent()
      Gets the value(s) for event (). creating it if it does not exist. Will not return null.

      Definition: Identifies specific times when the event occurs

    • setEvent

      public TimingDt setEvent​(List<ca.uhn.fhir.model.primitive.DateTimeDt> theValue)
      Sets the value(s) for event ()

      Definition: Identifies specific times when the event occurs

    • addEvent

      public ca.uhn.fhir.model.primitive.DateTimeDt addEvent()
      Adds and returns a new value for event ()

      Definition: Identifies specific times when the event occurs

    • addEvent

      public TimingDt addEvent​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Adds a given new value for event ()

      Definition: Identifies specific times when the event occurs

      Parameters:
      theValue - The event to add (must not be null)
    • getEventFirstRep

      public ca.uhn.fhir.model.primitive.DateTimeDt getEventFirstRep()
      Gets the first repetition for event (), creating it if it does not already exist.

      Definition: Identifies specific times when the event occurs

    • addEvent

      public TimingDt addEvent​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Adds a new value for event ()

      Definition: Identifies specific times when the event occurs

      Returns:
      Returns a reference to this object, to allow for simple chaining.
    • addEvent

      public TimingDt addEvent​(Date theDate)
      Adds a new value for event ()

      Definition: Identifies specific times when the event occurs

      Returns:
      Returns a reference to this object, to allow for simple chaining.
    • getRepeat

      Gets the value(s) for repeat (). creating it if it does not exist. Will not return null.

      Definition: A set of rules that describe when the event should occur

    • setRepeat

      public TimingDt setRepeat​(TimingDt.Repeat theValue)
      Sets the value(s) for repeat ()

      Definition: A set of rules that describe when the event should occur

    • getCode

      Gets the value(s) for code (). creating it if it does not exist. Will not return null.

      Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes

    • setCode

      Sets the value(s) for code ()

      Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes

    • setCode

      public TimingDt setCode​(TimingAbbreviationEnum theValue)
      Sets the value(s) for code ()

      Definition: A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes