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

The cost per unit of a medical drug. Note that this type is not meant to represent the price in an offer of a drug for sale; see the Offer type for that. This type will typically be used to tag wholesale or average retail cost of a drug, or maximum reimbursable cost. Costs of medical drugs vary widely depending on how and where they are paid for, so while this type captures some of the variables, costs should be used with caution by consumers of this schema's markup.

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

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "DrugCost", 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 DrugCost JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:applicable_location) => SEO.JSONLD.AdministrativeArea.t() | map(),
    optional(:cost_category) => :reimbursement_cap | :retail | :wholesale,
    optional(:cost_currency) => String.t(),
    optional(:cost_origin) => String.t(),
    optional(:cost_per_unit) =>
      :all_wheel_drive_configuration
      | :four_wheel_drive_configuration
      | :front_wheel_drive_configuration
      | :left_hand_driving
      | :rear_wheel_drive_configuration
      | :right_hand_driving
      | String.t()
      | number(),
    optional(:drug_unit) => String.t(),
    optional(:code) => SEO.JSONLD.MedicalCode.t() | map(),
    optional(:funding) => SEO.JSONLD.Grant.t() | map(),
    optional(:guideline) => SEO.JSONLD.MedicalGuideline.t() | map(),
    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(: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(),
    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()
  }
  | [
      applicable_location: SEO.JSONLD.AdministrativeArea.t() | map(),
      cost_category: :reimbursement_cap | :retail | :wholesale,
      cost_currency: String.t(),
      cost_origin: String.t(),
      cost_per_unit:
        :all_wheel_drive_configuration
        | :four_wheel_drive_configuration
        | :front_wheel_drive_configuration
        | :left_hand_driving
        | :rear_wheel_drive_configuration
        | :right_hand_driving
        | String.t()
        | number(),
      drug_unit: String.t(),
      code: SEO.JSONLD.MedicalCode.t() | map(),
      funding: SEO.JSONLD.Grant.t() | map(),
      guideline: SEO.JSONLD.MedicalGuideline.t() | map(),
      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(),
      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(),
      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()
    ]

t()

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

Functions

build(attrs)

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

Build a DrugCost JSON-LD map.

Fields

:applicable_location - The location in which the status applies.
:cost_category - The category of cost, such as wholesale, retail, reimbursement cap, etc. One of: :reimbursement_cap, :retail, :wholesale.
:cost_currency - The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.
:cost_origin - Additional details to capture the origin of the cost data. For example, 'Medicare Part B'.
:cost_per_unit - The cost per unit of the drug. One of: :all_wheel_drive_configuration, :four_wheel_drive_configuration, :front_wheel_drive_configuration, :left_hand_driving, :rear_wheel_drive_configuration, :right_hand_driving.
:drug_unit - The unit in which the drug is measured, e.g. '5 mg tablet'.

Inherited properties

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