Package com.ibm.fhir.model.resource

Class ResearchStudy

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class ResearchStudy
extends DomainResource
    A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Identifiers assigned to this research study by the sponsor or other systems.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getTitle

        public String getTitle()
        A short, descriptive user-friendly label for the study.
        Returns:
        An immutable object of type String that may be null.

      • getProtocol

        public List<Reference> getProtocol()
        The set of steps expected to be performed as part of the execution of the study.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPartOf

        public List<Reference> getPartOf()
        A larger research study of which this particular study is a component or step.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPrimaryPurposeType

        public CodeableConcept getPrimaryPurposeType()
        The type of study based upon the intent of the study's activities. A classification of the intent of the study.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getPhase

        public CodeableConcept getPhase()
        The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getCategory

        public List<CodeableConcept> getCategory()
        Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getFocus

        public List<CodeableConcept> getFocus()
        The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getCondition

        public List<CodeableConcept> getCondition()
        The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getContact

        public List<ContactDetail> getContact()
        Contact details to assist a user in learning more about or engaging with the study.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getRelatedArtifact

        public List<RelatedArtifact> getRelatedArtifact()
        Citations, references and other related documents.
        Returns:
        An unmodifiable list containing immutable objects of type RelatedArtifact that may be empty.

      • getKeyword

        public List<CodeableConcept> getKeyword()
        Key terms to aid in searching for or filtering the study.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getLocation

        public List<CodeableConcept> getLocation()
        Indicates a country, state or other region where the study is taking place.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getDescription

        public Markdown getDescription()
        A full description of how the study is being conducted.
        Returns:
        An immutable object of type Markdown that may be null.

      • getEnrollment

        public List<Reference> getEnrollment()
        Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPeriod

        public Period getPeriod()
        Identifies the start date and the expected (or actual, depending on status) end date for the study.
        Returns:
        An immutable object of type Period that may be null.

      • getSponsor

        public Reference getSponsor()
        An organization that initiates the investigation and is legally responsible for the study.
        Returns:
        An immutable object of type Reference that may be null.

      • getPrincipalInvestigator

        public Reference getPrincipalInvestigator()
        A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
        Returns:
        An immutable object of type Reference that may be null.

      • getSite

        public List<Reference> getSite()
        A facility in which study activities are conducted.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getReasonStopped

        public CodeableConcept getReasonStopped()
        A description and/or code explaining the premature termination of the study.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getNote

        public List<Annotation> getNote()
        Comments made about the study by the performer, subject or other participants.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getArm

        public List<ResearchStudy.Arm> getArm()
        Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
        Returns:
        An unmodifiable list containing immutable objects of type ResearchStudy.Arm that may be empty.

      • getObjective

        public List<ResearchStudy.Objective> getObjective()
        A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.
        Returns:
        An unmodifiable list containing immutable objects of type ResearchStudy.Objective that may be empty.

      • 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 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object