Data Model Libraries
    Preparing search index...

    Class Timing

    Timing Class

    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.

    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.

    FHIR Specification

    • Short: A timing schedule that specifies an event that may occur multiple times
    • Definition: 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.
    • Comment: Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events. A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.
    • FHIR Version: 5.0.0

    FHIR Timing

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    event? repeat? code?

    Methods

    parse getEventElement setEventElement addEventElement hasEventElement getEvent setEvent addEvent hasEvent getRepeat setRepeat hasRepeat getCode setCode hasCode fhirType isEmpty copy isComplexDataType dataTypeName toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initEvent

    Constructors

    Properties

    event?: DateTimeType[]

    Timing.event Element

    FHIR Specification

    • Short: When the event occurs
    • Definition: Identifies specific times when the event occurs.
    • Requirements: In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
    • FHIR Type: dateTime
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    repeat?: TimingRepeatComponent

    Timing.repeat Element

    FHIR Specification

    • Short: When the event is to occur
    • Definition: A set of rules that describe when the event is scheduled.
    • Requirements: Many timing schedules are determined by regular repetitions.
    • FHIR Type: Element
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    Timing.code Element

    FHIR Specification

    • Short: C | BID | TID | QID | AM | PM | QD | QOD | +
    • Definition: 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).
    • Comment: BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided Timing JSON to instantiate the Timing data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Timing

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Timing

      Returns undefined | Timing

      Timing data model or undefined for Timing

      JsonError if the provided JSON is not a valid JSON object

    • Determines if modifierExtension property exists for the provided url

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if the modifierExtension property exists and has at least one element; false otherwise

    • Adds the provided Extension to the modifierExtension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the modifierExtension property array

      Returns this

      this

    • Removes the Extension having the provided url from the modifierExtension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods