HS.FHIRModel.R4.EffectEvidenceSynthesis
class HS.FHIRModel.R4.EffectEvidenceSynthesis extends HS.FHIRModel.FHIRClassSuper
******************************************* EffectEvidenceSynthesis generated class schema
*****************************************
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.
Property Inventory
- _approvalDate
- _copyright
- _date
- _description
- _implicitRules
- _language
- _lastReviewDate
- _name
- _publisher
- _status
- _title
- _url
- _version
- approvalDate
- author
- certainty
- contact
- contained
- copyright
- date
- description
- editor
- effectEstimate
- effectivePeriod
- endorser
- exposure
- exposureAlternative
- extension
- fhirID
- identifier
- implicitRules
- jurisdiction
- language
- lastReviewDate
- meta
- modifierExtension
- name
- note
- outcome
- population
- publisher
- relatedArtifact
- resourceType
- resultsByExposure
- reviewer
- sampleSize
- status
- studyType
- synthesisType
- text
- title
- topic
- url
- useContext
- version
Method Inventory
- IncludeAuthor()
- IncludeCertainty()
- IncludeContact()
- IncludeContained()
- IncludeEditor()
- IncludeEffectEstimate()
- IncludeEffectivePeriod()
- IncludeEndorser()
- IncludeExposure()
- IncludeExposureAlternative()
- IncludeExtension()
- IncludeIdentifier()
- IncludeJurisdiction()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNote()
- IncludeOutcome()
- IncludePopulation()
- IncludeRelatedArtifact()
- IncludeResultsByExposure()
- IncludeReviewer()
- IncludeSampleSize()
- IncludeStudyType()
- IncludeSynthesisType()
- IncludeText()
- IncludeTopic()
- IncludeUseContext()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_EFFECTEVIDENCESYNTHESIS;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _approvalDate as HS.FHIRModel.R4.Element;
Extensions for approvalDate
Property methods: _approvalDateGet(), _approvalDateGetSwizzled(), _approvalDateIsValid(), _approvalDateNewObject(), _approvalDateSet()
property _copyright as HS.FHIRModel.R4.Element;
Extensions for copyright
Property methods: _copyrightGet(), _copyrightGetSwizzled(), _copyrightIsValid(), _copyrightNewObject(), _copyrightSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lastReviewDate as HS.FHIRModel.R4.Element;
Extensions for lastReviewDate
Property methods: _lastReviewDateGet(), _lastReviewDateGetSwizzled(), _lastReviewDateIsValid(), _lastReviewDateNewObject(), _lastReviewDateSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property approvalDate as %String;
The date on which the resource content was approved by the publisher.
Approval happens once when the content is officially approved for
usage.
Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
property author as HS.FHIRModel.R4.SeqOfContactDetail;
An individiual or organization primarily involved in the creation
and maintenance of the content.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property certainty as HS.FHIRModel.R4.EffectEvidenceSynthesisX.SeqOfEffectEvidenceSynthesisXCertainty;
A description of the certainty of the effect estimate.
Property methods: certaintyGet(), certaintyGetSwizzled(), certaintyIsValid(), certaintyNewObject(), certaintySet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with
the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property copyright as %String;
A copyright statement relating to the effect evidence synthesis and/or
its contents. Copyright statements are generally legal restrictions
on the use and publishing of the effect evidence synthesis.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String;
The date (and optionally time) when the effect evidence synthesis
was published. The date must change when the business version changes
and it must change if the status code changes. In addition, it should
change when the substantive content of the effect evidence synthesis
changes.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the effect evidence synthesis
from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property editor as HS.FHIRModel.R4.SeqOfContactDetail;
An individual or organization primarily responsible for internal
coherence of the content.
Property methods: editorGet(), editorGetSwizzled(), editorIsValid(), editorNewObject(), editorSet()
property effectEstimate as HS.FHIRModel.R4.EffectEvidenceSynthesisX.SeqOfEffectEvidenceSynthesisXEffectEstimate;
The estimated effect of the exposure variant.
Property methods: effectEstimateGet(), effectEstimateGetSwizzled(), effectEstimateIsValid(), effectEstimateNewObject(), effectEstimateSet()
property effectivePeriod as HS.FHIRModel.R4.Period;
The period during which the effect evidence synthesis content was
or is planned to be in active use.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property endorser as HS.FHIRModel.R4.SeqOfContactDetail;
An individual or organization responsible for officially endorsing
the content for use in some setting.
Property methods: endorserGet(), endorserGetSwizzled(), endorserIsValid(), endorserNewObject(), endorserSet()
property exposure as HS.FHIRModel.R4.Reference [ Required ];
A reference to a EvidenceVariable resource that defines the exposure
for the research.
Property methods: exposureGet(), exposureGetSwizzled(), exposureIsValid(), exposureNewObject(), exposureSet()
property exposureAlternative as HS.FHIRModel.R4.Reference [ Required ];
A reference to a EvidenceVariable resource that defines the comparison
exposure for the research.
Property methods: exposureAlternativeGet(), exposureAlternativeGetSwizzled(), exposureAlternativeIsValid(), exposureAlternativeNewObject(), exposureAlternativeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A formal identifier that is used to identify this effect evidence
synthesis when it is represented in other formats, or referenced
in a specification, model, design or an instance.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the effect evidence synthesis
is intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lastReviewDate as %String;
The date on which the resource content was last reviewed. Review
happens periodically after approval but does not change the original
approval date.
Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
A natural language name identifying the effect evidence synthesis.
This name should be usable as an identifier for the module by machine
processing applications such as code generation.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property note as HS.FHIRModel.R4.SeqOfAnnotation;
A human-readable string to clarify or explain concepts about the
resource.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property outcome as HS.FHIRModel.R4.Reference [ Required ];
A reference to a EvidenceVariable resomece that defines the outcome
for the research.
Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property population as HS.FHIRModel.R4.Reference [ Required ];
A reference to a EvidenceVariable resource that defines the population
for the research.
Property methods: populationGet(), populationGetSwizzled(), populationIsValid(), populationNewObject(), populationSet()
property publisher as %String;
The name of the organization or individual that published the effect
evidence synthesis.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
Related artifacts such as additional documentation, justification,
or bibliographic references.
Property methods: relatedArtifactGet(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactNewObject(), relatedArtifactSet()
property resourceType as %String [ InitialExpression = "EffectEvidenceSynthesis" , Required ];
This is a EffectEvidenceSynthesis resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property resultsByExposure as HS.FHIRModel.R4.EffectEvidenceSynthesisX.SeqOfEffectEvidenceSynthesisXResultsByExposure;
A description of the results for each exposure considered in the
effect estimate.
Property methods: resultsByExposureGet(), resultsByExposureGetSwizzled(), resultsByExposureIsValid(), resultsByExposureNewObject(), resultsByExposureSet()
property reviewer as HS.FHIRModel.R4.SeqOfContactDetail;
An individual or organization primarily responsible for review of
some aspect of the content.
Property methods: reviewerGet(), reviewerGetSwizzled(), reviewerIsValid(), reviewerNewObject(), reviewerSet()
property sampleSize as HS.FHIRModel.R4.EffectEvidenceSynthesisX.SampleSize;
A description of the size of the sample involved in the synthesis.
Property methods: sampleSizeGet(), sampleSizeGetSwizzled(), sampleSizeIsValid(), sampleSizeNewObject(), sampleSizeSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this effect evidence synthesis. Enables tracking the
life-cycle of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property studyType as HS.FHIRModel.R4.CodeableConcept;
Type of study eg randomized trial.
Property methods: studyTypeGet(), studyTypeGetSwizzled(), studyTypeIsValid(), studyTypeNewObject(), studyTypeSet()
property synthesisType as HS.FHIRModel.R4.CodeableConcept;
Type of synthesis eg meta-analysis.
Property methods: synthesisTypeGet(), synthesisTypeGetSwizzled(), synthesisTypeIsValid(), synthesisTypeNewObject(), synthesisTypeSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for the effect evidence
synthesis.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property topic as HS.FHIRModel.R4.SeqOfCodeableConcept;
Descriptive topics related to the content of the EffectEvidenceSynthesis.
Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss
that can be useful for filtering and searching.
Property methods: topicGet(), topicGetSwizzled(), topicIsValid(), topicNewObject(), topicSet()
property url as %String;
An absolute URI that is used to identify this effect evidence synthesis
when it is referenced in a specification, model, design or an instance;
also called its canonical identifier. This SHOULD be globally unique
and SHOULD be a literal address at which at which an authoritative
instance of this effect evidence synthesis is (or will be) published.
This URL can be the target of a canonical reference. It SHALL remain
the same when the effect evidence synthesis is stored on different
servers.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
The content was developed with a focus and intent of supporting the
contexts that are listed. These contexts may be general categories
(gender, age, ...) or may be references to specific programs (insurance
plans, studies, ...) and may be used to assist with indexing and
searching for appropriate effect evidence synthesis instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
The identifier that is used to identify this version of the effect
evidence synthesis when it is referenced in a specification, model,
design or instance. This is an arbitrary value managed by the effect
evidence synthesis author and is not expected to be globally unique.
For example, it might be a timestamp (e.g. yyyymmdd) if a managed
version is not available. There is also no expectation that versions
can be placed in a lexicographical sequence.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
Methods
method IncludeAuthor()
method IncludeCertainty()
method IncludeContact()
method IncludeContained()
method IncludeEditor()
method IncludeEffectEstimate()
method IncludeEffectivePeriod()
method IncludeEndorser()
method IncludeExposure()
method IncludeExposureAlternative()
method IncludeExtension()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOutcome()
method IncludePopulation()
method IncludeRelatedArtifact()
method IncludeResultsByExposure()
method IncludeReviewer()
method IncludeSampleSize()
method IncludeStudyType()
method IncludeSynthesisType()
method IncludeText()
method IncludeTopic()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.EffectEvidenceSynthesis
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()