Data Model Libraries
    Preparing search index...

    Class NutritionOrderOralDietScheduleComponent

    NutritionOrderOralDietScheduleComponent Class

    FHIR Specification

    • Short: Scheduling information for oral diets
    • Definition: Schedule information for an oral diet.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    timing?: Timing[]

    NutritionOrder.oralDiet.schedule.timing Element

    FHIR Specification

    • Short: Scheduled frequency of diet
    • Definition: The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.
    • FHIR Type: Timing
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    asNeeded?: BooleanType

    NutritionOrder.oralDiet.schedule.asNeeded Element

    FHIR Specification

    • Short: Take 'as needed'
    • Definition: Indicates whether the product is only taken when needed within a specific dosing schedule.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    asNeededFor?: CodeableConcept

    NutritionOrder.oralDiet.schedule.asNeededFor Element

    FHIR Specification

    • Short: Take 'as needed' for x
    • Definition: Indicates whether the product is only taken based on a precondition for taking the product.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderOralDietScheduleComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderOralDietScheduleComponent

      NutritionOrderOralDietScheduleComponent data model or undefined for NutritionOrderOralDietScheduleComponent

      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