Data Model Libraries
    Preparing search index...

    Class AvailabilityNotAvailableTimeComponent

    AvailabilityNotAvailableTimeComponent Class

    FHIR Specification

    • Short: Not available during this time due to provided reason
    • Definition: Not available during this time due to provided reason.
    • Requirements: The {item} is not available during this period of time due to the provided reason.

    Hierarchy (View Summary)

    • DataType
      • AvailabilityNotAvailableTimeComponent

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    Availability.notAvailableTime.description Element

    FHIR Specification

    • Short: Reason presented to the user explaining why time not available
    • Definition: Reason presented to the user explaining why time not available.
    • Comment: The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the during might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year). e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the during period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway.
    • Requirements: The reason that can be presented to the user as to why this time is not available.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    during?: Period

    Availability.notAvailableTime.during Element

    FHIR Specification

    • Short: Service not available during this period
    • Definition: Service not available during this period.
    • Requirements: The {item} is not available (seasonally or for a public holiday) during this period.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AvailabilityNotAvailableTimeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AvailabilityNotAvailableTimeComponent

      AvailabilityNotAvailableTimeComponent data model or undefined for AvailabilityNotAvailableTimeComponent

      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