364 lines
12 KiB
PHP
364 lines
12 KiB
PHP
<?php
|
|
|
|
namespace Spatie\SchemaOrg;
|
|
|
|
use Spatie\SchemaOrg\Contracts\MedicalCauseContract;
|
|
use Spatie\SchemaOrg\Contracts\MedicalEntityContract;
|
|
use Spatie\SchemaOrg\Contracts\ThingContract;
|
|
|
|
/**
|
|
* The causative agent(s) that are responsible for the pathophysiologic process
|
|
* that eventually results in a medical condition, symptom or sign. In this
|
|
* schema, unless otherwise specified this is meant to be the proximate cause of
|
|
* the medical condition, symptom or sign. The proximate cause is defined as the
|
|
* causative agent that most directly results in the medical condition, symptom
|
|
* or sign. For example, the HIV virus could be considered a cause of AIDS. Or
|
|
* in a diagnostic context, if a patient fell and sustained a hip fracture and
|
|
* two days later sustained a pulmonary embolism which eventuated in a cardiac
|
|
* arrest, the cause of the cardiac arrest (the proximate cause) would be the
|
|
* pulmonary embolism and not the fall. Medical causes can include
|
|
* cardiovascular, chemical, dermatologic, endocrine, environmental,
|
|
* gastroenterologic, genetic, hematologic, gynecologic, iatrogenic, infectious,
|
|
* musculoskeletal, neurologic, nutritional, obstetric, oncologic,
|
|
* otolaryngologic, pharmacologic, psychiatric, pulmonary, renal, rheumatologic,
|
|
* toxic, traumatic, or urologic causes; medical conditions can be causes as
|
|
* well.
|
|
*
|
|
* @see https://schema.org/MedicalCause
|
|
* @see https://health-lifesci.schema.org
|
|
*
|
|
*/
|
|
class MedicalCause extends BaseType implements MedicalCauseContract, MedicalEntityContract, ThingContract
|
|
{
|
|
/**
|
|
* 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.
|
|
* Typically the value is a URI-identified RDF class, and in this case
|
|
* corresponds to the
|
|
* use of rdf:type in RDF. Text values can be used sparingly, for cases
|
|
* where useful information can be added without their being an appropriate
|
|
* schema to reference. In the case of text values, the class label should
|
|
* follow the schema.org [style
|
|
* guide](https://schema.org/docs/styleguide.html).
|
|
*
|
|
* @param string|string[] $additionalType
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/additionalType
|
|
*/
|
|
public function additionalType($additionalType)
|
|
{
|
|
return $this->setProperty('additionalType', $additionalType);
|
|
}
|
|
|
|
/**
|
|
* An alias for the item.
|
|
*
|
|
* @param string|string[] $alternateName
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/alternateName
|
|
*/
|
|
public function alternateName($alternateName)
|
|
{
|
|
return $this->setProperty('alternateName', $alternateName);
|
|
}
|
|
|
|
/**
|
|
* The condition, complication, symptom, sign, etc. caused.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicalEntityContract|\Spatie\SchemaOrg\Contracts\MedicalEntityContract[] $causeOf
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/causeOf
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function causeOf($causeOf)
|
|
{
|
|
return $this->setProperty('causeOf', $causeOf);
|
|
}
|
|
|
|
/**
|
|
* A medical code for the entity, taken from a controlled vocabulary or
|
|
* ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicalCodeContract|\Spatie\SchemaOrg\Contracts\MedicalCodeContract[] $code
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/code
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function code($code)
|
|
{
|
|
return $this->setProperty('code', $code);
|
|
}
|
|
|
|
/**
|
|
* A description of the item.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\TextObjectContract|\Spatie\SchemaOrg\Contracts\TextObjectContract[]|string|string[] $description
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/description
|
|
*/
|
|
public function description($description)
|
|
{
|
|
return $this->setProperty('description', $description);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param string|string[] $disambiguatingDescription
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/disambiguatingDescription
|
|
*/
|
|
public function disambiguatingDescription($disambiguatingDescription)
|
|
{
|
|
return $this->setProperty('disambiguatingDescription', $disambiguatingDescription);
|
|
}
|
|
|
|
/**
|
|
* A [[Grant]] that directly or indirectly provide funding or sponsorship
|
|
* for this item. See also [[ownershipFundingInfo]].
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\GrantContract|\Spatie\SchemaOrg\Contracts\GrantContract[] $funding
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/funding
|
|
* @see https://pending.schema.org
|
|
* @link https://github.com/schemaorg/schemaorg/issues/383
|
|
*/
|
|
public function funding($funding)
|
|
{
|
|
return $this->setProperty('funding', $funding);
|
|
}
|
|
|
|
/**
|
|
* A medical guideline related to this entity.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicalGuidelineContract|\Spatie\SchemaOrg\Contracts\MedicalGuidelineContract[] $guideline
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/guideline
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function guideline($guideline)
|
|
{
|
|
return $this->setProperty('guideline', $guideline);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/identifier
|
|
*/
|
|
public function identifier($identifier)
|
|
{
|
|
return $this->setProperty('identifier', $identifier);
|
|
}
|
|
|
|
/**
|
|
* An image of the item. This can be a [[URL]] or a fully described
|
|
* [[ImageObject]].
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/image
|
|
*/
|
|
public function image($image)
|
|
{
|
|
return $this->setProperty('image', $image);
|
|
}
|
|
|
|
/**
|
|
* The drug or supplement's legal status, including any controlled substance
|
|
* schedules that apply.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\DrugLegalStatusContract|\Spatie\SchemaOrg\Contracts\DrugLegalStatusContract[]|\Spatie\SchemaOrg\Contracts\MedicalEnumerationContract|\Spatie\SchemaOrg\Contracts\MedicalEnumerationContract[]|string|string[] $legalStatus
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/legalStatus
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function legalStatus($legalStatus)
|
|
{
|
|
return $this->setProperty('legalStatus', $legalStatus);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/mainEntityOfPage
|
|
*/
|
|
public function mainEntityOfPage($mainEntityOfPage)
|
|
{
|
|
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
|
|
}
|
|
|
|
/**
|
|
* The system of medicine that includes this MedicalEntity, for example
|
|
* 'evidence-based', 'homeopathic', 'chiropractic', etc.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicineSystemContract|\Spatie\SchemaOrg\Contracts\MedicineSystemContract[] $medicineSystem
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/medicineSystem
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function medicineSystem($medicineSystem)
|
|
{
|
|
return $this->setProperty('medicineSystem', $medicineSystem);
|
|
}
|
|
|
|
/**
|
|
* The name of the item.
|
|
*
|
|
* @param string|string[] $name
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/name
|
|
*/
|
|
public function name($name)
|
|
{
|
|
return $this->setProperty('name', $name);
|
|
}
|
|
|
|
/**
|
|
* Indicates a potential Action, which describes an idealized action in
|
|
* which this thing would play an 'object' role.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/potentialAction
|
|
*/
|
|
public function potentialAction($potentialAction)
|
|
{
|
|
return $this->setProperty('potentialAction', $potentialAction);
|
|
}
|
|
|
|
/**
|
|
* If applicable, the organization that officially recognizes this entity as
|
|
* part of its endorsed system of medicine.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $recognizingAuthority
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/recognizingAuthority
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function recognizingAuthority($recognizingAuthority)
|
|
{
|
|
return $this->setProperty('recognizingAuthority', $recognizingAuthority);
|
|
}
|
|
|
|
/**
|
|
* If applicable, a medical specialty in which this entity is relevant.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicalSpecialtyContract|\Spatie\SchemaOrg\Contracts\MedicalSpecialtyContract[] $relevantSpecialty
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/relevantSpecialty
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function relevantSpecialty($relevantSpecialty)
|
|
{
|
|
return $this->setProperty('relevantSpecialty', $relevantSpecialty);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param string|string[] $sameAs
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/sameAs
|
|
*/
|
|
public function sameAs($sameAs)
|
|
{
|
|
return $this->setProperty('sameAs', $sameAs);
|
|
}
|
|
|
|
/**
|
|
* A medical study or trial related to this entity.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\MedicalStudyContract|\Spatie\SchemaOrg\Contracts\MedicalStudyContract[] $study
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/study
|
|
* @see https://health-lifesci.schema.org
|
|
*/
|
|
public function study($study)
|
|
{
|
|
return $this->setProperty('study', $study);
|
|
}
|
|
|
|
/**
|
|
* A CreativeWork or Event about this Thing.
|
|
*
|
|
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/subjectOf
|
|
* @link https://github.com/schemaorg/schemaorg/issues/1670
|
|
*/
|
|
public function subjectOf($subjectOf)
|
|
{
|
|
return $this->setProperty('subjectOf', $subjectOf);
|
|
}
|
|
|
|
/**
|
|
* URL of the item.
|
|
*
|
|
* @param string|string[] $url
|
|
*
|
|
* @return static
|
|
*
|
|
* @see https://schema.org/url
|
|
*/
|
|
public function url($url)
|
|
{
|
|
return $this->setProperty('url', $url);
|
|
}
|
|
}
|