Class Evidence
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Evidence
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class Evidence extends DomainResource
The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Evidence.Builder
static class
Evidence.Certainty
Assessment of certainty, confidence in the estimates, or quality of the evidence.static class
Evidence.Statistic
Values and parameters for a single statistic.static class
Evidence.VariableDefinition
Evidence variable such as population, exposure, or outcome.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Evidence.Builder
builder()
boolean
equals(java.lang.Object obj)
Date
getApprovalDate()
The date on which the resource content was approved by the publisher.Markdown
getAssertion()
Declarative description of the Evidence.java.util.List<ContactDetail>
getAuthor()
An individiual, organization, or device primarily involved in the creation and maintenance of the content.java.util.List<Evidence.Certainty>
getCertainty()
Assessment of certainty, confidence in the estimates, or quality of the evidence.Element
getCiteAs()
Citation Resource or display of suggested citation for this evidence.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.DateTime
getDate()
The date (and optionally time) when the summary was published.Markdown
getDescription()
A free text natural language description of the evidence from a consumer's perspective.java.util.List<ContactDetail>
getEditor()
An individiual, organization, or device primarily responsible for internal coherence of the content.java.util.List<ContactDetail>
getEndorser()
An individiual, organization, or device responsible for officially endorsing the content for use in some setting.java.util.List<Identifier>
getIdentifier()
A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance.Date
getLastReviewDate()
The date on which the resource content was last reviewed.java.util.List<Annotation>
getNote()
Footnotes and/or explanatory notes.String
getPublisher()
The name of the organization or individual that published the evidence.java.util.List<RelatedArtifact>
getRelatedArtifact()
Link or citation to artifact associated with the summary.java.util.List<ContactDetail>
getReviewer()
An individiual, organization, or device primarily responsible for review of some aspect of the content.java.util.List<Evidence.Statistic>
getStatistic()
Values and parameters for a single statistic.PublicationStatus
getStatus()
The status of this summary.CodeableConcept
getStudyType()
The type of study that produced this evidence.CodeableConcept
getSynthesisType()
The method to combine studies.String
getTitle()
A short, descriptive, user-friendly title for the summary.Uri
getUrl()
An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.java.util.List<Evidence.VariableDefinition>
getVariableDefinition()
Evidence variable such as population, exposure, or outcome.String
getVersion()
The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
Evidence.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.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 evidence 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 summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.- Returns:
- An immutable object of type
Uri
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
A formal identifier that is used to identify this summary 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 summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary 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.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for the summary.- Returns:
- An immutable object of type
String
that may be null.
-
getCiteAs
public Element getCiteAs()
Citation Resource or display of suggested citation for this evidence.
-
getStatus
public PublicationStatus getStatus()
The status of this summary. 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 summary 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 summary changes.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getUseContext
public java.util.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 evidence instances.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
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.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the evidence.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public java.util.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.
-
getAuthor
public java.util.List<ContactDetail> getAuthor()
An individiual, organization, or device 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 java.util.List<ContactDetail> getEditor()
An individiual, organization, or device primarily responsible for internal coherence of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getReviewer
public java.util.List<ContactDetail> getReviewer()
An individiual, organization, or device 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 java.util.List<ContactDetail> getEndorser()
An individiual, organization, or device 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 java.util.List<RelatedArtifact> getRelatedArtifact()
Link or citation to artifact associated with the summary.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifact
that may be empty.
-
getDescription
public Markdown getDescription()
A free text natural language description of the evidence from a consumer's perspective.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getAssertion
public Markdown getAssertion()
Declarative description of the Evidence.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getNote
public java.util.List<Annotation> getNote()
Footnotes and/or explanatory notes.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getVariableDefinition
public java.util.List<Evidence.VariableDefinition> getVariableDefinition()
Evidence variable such as population, exposure, or outcome.- Returns:
- An unmodifiable list containing immutable objects of type
Evidence.VariableDefinition
that is non-empty.
-
getSynthesisType
public CodeableConcept getSynthesisType()
The method to combine studies.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStudyType
public CodeableConcept getStudyType()
The type of study that produced this evidence.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStatistic
public java.util.List<Evidence.Statistic> getStatistic()
Values and parameters for a single statistic.- Returns:
- An unmodifiable list containing immutable objects of type
Evidence.Statistic
that may be empty.
-
getCertainty
public java.util.List<Evidence.Certainty> getCertainty()
Assessment of certainty, confidence in the estimates, or quality of the evidence.- Returns:
- An unmodifiable list containing immutable objects of type
Evidence.Certainty
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Evidence.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 Evidence.Builder builder()
-
-