Data Model Libraries
    Preparing search index...

    Class AppointmentRecurrenceTemplateWeeklyTemplateComponent

    AppointmentRecurrenceTemplateWeeklyTemplateComponent Class

    FHIR Specification

    • Short: Information about weekly recurring appointments
    • Definition: Information about weekly recurring appointments.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    monday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.monday Element

    FHIR Specification

    • Short: Recurs on Mondays
    • Definition: Indicates that recurring appointments should occur on Mondays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    tuesday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.tuesday Element

    FHIR Specification

    • Short: Recurs on Tuesday
    • Definition: Indicates that recurring appointments should occur on Tuesdays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    wednesday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.wednesday Element

    FHIR Specification

    • Short: Recurs on Wednesday
    • Definition: Indicates that recurring appointments should occur on Wednesdays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    thursday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.thursday Element

    FHIR Specification

    • Short: Recurs on Thursday
    • Definition: Indicates that recurring appointments should occur on Thursdays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    friday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.friday Element

    FHIR Specification

    • Short: Recurs on Friday
    • Definition: Indicates that recurring appointments should occur on Fridays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    saturday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.saturday Element

    FHIR Specification

    • Short: Recurs on Saturday
    • Definition: Indicates that recurring appointments should occur on Saturdays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    sunday?: BooleanType

    Appointment.recurrenceTemplate.weeklyTemplate.sunday Element

    FHIR Specification

    • Short: Recurs on Sunday
    • Definition: Indicates that recurring appointments should occur on Sundays.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    weekInterval?: PositiveIntType

    Appointment.recurrenceTemplate.weeklyTemplate.weekInterval Element

    FHIR Specification

    • Short: Recurs every nth week
    • Definition: The interval defines if the recurrence is every nth week. The default is every week, so it is expected that this value will be 2 or more. e.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AppointmentRecurrenceTemplateWeeklyTemplateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AppointmentRecurrenceTemplateWeeklyTemplateComponent

      AppointmentRecurrenceTemplateWeeklyTemplateComponent data model or undefined for AppointmentRecurrenceTemplateWeeklyTemplateComponent

      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