Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.EffectEvidenceSynthesis

class HS.FHIR.DTL.vR4.Model.Resource.EffectEvidenceSynthesis extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A quantified estimate of effect based on a body of evidence.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = EffectEvidenceSynthesis;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 %String (MAXLEN = 1000000, XMLNAME = "approvalDate", XMLPROJECTION = "ATTRIBUTE");
date

When the effect evidence synthesis was approved by publisher.

Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
property author as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
ContactDetail

Who authored the content.

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property certainty as list of HS.FHIR.DTL.vR4.Model.Element.EffectEvidenceSynthesis.certainty (XMLNAME = "certainty", XMLPROJECTION = "ELEMENT");
BackboneElement

How certain is the effect.

Property methods: certaintyBuildValueArray(), certaintyCollectionToDisplay(), certaintyCollectionToOdbc(), certaintyDisplayToCollection(), certaintyGet(), certaintyGetObject(), certaintyGetObjectId(), certaintyGetSwizzled(), certaintyIsValid(), certaintyOdbcToCollection(), certaintySet(), certaintySetObject(), certaintySetObjectId()
property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
markdown

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the effect evidence synthesis.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property editor as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "editor", XMLPROJECTION = "ELEMENT");
ContactDetail

Who edited the content.

Property methods: editorBuildValueArray(), editorCollectionToDisplay(), editorCollectionToOdbc(), editorDisplayToCollection(), editorGet(), editorGetObject(), editorGetObjectId(), editorGetSwizzled(), editorIsValid(), editorOdbcToCollection(), editorSet(), editorSetObject(), editorSetObjectId()
property effectEstimate as list of HS.FHIR.DTL.vR4.Model.Element.EffectEvidenceSynthesis.effectEstimate (XMLNAME = "effectEstimate", XMLPROJECTION = "ELEMENT");
BackboneElement

What was the estimated effect.

Property methods: effectEstimateBuildValueArray(), effectEstimateCollectionToDisplay(), effectEstimateCollectionToOdbc(), effectEstimateDisplayToCollection(), effectEstimateGet(), effectEstimateGetObject(), effectEstimateGetObjectId(), effectEstimateGetSwizzled(), effectEstimateIsValid(), effectEstimateOdbcToCollection(), effectEstimateSet(), effectEstimateSetObject(), effectEstimateSetObjectId()
property effectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Period

When the effect evidence synthesis is expected to be used.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property endorser as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "endorser", XMLPROJECTION = "ELEMENT");
ContactDetail

Who endorsed the content.

Property methods: endorserBuildValueArray(), endorserCollectionToDisplay(), endorserCollectionToOdbc(), endorserDisplayToCollection(), endorserGet(), endorserGetObject(), endorserGetObjectId(), endorserGetSwizzled(), endorserIsValid(), endorserOdbcToCollection(), endorserSet(), endorserSetObject(), endorserSetObjectId()
property exposure as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "exposure", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

What exposure?

EvidenceVariable

Property methods: exposureGet(), exposureGetSwizzled(), exposureIsValid(), exposureNewObject(), exposureSet()
property exposureAlternative as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "exposureAlternative", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

What comparison exposure?

EvidenceVariable

Property methods: exposureAlternativeGet(), exposureAlternativeGetSwizzled(), exposureAlternativeIsValid(), exposureAlternativeNewObject(), exposureAlternativeSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Additional identifier for the effect evidence synthesis.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for effect evidence synthesis (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property lastReviewDate as %String (MAXLEN = 1000000, XMLNAME = "lastReviewDate", XMLPROJECTION = "ATTRIBUTE");
date

When the effect evidence synthesis was last reviewed.

Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Name for this effect evidence synthesis (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Used for footnotes or explanatory notes.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property outcome as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

What outcome?

EvidenceVariable

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property population as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "population", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

What population?

EvidenceVariable

Property methods: populationGet(), populationGetSwizzled(), populationIsValid(), populationNewObject(), populationSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property relatedArtifact as list of HS.FHIR.DTL.vR4.Model.Datatype.RelatedArtifact (XMLNAME = "relatedArtifact", XMLPROJECTION = "ELEMENT");
RelatedArtifact

Additional documentation, citations, etc.

Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()
property resultsByExposure as list of HS.FHIR.DTL.vR4.Model.Element.EffectEvidenceSynthesis.resultsByExposure (XMLNAME = "resultsByExposure", XMLPROJECTION = "ELEMENT");
BackboneElement

What was the result per exposure?

Property methods: resultsByExposureBuildValueArray(), resultsByExposureCollectionToDisplay(), resultsByExposureCollectionToOdbc(), resultsByExposureDisplayToCollection(), resultsByExposureGet(), resultsByExposureGetObject(), resultsByExposureGetObjectId(), resultsByExposureGetSwizzled(), resultsByExposureIsValid(), resultsByExposureOdbcToCollection(), resultsByExposureSet(), resultsByExposureSetObject(), resultsByExposureSetObjectId()
property reviewer as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "reviewer", XMLPROJECTION = "ELEMENT");
ContactDetail

Who reviewed the content.

Property methods: reviewerBuildValueArray(), reviewerCollectionToDisplay(), reviewerCollectionToOdbc(), reviewerDisplayToCollection(), reviewerGet(), reviewerGetObject(), reviewerGetObjectId(), reviewerGetSwizzled(), reviewerIsValid(), reviewerOdbcToCollection(), reviewerSet(), reviewerSetObject(), reviewerSetObjectId()
property sampleSize as HS.FHIR.DTL.vR4.Model.Element.EffectEvidenceSynthesis.sampleSize (XMLNAME = "sampleSize", XMLPROJECTION = "ELEMENT");
BackboneElement

What sample size was involved?

Property methods: sampleSizeGet(), sampleSizeGetSwizzled(), sampleSizeIsValid(), sampleSizeNewObject(), sampleSizeSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property studyType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "studyType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of study.

study-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in study-type, you may formally EXTEND study-type to add codes to it.

Property methods: studyTypeGet(), studyTypeGetSwizzled(), studyTypeIsValid(), studyTypeNewObject(), studyTypeSet()
property synthesisType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "synthesisType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of synthesis.

synthesis-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in synthesis-type, you may formally EXTEND synthesis-type to add codes to it.

Property methods: synthesisTypeGet(), synthesisTypeGetSwizzled(), synthesisTypeIsValid(), synthesisTypeNewObject(), synthesisTypeSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Name for this effect evidence synthesis (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property topic as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "topic", XMLPROJECTION = "ELEMENT");
CodeableConcept

The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.

any FHIR4 code may be used; definition-topic shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the effect evidence synthesis.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab