Package org.linuxforhealth.fhir.model.resource

Class EvidenceVariable

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class EvidenceVariable
extends DomainResource
    The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this evidence variable 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 evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable 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 evidence variable 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 evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        A natural language name identifying the evidence variable. 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 evidence variable.
        Returns:
        An immutable object of type String that may be null.

      • getShortTitle

        public String getShortTitle()
        The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
        Returns:
        An immutable object of type String that may be null.

      • getSubtitle

        public String getSubtitle()
        An explanatory or alternate title for the EvidenceVariable giving additional information about its content.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this evidence variable. 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 evidence variable 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 evidence variable changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the evidence variable from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getNote

        public java.util.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 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 variable instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the evidence variable.
        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 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 java.util.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 java.util.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 java.util.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 java.util.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.

      • getActual

        public Boolean getActual()
        True if the actual variable measured, false if a conceptual representation of the intended variable.
        Returns:
        An immutable object of type Boolean that may be null.

      • getCharacteristicCombination

        public CharacteristicCombination getCharacteristicCombination()
        Used to specify if two or more characteristics are combined with OR or AND.
        Returns:
        An immutable object of type CharacteristicCombination that may be null.

      • getCharacteristic

        public java.util.List<EvidenceVariable.Characteristic> getCharacteristic()
        A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.
        Returns:
        An unmodifiable list containing immutable objects of type EvidenceVariable.Characteristic that may be empty.

      • getCategory

        public java.util.List<EvidenceVariable.Category> getCategory()
        A grouping (or set of values) described along with other groupings to specify the set of groupings allowed for the variable.
        Returns:
        An unmodifiable list containing immutable objects of type EvidenceVariable.Category that may be empty.

      • 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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object