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

View Source

A medical study is an umbrella type covering all kinds of research studies relating to human medicine or health, including observational studies and interventional trials and registries, randomized, controlled or not. When the specific type of study is known, use one of the extensions of this type, such as MedicalTrial or MedicalObservationalStudy. Also, note that this type should be used to mark up data that describes the study itself; to tag an article that publishes the results of a study, use MedicalScholarlyArticle. Note: use the code property of MedicalEntity to store study IDs, e.g. clinicaltrials.gov ID.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:health_condition) => SEO.JSONLD.MedicalCondition.t() | map(),
    optional(:sponsor) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:status) =>
      :event_cancelled
      | :event_moved_online
      | :event_postponed
      | :event_rescheduled
      | :event_scheduled
      | :active_not_recruiting
      | :completed
      | :enrolling_by_invitation
      | :not_yet_recruiting
      | :recruiting
      | :results_available
      | :results_not_available
      | :suspended
      | :terminated
      | :withdrawn
      | String.t(),
    optional(:study_location) => SEO.JSONLD.AdministrativeArea.t() | map(),
    optional(:study_subject) => SEO.JSONLD.MedicalEntity.t() | map(),
    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) => 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()
  }
  | [
      health_condition: SEO.JSONLD.MedicalCondition.t() | map(),
      sponsor: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      status:
        :event_cancelled
        | :event_moved_online
        | :event_postponed
        | :event_rescheduled
        | :event_scheduled
        | :active_not_recruiting
        | :completed
        | :enrolling_by_invitation
        | :not_yet_recruiting
        | :recruiting
        | :results_available
        | :results_not_available
        | :suspended
        | :terminated
        | :withdrawn
        | String.t(),
      study_location: SEO.JSONLD.AdministrativeArea.t() | map(),
      study_subject: SEO.JSONLD.MedicalEntity.t() | map(),
      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: 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()}

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

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

Build a MedicalStudy JSON-LD map.

Fields

  • :health_condition - Specifying the health condition(s) of a patient, medical study, or other target audience.
  • :sponsor - A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
  • :status - The status of the study (enumerated). One of: :active_not_recruiting, :completed, :enrolling_by_invitation, :event_cancelled, :event_moved_online, :event_postponed, :event_rescheduled, :event_scheduled, :not_yet_recruiting, :recruiting, :results_available, :results_not_available, :suspended, :terminated, :withdrawn.
  • :study_location - The location in which the study is taking/took place.
  • :study_subject - A subject of the study, i.e. one of the medical conditions, therapies, devices, drugs, etc. investigated by the study.

Inherited properties

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