SEO.JSONLD.DietarySupplement (SEO v0.3.0-rc.0)

A product taken by mouth that contains a dietary ingredient intended to supplement the diet. Dietary ingredients may include vitamins, minerals, herbs or other botanicals, amino acids, and substances such as enzymes, organ tissues, glandulars and metabolites.

Helper for building a Schema.org DietarySupplement JSON-LD structure.

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "DietarySupplement", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a DietarySupplement JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:active_ingredient) => String.t(),
    optional(:is_proprietary) => boolean(),
    optional(:legal_status) =>
      SEO.JSONLD.DrugLegalStatus.t()
      | map()
      | :abdomen
      | :active_not_recruiting
      | :anesthesia
      | :appearance
      | :ayurvedic
      | :bacteria
      | :cardiovascular
      | :cardiovascular_exam
      | :case_series
      | :chiropractic
      | :clinician
      | :cohort_study
      | :community_health
      | :completed
      | :cross_sectional
      | :ct
      | :dentistry
      | :dermatologic
      | :dermatology
      | :diagnostic
      | :diet_nutrition
      | :double_blinded_trial
      | :ear
      | :emergency
      | :endocrine
      | :enrolling_by_invitation
      | :evidence_level_a
      | :evidence_level_b
      | :evidence_level_c
      | :eye
      | :fd_acategory_a
      | :fd_acategory_b
      | :fd_acategory_c
      | :fd_acategory_d
      | :fd_acategory_x
      | :fd_anot_evaluated
      | :fungus
      | :gastroenterologic
      | :genetic
      | :genitourinary
      | :geriatric
      | :gynecologic
      | :head
      | :hematologic
      | :homeopathic
      | :infectious
      | :international_trial
      | :laboratory_science
      | :longitudinal
      | :lung
      | :medical_researcher
      | :midwifery
      | :mri
      | :multi_center_trial
      | :multicellular_parasite
      | :musculoskeletal
      | :musculoskeletal_exam
      | :neck
      | :neuro
      | :neurologic
      | :noninvasive_procedure
      | :nose
      | :not_yet_recruiting
      | :nursing
      | :observational
      | :obstetric
      | :oncologic
      | :open_trial
      | :optometric
      | :osteopathic
      | :otc
      | :otolaryngologic
      | :pathology
      | :pediatric
      | :percutaneous_procedure
      | :pet
      | :pharmacy_specialty
      | :physiotherapy
      | :placebo_controlled_trial
      | :plastic_surgery
      | :podiatric
      | :prescription_only
      | :primary_care
      | :prion
      | :protozoa
      | :psychiatric
      | :public_health
      | :pulmonary
      | :radiography
      | :randomized_trial
      | :recruiting
      | :registry
      | :reimbursement_cap
      | :renal
      | :respiratory_therapy
      | :results_available
      | :results_not_available
      | :retail
      | :rheumatologic
      | :single_blinded_trial
      | :single_center_trial
      | :skin
      | :speech_pathology
      | :surgical
      | :suspended
      | :terminated
      | :therapeutic
      | :throat
      | :toxicologic
      | :traditional_chinese
      | :triple_blinded_trial
      | :ultrasound
      | :urologic
      | :virus
      | :western_conventional
      | :wholesale
      | :withdrawn
      | :x_ray
      | String.t(),
    optional(:maximum_intake) => SEO.JSONLD.MaximumDoseSchedule.t() | map(),
    optional(:mechanism_of_action) => String.t(),
    optional(:non_proprietary_name) => String.t(),
    optional(:proprietary_name) => String.t(),
    optional(:recommended_intake) =>
      SEO.JSONLD.RecommendedDoseSchedule.t() | map(),
    optional(:safety_consideration) => String.t(),
    optional(:target_population) => String.t(),
    optional(:additional_property) => SEO.JSONLD.PropertyValue.t() | map(),
    optional(:aggregate_rating) => SEO.JSONLD.AggregateRating.t() | map(),
    optional(:asin) => String.t() | URI.t(),
    optional(:audience) => SEO.JSONLD.Audience.t() | map(),
    optional(:award) => String.t(),
    optional(:awards) => String.t(),
    optional(:brand) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Brand.t(),
    optional(:category) =>
      String.t()
      | URI.t()
      | SEO.JSONLD.Thing.t()
      | map()
      | :aerobic_activity
      | :anaerobic_activity
      | :balance
      | :flexibility
      | :leisure_time_activity
      | :occupational_activity
      | :strength_training
      | SEO.JSONLD.CategoryCode.t(),
    optional(:color) => String.t(),
    optional(:color_swatch) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:country_of_assembly) => String.t(),
    optional(:country_of_last_processing) => String.t(),
    optional(:country_of_origin) => SEO.JSONLD.Country.t() | map(),
    optional(:depth) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:display_location) => SEO.JSONLD.Place.t() | map(),
    optional(:funding) => SEO.JSONLD.Grant.t() | map(),
    optional(:gtin) => String.t() | URI.t(),
    optional(:gtin12) => String.t(),
    optional(:gtin13) => String.t(),
    optional(:gtin14) => String.t(),
    optional(:gtin8) => String.t(),
    optional(:has_adult_consideration) =>
      :alcohol_consideration
      | :dangerous_good_consideration
      | :healthcare_consideration
      | :narcotic_consideration
      | :reduced_relevance_for_children_consideration
      | :sexual_content_consideration
      | :tobacco_nicotine_consideration
      | :unclassified_adult_consideration
      | :violence_consideration
      | :weapon_consideration,
    optional(:has_certification) => SEO.JSONLD.Certification.t() | map(),
    optional(:has_energy_consumption_details) =>
      SEO.JSONLD.EnergyConsumptionDetails.t() | map(),
    optional(:has_gs1_digital_link) => URI.t() | String.t(),
    optional(:has_measurement) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:has_merchant_return_policy) =>
      SEO.JSONLD.MerchantReturnPolicy.t() | map(),
    optional(:height) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:in_product_group_with_id) => String.t(),
    optional(:is_accessory_or_spare_part_for) => SEO.JSONLD.Product.t() | map(),
    optional(:is_consumable_for) => SEO.JSONLD.Product.t() | map(),
    optional(:is_family_friendly) => boolean(),
    optional(:is_related_to) =>
      SEO.JSONLD.Service.t() | map() | SEO.JSONLD.Product.t(),
    optional(:is_similar_to) =>
      SEO.JSONLD.Service.t() | map() | SEO.JSONLD.Product.t(),
    optional(:is_variant_of) =>
      SEO.JSONLD.ProductModel.t() | map() | SEO.JSONLD.ProductGroup.t(),
    optional(:item_condition) =>
      :damaged_condition
      | :new_condition
      | :refurbished_condition
      | :used_condition,
    optional(:keywords) =>
      SEO.JSONLD.DefinedTerm.t() | map() | String.t() | URI.t(),
    optional(:logo) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:manufacturer) => SEO.JSONLD.Organization.t() | map(),
    optional(:material) =>
      String.t() | SEO.JSONLD.Product.t() | map() | URI.t(),
    optional(:mobile_url) => String.t(),
    optional(:model) => String.t() | SEO.JSONLD.ProductModel.t() | map(),
    optional(:mpn) => String.t(),
    optional(:negative_notes) =>
      SEO.JSONLD.ItemList.t()
      | map()
      | SEO.JSONLD.ListItem.t()
      | String.t()
      | SEO.JSONLD.WebContent.t(),
    optional(:nsn) => String.t(),
    optional(:offers) => SEO.JSONLD.Offer.t() | map() | SEO.JSONLD.Demand.t(),
    optional(:pattern) => SEO.JSONLD.DefinedTerm.t() | map() | String.t(),
    optional(:positive_notes) =>
      SEO.JSONLD.WebContent.t()
      | map()
      | SEO.JSONLD.ItemList.t()
      | SEO.JSONLD.ListItem.t()
      | String.t(),
    optional(:product_id) => String.t(),
    optional(:production_date) => Date.t() | String.t(),
    optional(:purchase_date) => Date.t() | String.t(),
    optional(:release_date) => Date.t() | String.t(),
    optional(:review) => SEO.JSONLD.Review.t() | map(),
    optional(:reviews) => SEO.JSONLD.Review.t() | map(),
    optional(:size) =>
      SEO.JSONLD.DefinedTerm.t()
      | map()
      | SEO.JSONLD.QuantitativeValue.t()
      | String.t(),
    optional(:sku) => String.t(),
    optional(:slogan) => String.t(),
    optional(:weight) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:width) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t(),
    optional(:code) => SEO.JSONLD.MedicalCode.t() | map(),
    optional(:guideline) => SEO.JSONLD.MedicalGuideline.t() | map(),
    optional(:medicine_system) =>
      :ayurvedic
      | :chiropractic
      | :homeopathic
      | :osteopathic
      | :traditional_chinese
      | :western_conventional,
    optional(:recognizing_authority) => SEO.JSONLD.Organization.t() | map(),
    optional(:relevant_specialty) =>
      :anesthesia
      | :cardiovascular
      | :community_health
      | :dentistry
      | :dermatologic
      | :dermatology
      | :diet_nutrition
      | :emergency
      | :endocrine
      | :gastroenterologic
      | :genetic
      | :geriatric
      | :gynecologic
      | :hematologic
      | :infectious
      | :laboratory_science
      | :midwifery
      | :musculoskeletal
      | :neurologic
      | :nursing
      | :obstetric
      | :oncologic
      | :optometric
      | :otolaryngologic
      | :pathology
      | :pediatric
      | :pharmacy_specialty
      | :physiotherapy
      | :plastic_surgery
      | :podiatric
      | :primary_care
      | :psychiatric
      | :public_health
      | :pulmonary
      | :radiography
      | :renal
      | :respiratory_therapy
      | :rheumatologic
      | :speech_pathology
      | :surgical
      | :toxicologic
      | :urologic,
    optional(:study) => SEO.JSONLD.MedicalStudy.t() | map()
  }
  | [
      active_ingredient: String.t(),
      is_proprietary: boolean(),
      legal_status:
        SEO.JSONLD.DrugLegalStatus.t()
        | map()
        | :abdomen
        | :active_not_recruiting
        | :anesthesia
        | :appearance
        | :ayurvedic
        | :bacteria
        | :cardiovascular
        | :cardiovascular_exam
        | :case_series
        | :chiropractic
        | :clinician
        | :cohort_study
        | :community_health
        | :completed
        | :cross_sectional
        | :ct
        | :dentistry
        | :dermatologic
        | :dermatology
        | :diagnostic
        | :diet_nutrition
        | :double_blinded_trial
        | :ear
        | :emergency
        | :endocrine
        | :enrolling_by_invitation
        | :evidence_level_a
        | :evidence_level_b
        | :evidence_level_c
        | :eye
        | :fd_acategory_a
        | :fd_acategory_b
        | :fd_acategory_c
        | :fd_acategory_d
        | :fd_acategory_x
        | :fd_anot_evaluated
        | :fungus
        | :gastroenterologic
        | :genetic
        | :genitourinary
        | :geriatric
        | :gynecologic
        | :head
        | :hematologic
        | :homeopathic
        | :infectious
        | :international_trial
        | :laboratory_science
        | :longitudinal
        | :lung
        | :medical_researcher
        | :midwifery
        | :mri
        | :multi_center_trial
        | :multicellular_parasite
        | :musculoskeletal
        | :musculoskeletal_exam
        | :neck
        | :neuro
        | :neurologic
        | :noninvasive_procedure
        | :nose
        | :not_yet_recruiting
        | :nursing
        | :observational
        | :obstetric
        | :oncologic
        | :open_trial
        | :optometric
        | :osteopathic
        | :otc
        | :otolaryngologic
        | :pathology
        | :pediatric
        | :percutaneous_procedure
        | :pet
        | :pharmacy_specialty
        | :physiotherapy
        | :placebo_controlled_trial
        | :plastic_surgery
        | :podiatric
        | :prescription_only
        | :primary_care
        | :prion
        | :protozoa
        | :psychiatric
        | :public_health
        | :pulmonary
        | :radiography
        | :randomized_trial
        | :recruiting
        | :registry
        | :reimbursement_cap
        | :renal
        | :respiratory_therapy
        | :results_available
        | :results_not_available
        | :retail
        | :rheumatologic
        | :single_blinded_trial
        | :single_center_trial
        | :skin
        | :speech_pathology
        | :surgical
        | :suspended
        | :terminated
        | :therapeutic
        | :throat
        | :toxicologic
        | :traditional_chinese
        | :triple_blinded_trial
        | :ultrasound
        | :urologic
        | :virus
        | :western_conventional
        | :wholesale
        | :withdrawn
        | :x_ray
        | String.t(),
      maximum_intake: SEO.JSONLD.MaximumDoseSchedule.t() | map(),
      mechanism_of_action: String.t(),
      non_proprietary_name: String.t(),
      proprietary_name: String.t(),
      recommended_intake: SEO.JSONLD.RecommendedDoseSchedule.t() | map(),
      safety_consideration: String.t(),
      target_population: String.t(),
      additional_property: SEO.JSONLD.PropertyValue.t() | map(),
      aggregate_rating: SEO.JSONLD.AggregateRating.t() | map(),
      asin: String.t() | URI.t(),
      audience: SEO.JSONLD.Audience.t() | map(),
      award: String.t(),
      awards: String.t(),
      brand: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Brand.t(),
      category:
        String.t()
        | URI.t()
        | SEO.JSONLD.Thing.t()
        | map()
        | :aerobic_activity
        | :anaerobic_activity
        | :balance
        | :flexibility
        | :leisure_time_activity
        | :occupational_activity
        | :strength_training
        | SEO.JSONLD.CategoryCode.t(),
      color: String.t(),
      color_swatch: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      country_of_assembly: String.t(),
      country_of_last_processing: String.t(),
      country_of_origin: SEO.JSONLD.Country.t() | map(),
      depth: SEO.JSONLD.QuantitativeValue.t() | map(),
      display_location: SEO.JSONLD.Place.t() | map(),
      funding: SEO.JSONLD.Grant.t() | map(),
      gtin: String.t() | URI.t(),
      gtin12: String.t(),
      gtin13: String.t(),
      gtin14: String.t(),
      gtin8: String.t(),
      has_adult_consideration:
        :alcohol_consideration
        | :dangerous_good_consideration
        | :healthcare_consideration
        | :narcotic_consideration
        | :reduced_relevance_for_children_consideration
        | :sexual_content_consideration
        | :tobacco_nicotine_consideration
        | :unclassified_adult_consideration
        | :violence_consideration
        | :weapon_consideration,
      has_certification: SEO.JSONLD.Certification.t() | map(),
      has_energy_consumption_details:
        SEO.JSONLD.EnergyConsumptionDetails.t() | map(),
      has_gs1_digital_link: URI.t() | String.t(),
      has_measurement: SEO.JSONLD.QuantitativeValue.t() | map(),
      has_merchant_return_policy: SEO.JSONLD.MerchantReturnPolicy.t() | map(),
      height: SEO.JSONLD.QuantitativeValue.t() | map(),
      in_product_group_with_id: String.t(),
      is_accessory_or_spare_part_for: SEO.JSONLD.Product.t() | map(),
      is_consumable_for: SEO.JSONLD.Product.t() | map(),
      is_family_friendly: boolean(),
      is_related_to: SEO.JSONLD.Service.t() | map() | SEO.JSONLD.Product.t(),
      is_similar_to: SEO.JSONLD.Service.t() | map() | SEO.JSONLD.Product.t(),
      is_variant_of:
        SEO.JSONLD.ProductModel.t() | map() | SEO.JSONLD.ProductGroup.t(),
      item_condition:
        :damaged_condition
        | :new_condition
        | :refurbished_condition
        | :used_condition,
      keywords: SEO.JSONLD.DefinedTerm.t() | map() | String.t() | URI.t(),
      logo: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      manufacturer: SEO.JSONLD.Organization.t() | map(),
      material: String.t() | SEO.JSONLD.Product.t() | map() | URI.t(),
      mobile_url: String.t(),
      model: String.t() | SEO.JSONLD.ProductModel.t() | map(),
      mpn: String.t(),
      negative_notes:
        SEO.JSONLD.ItemList.t()
        | map()
        | SEO.JSONLD.ListItem.t()
        | String.t()
        | SEO.JSONLD.WebContent.t(),
      nsn: String.t(),
      offers: SEO.JSONLD.Offer.t() | map() | SEO.JSONLD.Demand.t(),
      pattern: SEO.JSONLD.DefinedTerm.t() | map() | String.t(),
      positive_notes:
        SEO.JSONLD.WebContent.t()
        | map()
        | SEO.JSONLD.ItemList.t()
        | SEO.JSONLD.ListItem.t()
        | String.t(),
      product_id: String.t(),
      production_date: Date.t() | String.t(),
      purchase_date: Date.t() | String.t(),
      release_date: Date.t() | String.t(),
      review: SEO.JSONLD.Review.t() | map(),
      reviews: SEO.JSONLD.Review.t() | map(),
      size:
        SEO.JSONLD.DefinedTerm.t()
        | map()
        | SEO.JSONLD.QuantitativeValue.t()
        | String.t(),
      sku: String.t(),
      slogan: String.t(),
      weight: SEO.JSONLD.QuantitativeValue.t() | map(),
      width: SEO.JSONLD.QuantitativeValue.t() | map(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t(),
      code: SEO.JSONLD.MedicalCode.t() | map(),
      guideline: SEO.JSONLD.MedicalGuideline.t() | map(),
      medicine_system:
        :ayurvedic
        | :chiropractic
        | :homeopathic
        | :osteopathic
        | :traditional_chinese
        | :western_conventional,
      recognizing_authority: SEO.JSONLD.Organization.t() | map(),
      relevant_specialty:
        :anesthesia
        | :cardiovascular
        | :community_health
        | :dentistry
        | :dermatologic
        | :dermatology
        | :diet_nutrition
        | :emergency
        | :endocrine
        | :gastroenterologic
        | :genetic
        | :geriatric
        | :gynecologic
        | :hematologic
        | :infectious
        | :laboratory_science
        | :midwifery
        | :musculoskeletal
        | :neurologic
        | :nursing
        | :obstetric
        | :oncologic
        | :optometric
        | :otolaryngologic
        | :pathology
        | :pediatric
        | :pharmacy_specialty
        | :physiotherapy
        | :plastic_surgery
        | :podiatric
        | :primary_care
        | :psychiatric
        | :public_health
        | :pulmonary
        | :radiography
        | :renal
        | :respiratory_therapy
        | :rheumatologic
        | :speech_pathology
        | :surgical
        | :toxicologic
        | :urologic,
      study: SEO.JSONLD.MedicalStudy.t() | map()
    ]

t()

@type t() :: %{required(String.t()) => term()}

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a DietarySupplement JSON-LD map.

Fields

:active_ingredient - An active ingredient, typically chemical compounds and/or biologic substances.
:is_proprietary - True if this item's name is a proprietary/brand name (vs. generic name).
:legal_status - The drug or supplement's legal status, including any controlled substance schedules that apply. One of: :abdomen, :active_not_recruiting, :anesthesia, :appearance, :ayurvedic, :bacteria, :cardiovascular, :cardiovascular_exam, :case_series, :chiropractic, :clinician, :cohort_study, :community_health, :completed, :cross_sectional, :ct, :dentistry, :dermatologic, :dermatology, :diagnostic, :diet_nutrition, :double_blinded_trial, :ear, :emergency, :endocrine, :enrolling_by_invitation, :evidence_level_a, :evidence_level_b, :evidence_level_c, :eye, :fd_acategory_a, :fd_acategory_b, :fd_acategory_c, :fd_acategory_d, :fd_acategory_x, :fd_anot_evaluated, :fungus, :gastroenterologic, :genetic, :genitourinary, :geriatric, :gynecologic, :head, :hematologic, :homeopathic, :infectious, :international_trial, :laboratory_science, :longitudinal, :lung, :medical_researcher, :midwifery, :mri, :multi_center_trial, :multicellular_parasite, :musculoskeletal, :musculoskeletal_exam, :neck, :neuro, :neurologic, :noninvasive_procedure, :nose, :not_yet_recruiting, :nursing, :observational, :obstetric, :oncologic, :open_trial, :optometric, :osteopathic, :otc, :otolaryngologic, :pathology, :pediatric, :percutaneous_procedure, :pet, :pharmacy_specialty, :physiotherapy, :placebo_controlled_trial, :plastic_surgery, :podiatric, :prescription_only, :primary_care, :prion, :protozoa, :psychiatric, :public_health, :pulmonary, :radiography, :randomized_trial, :recruiting, :registry, :reimbursement_cap, :renal, :respiratory_therapy, :results_available, :results_not_available, :retail, :rheumatologic, :single_blinded_trial, :single_center_trial, :skin, :speech_pathology, :surgical, :suspended, :terminated, :therapeutic, :throat, :toxicologic, :traditional_chinese, :triple_blinded_trial, :ultrasound, :urologic, :virus, :western_conventional, :wholesale, :withdrawn, :x_ray.
:maximum_intake - Recommended intake of this supplement for a given population as defined by a specific recommending authority.
:mechanism_of_action - The specific biochemical interaction through which this drug or supplement produces its pharmacological effect.
:non_proprietary_name - The generic name of this drug or supplement.
:proprietary_name - Proprietary name given to the diet plan, typically by its originator or creator.
:recommended_intake - Recommended intake of this supplement for a given population as defined by a specific recommending authority.
:safety_consideration - 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.
:target_population - Characteristics of the population for which this is intended, or which typically uses it, e.g. 'adults'.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: