Package com.ibm.fhir.model.resource

Class ResearchSubject

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.ResearchSubject

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class ResearchSubject
extends DomainResource

A physical entity which is the primary unit of operational and/or administrative interest in a study.

Maturity level: FMM1 (Trial Use)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResearchSubject.Builder

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

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static ResearchSubject.Builder	builder()
boolean	equals(Object obj)
String	getActualArm()	The name of the arm in the study the subject actually followed as part of this study.
String	getAssignedArm()	The name of the arm in the study the subject is expected to follow as part of this study.
Reference	getConsent()	A record of the patient's informed agreement to participate in the study.
List<Identifier>	getIdentifier()	Identifiers assigned to this research subject for a study.
Reference	getIndividual()	The record of the person or animal who is involved in the study.
Period	getPeriod()	The dates the subject began and ended their participation in the study.
ResearchSubjectStatus	getStatus()	The current state of the subject.
Reference	getStudy()	Reference to the study the subject is participating in.
boolean	hasChildren()
int	hashCode()
ResearchSubject.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

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Identifiers assigned to this research subject for a study.

Returns:

An unmodifiable list containing immutable objects of type Identifier that may be empty.

getStatus

public ResearchSubjectStatus getStatus()

The current state of the subject.

Returns:

An immutable object of type ResearchSubjectStatus that is non-null.

getPeriod

public Period getPeriod()

The dates the subject began and ended their participation in the study.

Returns:

An immutable object of type Period that may be null.

getStudy

public Reference getStudy()

Reference to the study the subject is participating in.

Returns:

An immutable object of type Reference that is non-null.

getIndividual

public Reference getIndividual()

The record of the person or animal who is involved in the study.

Returns:

An immutable object of type Reference that is non-null.

getAssignedArm

public String getAssignedArm()

The name of the arm in the study the subject is expected to follow as part of this study.

Returns:

An immutable object of type String that may be null.

getActualArm

public String getActualArm()

The name of the arm in the study the subject actually followed as part of this study.

Returns:

An immutable object of type String that may be null.

getConsent

public Reference getConsent()

A record of the patient's informed agreement to participate in the study.

Returns:

An immutable object of type Reference that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class DomainResource

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public ResearchSubject.Builder toBuilder()

Description copied from class: Resource

Create a new Builder from the contents of this Resource

Specified by:

toBuilder in class DomainResource

builder

public static ResearchSubject.Builder builder()