Package com.ibm.fhir.model.resource

Class ResearchElementDefinition

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class ResearchElementDefinition
extends DomainResource
    The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this research element definition 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 research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition 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 research element definition 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 research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition 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 research element definition. 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 research element definition.
        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 ResearchElementDefinition 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 research element definition. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getSubject

        public Element getSubject()
        The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.
        Returns:
        An immutable object of type CodeableConcept or Reference that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the research element definition 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 research element definition 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 research element definition.
        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.

      • getDescription

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

      • getComment

        public java.util.List<String> getComment()
        A human-readable string to clarify or explain concepts about the resource.
        Returns:
        An unmodifiable list containing immutable objects of type String 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 research element definition instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the research element definition is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this research element definition is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUsage

        public String getUsage()
        A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.
        Returns:
        An immutable object of type String that may be null.

      • getCopyright

        public Markdown getCopyright()
        A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.
        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 research element definition content was or is planned to be in active use.
        Returns:
        An immutable object of type Period that may be null.

      • getTopic

        public java.util.List<CodeableConcept> getTopic()
        Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept 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.

      • getLibrary

        public java.util.List<Canonical> getLibrary()
        A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getType

        public ResearchElementType getType()
        The type of research element, a population, an exposure, or an outcome.
        Returns:
        An immutable object of type ResearchElementType that is non-null.

      • getVariableType

        public VariableType getVariableType()
        The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).
        Returns:
        An immutable object of type VariableType that may be null.

      • 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