core/com.babylonhealth.lit.core.model/Timing

Timing

@POJOBoilerplate
class Timing(val id: Option[String], val code: Option[CodeableConcept], val event: LitSeq[FHIRDateTime], val extension: LitSeq[Extension], val modifierExtension: LitSeq[Extension], val repeat: Option[Repeat], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends BackboneElement

Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, 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, and may be used for reporting the schedule to which past regular activities were carried out.

Subclass of core.model.BackboneElement (Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.)

Value Params
code
  • A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
event
  • Identifies specific times when the event occurs.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
repeat
  • A set of rules that describe when the event is scheduled.
Constructor

Introduces the fields code, event, repeat.

Companion
object
class Element
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from
FHIRObject
object ids
Inherited from
FHIRObject

Inherited types

Value members

Concrete methods

def getIds(field: C => FHIRComponentFieldMeta[_]): Option[String]
def set[T](fieldSelection: C => FHIRComponentFieldMeta[T])(value: T): O
def setExtensions(field: C => FHIRComponentFieldMeta[_])(extension: LitSeq[Extension]): O
def setIds(field: C => FHIRComponentFieldMeta[_])(id: Option[String]): O
def update[T](fieldSelection: C => FHIRComponentFieldMeta[T])(fn: T => T): O
def updateAll[T](fieldSelection: C => FHIRComponentFieldMeta[LitSeq[T]])(fn: T => T): O
def updateIds(field: C => FHIRComponentFieldMeta[_])(update: Option[String] => Option[String]): O
def updateIfExists[T](fieldSelection: C => FHIRComponentFieldMeta[Option[T]])(fn: T => T): O

Inherited methods

final
def >>[T](fn: T => T)(implicit tt: LTag[T]): Timing

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from
FHIRObject
final
def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Timing]
Inherited from
FHIRObject
final
def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from
FHIRObject
final
def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from
Utils
def constructor: Constructor[_]
Inherited from
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from
Utils
override
def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from
FHIRComponent
override
def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def modifyField[T : LTag, Up >: Timing <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def modifyFieldUnsafe[T, Up >: Timing <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
final
def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from
FHIRObject
final
def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from
FHIRObject
final
def nodalMap[T](klass: Class[T], fn: T => T): Timing

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from
FHIRObject
def productElementNames: Iterator[String]
Implicitly added by summonObjectAndCompanionTiming_617552769
Inherited from
Product
def productIterator: Iterator[Any]
Implicitly added by summonObjectAndCompanionTiming_617552769
Inherited from
Product
def setFromField[T, UpType >: Timing <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from
FHIRObject
def thisClassName: String
Inherited from
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from
FHIRObject
override
def toString: String
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from
FHIRObject
def updateFromField[T, UpType >: Timing <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from
FHIRObject
def withField[T : LTag, Up >: Timing <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFieldUnsafe[T, Up >: Timing <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFields[Up >: Timing <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject

Concrete fields

val code: Option[CodeableConcept]
override
val extension: LitSeq[Extension]
override
val id: Option[String]
val repeat: Option[Repeat]
override
val thisTypeName: String

Inherited fields