Package com.ibm.fhir.model.resource
Class EffectEvidenceSynthesis
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.EffectEvidenceSynthesis
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class EffectEvidenceSynthesis extends DomainResource
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EffectEvidenceSynthesis.Builder
static class
EffectEvidenceSynthesis.Certainty
A description of the certainty of the effect estimate.static class
EffectEvidenceSynthesis.EffectEstimate
The estimated effect of the exposure variant.static class
EffectEvidenceSynthesis.ResultsByExposure
A description of the results for each exposure considered in the effect estimate.static class
EffectEvidenceSynthesis.SampleSize
A description of the size of the sample involved in the synthesis.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static EffectEvidenceSynthesis.Builder
builder()
boolean
equals(Object obj)
Date
getApprovalDate()
The date on which the resource content was approved by the publisher.List<ContactDetail>
getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.List<EffectEvidenceSynthesis.Certainty>
getCertainty()
A description of the certainty of the effect estimate.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the effect evidence synthesis and/or its contents.DateTime
getDate()
The date (and optionally time) when the effect evidence synthesis was published.Markdown
getDescription()
A free text natural language description of the effect evidence synthesis from a consumer's perspective.List<ContactDetail>
getEditor()
An individual or organization primarily responsible for internal coherence of the content.List<EffectEvidenceSynthesis.EffectEstimate>
getEffectEstimate()
The estimated effect of the exposure variant.Period
getEffectivePeriod()
The period during which the effect evidence synthesis content was or is planned to be in active use.List<ContactDetail>
getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.Reference
getExposure()
A reference to a EvidenceVariable resource that defines the exposure for the research.Reference
getExposureAlternative()
A reference to a EvidenceVariable resource that defines the comparison exposure for the research.List<Identifier>
getIdentifier()
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.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the effect evidence synthesis is intended to be used.Date
getLastReviewDate()
The date on which the resource content was last reviewed.String
getName()
A natural language name identifying the effect evidence synthesis.List<Annotation>
getNote()
A human-readable string to clarify or explain concepts about the resource.Reference
getOutcome()
A reference to a EvidenceVariable resomece that defines the outcome for the research.Reference
getPopulation()
A reference to a EvidenceVariable resource that defines the population for the research.String
getPublisher()
The name of the organization or individual that published the effect evidence synthesis.List<RelatedArtifact>
getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.List<EffectEvidenceSynthesis.ResultsByExposure>
getResultsByExposure()
A description of the results for each exposure considered in the effect estimate.List<ContactDetail>
getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.EffectEvidenceSynthesis.SampleSize
getSampleSize()
A description of the size of the sample involved in the synthesis.PublicationStatus
getStatus()
The status of this effect evidence synthesis.CodeableConcept
getStudyType()
Type of study eg randomized trial.CodeableConcept
getSynthesisType()
Type of synthesis eg meta-analysis.String
getTitle()
A short, descriptive, user-friendly title for the effect evidence synthesis.List<CodeableConcept>
getTopic()
Descriptive topics related to the content of the EffectEvidenceSynthesis.Uri
getUrl()
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.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.String
getVersion()
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.boolean
hasChildren()
int
hashCode()
EffectEvidenceSynthesis.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getUrl
public Uri getUrl()
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.- Returns:
- An immutable object of type
Uri
that may be null.
-
getIdentifier
public List<Identifier> getIdentifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getVersion
public String getVersion()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getName
public String getName()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for the effect evidence synthesis.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getDate
public DateTime getDate()
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.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the effect evidence synthesis.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public List<ContactDetail> getContact()
Contact details to assist a user in finding and communicating with the publisher.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getDescription
public Markdown getDescription()
A free text natural language description of the effect evidence synthesis from a consumer's perspective.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getNote
public List<Annotation> getNote()
A human-readable string to clarify or explain concepts about the resource.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getUseContext
public List<UsageContext> getUseContext()
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.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
A legal or geographic region in which the effect evidence synthesis is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCopyright
public Markdown getCopyright()
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.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getApprovalDate
public Date getApprovalDate()
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.- Returns:
- An immutable object of type
Date
that may be null.
-
getLastReviewDate
public Date getLastReviewDate()
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.- Returns:
- An immutable object of type
Date
that may be null.
-
getEffectivePeriod
public Period getEffectivePeriod()
The period during which the effect evidence synthesis content was or is planned to be in active use.- Returns:
- An immutable object of type
Period
that may be null.
-
getTopic
public List<CodeableConcept> getTopic()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getAuthor
public List<ContactDetail> getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEditor
public List<ContactDetail> getEditor()
An individual or organization primarily responsible for internal coherence of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getReviewer
public List<ContactDetail> getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEndorser
public List<ContactDetail> getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifact
that may be empty.
-
getSynthesisType
public CodeableConcept getSynthesisType()
Type of synthesis eg meta-analysis.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStudyType
public CodeableConcept getStudyType()
Type of study eg randomized trial.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getPopulation
public Reference getPopulation()
A reference to a EvidenceVariable resource that defines the population for the research.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getExposure
public Reference getExposure()
A reference to a EvidenceVariable resource that defines the exposure for the research.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getExposureAlternative
public Reference getExposureAlternative()
A reference to a EvidenceVariable resource that defines the comparison exposure for the research.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getOutcome
public Reference getOutcome()
A reference to a EvidenceVariable resomece that defines the outcome for the research.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getSampleSize
public EffectEvidenceSynthesis.SampleSize getSampleSize()
A description of the size of the sample involved in the synthesis.- Returns:
- An immutable object of type
EffectEvidenceSynthesis.SampleSize
that may be null.
-
getResultsByExposure
public List<EffectEvidenceSynthesis.ResultsByExposure> getResultsByExposure()
A description of the results for each exposure considered in the effect estimate.- Returns:
- An unmodifiable list containing immutable objects of type
EffectEvidenceSynthesis.ResultsByExposure
that may be empty.
-
getEffectEstimate
public List<EffectEvidenceSynthesis.EffectEstimate> getEffectEstimate()
The estimated effect of the exposure variant.- Returns:
- An unmodifiable list containing immutable objects of type
EffectEvidenceSynthesis.EffectEstimate
that may be empty.
-
getCertainty
public List<EffectEvidenceSynthesis.Certainty> getCertainty()
A description of the certainty of the effect estimate.- Returns:
- An unmodifiable list containing immutable objects of type
EffectEvidenceSynthesis.Certainty
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public EffectEvidenceSynthesis.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static EffectEvidenceSynthesis.Builder builder()
-
-