Data Model Libraries
    Preparing search index...

    NutritionOrderSupplementComponent Class

    FHIR Specification

    • Short: Supplement components
    • Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    NutritionOrder.supplement.type Element

    FHIR Specification

    • Short: Type of supplement product requested
    • Definition: The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    productName?: StringType

    NutritionOrder.supplement.productName Element

    FHIR Specification

    • Short: Product or brand name of the nutritional supplement
    • Definition: The product or brand name of the nutritional supplement such as "Acme Protein Shake".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    NutritionOrder.supplement.schedule Element

    FHIR Specification

    • Short: Scheduling information for supplements
    • Definition: Schedule information for a supplement.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    NutritionOrder.supplement.quantity Element

    FHIR Specification

    • Short: Amount of the nutritional supplement
    • Definition: The amount of the nutritional supplement to be given.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    instruction?: StringType

    NutritionOrder.supplement.instruction Element

    FHIR Specification

    • Short: Instructions or additional information about the oral supplement
    • Definition: Free text or additional instructions or information pertaining to the oral supplement.
    • Comment: Free text dosage instructions can be used for cases where the instructions are too complex to code.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderSupplementComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderSupplementComponent

      NutritionOrderSupplementComponent data model or undefined for NutritionOrderSupplementComponent

      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