Data Model Libraries
    Preparing search index...

    Instant Class

    Base StructureDefinition for instant Type: An instant in time - known at least to the second

    FHIR Specification

    • Short: Primitive Type instant
    • Definition: An instant in time - known at least to the second
    • Comment: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required
    • FHIR Version: 4.0.1; Normative since 4.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    assignValue: any
    typeErrorMessage: any

    Methods

    • Assigns the provided value.

      Parameters

      • Optionalvalue: string

        the generic T value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns a Luxon DateTime object for the PrimitiveType's getValue().

      Parameters

      • Optionalopts: DateTimeUtil.DateTimeOpts

        Optional DateTime options object to affect the creation of the DateTime instance

      Returns undefined | DateTime<boolean>

      an instance of a DateTime object

      Uses DateTime.fromISO() static method to create a DateTime object.

      InvalidDateTimeError if the instantiated DataTime object is invalid

    • Returns a Luxon DateTime object having the UTC time zone for the PrimitiveType's getValue().

      Returns undefined | DateTime<boolean>

      an instance of a DateTime object having the UTC time zone

      Uses DateTime.fromISO() static method to create a DateTime object.

      InvalidDateTimeError if the instantiated DataTime object is invalid

    • Sets the PrimitiveType's value of the provided dt argument as an ISO datetime string including milliseconds

      Parameters

      • dt: undefined | DateTime<boolean>

        DateTime object from which to obtain a string value

      Returns this

      this

      InvalidDateTimeError for an invalid dt argument

    • Encodes the provided generic T value as a string.

      Parameters

      • value: string

        the generic T value

      Returns string

      the string representation of T

      PrimitiveTypeError for invalid value

    • Parses the provided string value and coerces it into the generic T value.

      Parameters

      • value: string

        the string representation of the generic T value

      Returns string

      the generic T value

      PrimitiveTypeError for invalid value

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns string

      the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)

    • Returns undefined | string

      the generic T property value

    • Returns boolean

      true if the generic T value exists and has a value; false otherwise

    • Assigns the provided value and coerces it to the T type.

      Parameters

      • Optionalvalue: string

        the string value of the primitive type

      Returns void

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if the instance is empty; false otherwise

    • Returns boolean

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

    • 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

    • Protected

      Copies the current instance's elements into the provided object.

      Parameters

      Returns void