@openactive/models-ts/lib/schema/DietarySupplement.d.ts

JavaScript/TypeScript implementation of OpenActive's data model

import * as Joi from 'joi';
import { OaValidationError } from '../oaValidationError';
import * as schema from '../schema';
/**
 * schema:DietarySupplement
 */
export declare type DietarySupplement = {
    '@type': 'DietarySupplement';
    '@context'?: string | string[];
    /**
     * The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
     *
     */
    identifier?: schema.PropertyValueOrSubClass | string;
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * A description of the item.
     */
    description?: string;
    /**
     * A unique url based identifier for the record
     */
    '@id'?: string;
    /**
     * The specific biochemical interaction through which this drug or supplement produces its pharmacological effect.
     */
    mechanismOfAction?: string;
    /**
     * True if this item's name is a proprietary/brand name (vs. generic name).
     */
    isProprietary?: boolean;
    /**
     * Recommended intake of this supplement for a given population as defined by a specific recommending authority.
     */
    maximumIntake?: schema.MaximumDoseScheduleOrSubClass | string;
    /**
     * Any potential safety concern associated with the supplement. May include interactions with other drugs and foods, pregnancy, breastfeeding, known adverse reactions, and documented efficacy of the supplement.
     */
    safetyConsideration?: string;
    /**
     * The drug or supplement's legal status, including any controlled substance schedules that apply.
     */
    legalStatus?: schema.MedicalEnumeration | string | schema.DrugLegalStatusOrSubClass;
    /**
     * The generic name of this drug or supplement.
     */
    nonProprietaryName?: string;
    /**
     * Proprietary name given to the diet plan, typically by its originator or creator.
     */
    proprietaryName?: string;
    /**
     * Recommended intake of this supplement for a given population as defined by a specific recommending authority.
     */
    recommendedIntake?: schema.RecommendedDoseScheduleOrSubClass | string;
    /**
     * An active ingredient, typically chemical compounds and/or biologic substances.
     */
    activeIngredient?: string;
    /**
     * The manufacturer of the product.
     */
    manufacturer?: schema.OrganizationOrSubClass | string;
    /**
     * Characteristics of the population for which this is intended, or which typically uses it, e.g. 'adults'.
     */
    targetPopulation?: string;
    /**
     * A medical guideline related to this entity.
     */
    guideline?: schema.MedicalGuidelineOrSubClass | string;
    /**
     * If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
     */
    recognizingAuthority?: schema.OrganizationOrSubClass | string;
    /**
     * A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
     */
    code?: schema.MedicalCodeOrSubClass | string;
    /**
     * If applicable, a medical specialty in which this entity is relevant.
     */
    relevantSpecialty?: schema.MedicalSpecialtyOrSubClass | string;
    /**
     * A medical study or trial related to this entity.
     */
    study?: schema.MedicalStudyOrSubClass | string;
    /**
     * The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
     */
    medicineSystem?: schema.MedicineSystemOrSubClass | string;
    /**
     * URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
     */
    sameAs?: string;
    /**
     * A CreativeWork or Event about this Thing.
     */
    subjectOf?: schema.Event_OrSubClass | schema.CreativeWorkOrSubClass | string;
    /**
     * Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
     */
    potentialAction?: schema.ActionOrSubClass | string;
    /**
     * Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
     */
    mainEntityOfPage?: schema.CreativeWorkOrSubClass | string;
    /**
     * An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
     */
    additionalType?: string;
    /**
     * An alias for the item.
     */
    alternateName?: string;
    /**
     * URL of the item.
     */
    url?: string;
    /**
     * An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
     */
    image?: schema.ImageObjectOrSubClass | string;
    /**
     * A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
     */
    disambiguatingDescription?: string;
};
/**
 * schema:DietarySupplement
 *
 * This differs from DietarySupplement because it also allows for objects that have the type of a model that
 * sub-classes this model. e.g. `Event_OrSubClass` allows `Event`s as well as `ScheduledSession`s, `SessionSeries`,
 * etc.
 */
export declare type DietarySupplementOrSubClass = DietarySupplement;
/**
 * schema:DietarySupplement - Validation schema (w/ JOI)
 */
export declare const DietarySupplementJoiSchema: Joi.ObjectSchema;
/**
 * schema:DietarySupplement - Validation schema (w/ JOI)
 *
 * This differs from DietarySupplementJoiSchema because it also allows for objects that have the type of a model that
 * sub-classes this model. e.g. `Event.OrSubClassJoiSchema` allows `Event`s as well as `ScheduledSession`s,
 * `SessionSeries`, etc.
 */
export declare const DietarySupplementOrSubClassJoiSchema: Joi.AlternativesSchema;
/**
 * Runtime validator for schema:DietarySupplement.
 *
 * If some data has a structure which matches a schema:DietarySupplement, it will be returned with the correct type.
 * Otherwise, this function returns an OAValidationError with details about why the data does not match.
 *
 * Use this to e.g. check a JSON object received in an HTTP request. Example usage (for an express request handler):
 *
 * ```ts
 * const maybeDietarySupplement = validateDietarySupplement(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeDietarySupplement instanceof OaValidationError) {
 *   // From this point on, `maybeDietarySupplement` will have type `OaValidationError`
 *   const error = maybeDietarySupplement;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeDietarySupplement` will have type `DietarySupplement`
 * const dietarySupplement = maybeDietarySupplement;
 * ```
 */
export declare function validateDietarySupplement(maybeDietarySupplement: unknown): DietarySupplement | OaValidationError;