Data Model Libraries
    Preparing search index...

    Class PractitionerRoleAvailableTimeComponent

    PractitionerRoleAvailableTimeComponent Class

    FHIR Specification

    • Short: Times the Service Site is available
    • Definition: A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
    • Comment: More detailed availability information may be provided in associated Schedule/Slot resources.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    daysOfWeekEnum: DaysOfWeekEnum

    FHIR CodeSystem: DaysOfWeek

    daysOfWeek?: EnumCodeType[]

    PractitionerRole.availableTime.daysOfWeek Element

    FHIR Specification

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

    CodeSystem Enumeration: DaysOfWeekEnum

    allDay?: BooleanType

    PractitionerRole.availableTime.allDay Element

    FHIR Specification

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

    PractitionerRole.availableTime.availableStartTime Element

    FHIR Specification

    • Short: Opening time of day (ignored if allDay = true)
    • Definition: The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
    • Comment: The timezone is expected to be for where this HealthcareService is provided at.
    • FHIR Type: time
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    availableEndTime?: TimeType

    PractitionerRole.availableTime.availableEndTime Element

    FHIR Specification

    • Short: Closing time of day (ignored if allDay = true)
    • Definition: The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
    • Comment: The timezone is expected to be for where this HealthcareService is provided at.
    • FHIR Type: time
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PractitionerRoleAvailableTimeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PractitionerRoleAvailableTimeComponent

      PractitionerRoleAvailableTimeComponent data model or undefined for PractitionerRoleAvailableTimeComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise