Class 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
    • Constructor Detail

      • TimingDt

        public TimingDt()
        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
      • 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

        public TimingDt.Repeat 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

        public BoundCodeableConceptDt<TimingAbbreviationEnumgetCode()
        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

        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