@openactive/models-ts

import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as schema from '../schema'; /** * schema:DoseSchedule */ export declare type DoseSchedule = { '@type': 'DoseSchedule'; '@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; /** * How often the dose is taken, e.g. 'daily'. */ frequency?: string; /** * The value of the dose, e.g. 500. */ doseValue?: number | schema.QualitativeValue; /** * The unit of the dose, e.g. 'mg'. */ doseUnit?: 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; /** * The drug or supplement's legal status, including any controlled substance schedules that apply. */ legalStatus?: schema.MedicalEnumeration | string | schema.DrugLegalStatusOrSubClass; /** * 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:DoseSchedule * * This differs from DoseSchedule 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 DoseScheduleOrSubClass = DoseSchedule | schema.MaximumDoseScheduleOrSubClass | schema.RecommendedDoseScheduleOrSubClass | schema.ReportedDoseScheduleOrSubClass; /** * schema:DoseSchedule - Validation schema (w/ JOI) */ export declare const DoseScheduleJoiSchema: Joi.ObjectSchema; /** * schema:DoseSchedule - Validation schema (w/ JOI) * * This differs from DoseScheduleJoiSchema 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 DoseScheduleOrSubClassJoiSchema: Joi.AlternativesSchema; /** * Runtime validator for schema:DoseSchedule. * * If some data has a structure which matches a schema:DoseSchedule, 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 maybeDoseSchedule = validateDoseSchedule(req.body); // `req.body` will have type `any` or `unknown` * if (maybeDoseSchedule instanceof OaValidationError) { * // From this point on, `maybeDoseSchedule` will have type `OaValidationError` * const error = maybeDoseSchedule; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeDoseSchedule` will have type `DoseSchedule` * const doseSchedule = maybeDoseSchedule; * ``` */ export declare function validateDoseSchedule(maybeDoseSchedule: unknown): DoseSchedule | OaValidationError;