Data Model Libraries
    Preparing search index...

    Class AvailabilityAvailableTimeComponent

    AvailabilityAvailableTimeComponent Class

    FHIR Specification

    • Short: Times the {item} is available
    • Definition: Times the {item} is available.
    • Requirements: A collection of times that the {item} is available.

    Hierarchy (View Summary)

    • DataType
      • AvailabilityAvailableTimeComponent

    Implements

    Index

    Constructors

    Properties

    daysOfWeekEnum: DaysOfWeekEnum

    FHIR CodeSystem: DaysOfWeek

    daysOfWeek?: EnumCodeType[]

    Availability.availableTime.daysOfWeek Element

    FHIR Specification

    • Short: mon | tue | wed | thu | fri | sat | sun
    • Definition: mon | tue | wed | thu | fri | sat | sun.
    • Requirements: Indicates which days of the week are available between the start and end Times.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: DaysOfWeekEnum

    allDay?: BooleanType

    Availability.availableTime.allDay Element

    FHIR Specification

    • Short: Always available? i.e. 24 hour service
    • Definition: Always available? i.e. 24 hour service.
    • Requirements: Is this always available? (hence times are irrelevant) i.e. 24 hour service.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    availableStartTime?: TimeType

    Availability.availableTime.availableStartTime Element

    FHIR Specification

    • Short: Opening time of day (ignored if allDay = true)
    • Definition: Opening time of day (ignored if allDay = true).
    • Comment: The timezone is expected to be specified or implied by the context this datatype is used.
    • Requirements: The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
    • FHIR Type: time
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    availableEndTime?: TimeType

    Availability.availableTime.availableEndTime Element

    FHIR Specification

    • Short: Closing time of day (ignored if allDay = true)
    • Definition: Closing time of day (ignored if allDay = true).
    • Comment: The timezone is expected to be specified or implied by the context this datatype is used.
    • Requirements: The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
    • FHIR Type: time
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AvailabilityAvailableTimeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AvailabilityAvailableTimeComponent

      AvailabilityAvailableTimeComponent data model or undefined for AvailabilityAvailableTimeComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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