Data Model Libraries
    Preparing search index...

    Class AppointmentRecurrenceTemplateMonthlyTemplateComponent

    AppointmentRecurrenceTemplateMonthlyTemplateComponent Class

    FHIR Specification

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    dayOfMonth?: PositiveIntType

    Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth Element

    FHIR Specification

    • Short: Recurs on a specific day of the month
    • Definition: Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    nthWeekOfMonth?: Coding

    Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth Element

    FHIR Specification

    • Short: Indicates which week of the month the appointment should occur
    • Definition: Indicates which week within a month the appointments in the series of recurring appointments should occur on.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dayOfWeek?: Coding

    Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek Element

    FHIR Specification

    • Short: Indicates which day of the week the appointment should occur
    • Definition: Indicates which day of the week the recurring appointments should occur each nth week.
    • Comment: This property is intended to be used with Appointment.recurrenceTemplate.monthly.nthWeek.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    monthInterval: null | PositiveIntType

    Appointment.recurrenceTemplate.monthlyTemplate.monthInterval Element

    FHIR Specification

    • Short: Recurs every nth month
    • Definition: Indicates that recurring appointments should occur every nth month.
    • FHIR Type: positiveInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AppointmentRecurrenceTemplateMonthlyTemplateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AppointmentRecurrenceTemplateMonthlyTemplateComponent

      AppointmentRecurrenceTemplateMonthlyTemplateComponent data model or undefined for AppointmentRecurrenceTemplateMonthlyTemplateComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise