ResearchSubject (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.BaseResource
  - - org.hl7.fhir.dstu3.model.Resource
    - - org.hl7.fhir.dstu3.model.DomainResource
      - org.hl7.fhir.dstu3.model.ResearchSubject

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class ResearchSubject
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ResearchSubject.ResearchSubjectStatus

static class ResearchSubject.ResearchSubjectStatusEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResearchSubject.ResearchSubjectStatus`
`static class`	`ResearchSubject.ResearchSubjectStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected StringType`	`actualArm` The name of the arm in the study the subject actually followed as part of this study.
`protected StringType`	`assignedArm` The name of the arm in the study the subject is expected to follow as part of this study.
`protected Reference`	`consent` A record of the patient's informed agreement to participate in the study.
`protected Consent`	`consentTarget` The actual object that is the target of the reference (A record of the patient's informed agreement to participate in the study.)
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected Identifier`	`identifier` Identifiers assigned to this research study by the sponsor or other systems.
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_INDIVIDUAL` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`protected Reference`	`individual` The record of the person or animal who is involved in the study.
`static ReferenceClientParam`	`INDIVIDUAL` Fluent Client search parameter constant for individual
`protected Patient`	`individualTarget` The actual object that is the target of the reference (The record of the person or animal who is involved in the study.)
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Period`	`period` The dates the subject began and ended their participation in the study.
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_INDIVIDUAL` Search parameter: individual
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_STATUS` Search parameter: status
`protected Enumeration<ResearchSubject.ResearchSubjectStatus>`	`status` The current state of the subject.
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`study` Reference to the study the subject is participating in.
`protected ResearchStudy`	`studyTarget` The actual object that is the target of the reference (Reference to the study the subject is participating in.)

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`ResearchSubject()` Constructor
`ResearchSubject(Enumeration<ResearchSubject.ResearchSubjectStatus> status, Reference study, Reference individual)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ResearchSubject`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getActualArm()`
`StringType`	`getActualArmElement()`
`String`	`getAssignedArm()`
`StringType`	`getAssignedArmElement()`
`Reference`	`getConsent()`
`Consent`	`getConsentTarget()`
`Identifier`	`getIdentifier()`
`Reference`	`getIndividual()`
`Patient`	`getIndividualTarget()`
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`ResearchSubject.ResearchSubjectStatus`	`getStatus()`
`Enumeration<ResearchSubject.ResearchSubjectStatus>`	`getStatusElement()`
`Reference`	`getStudy()`
`ResearchStudy`	`getStudyTarget()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasActualArm()`
`boolean`	`hasActualArmElement()`
`boolean`	`hasAssignedArm()`
`boolean`	`hasAssignedArmElement()`
`boolean`	`hasConsent()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIndividual()`
`boolean`	`hasPeriod()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStudy()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`ResearchSubject`	`setActualArm(String value)`
`ResearchSubject`	`setActualArmElement(StringType value)`
`ResearchSubject`	`setAssignedArm(String value)`
`ResearchSubject`	`setAssignedArmElement(StringType value)`
`ResearchSubject`	`setConsent(Reference value)`
`ResearchSubject`	`setConsentTarget(Consent value)`
`ResearchSubject`	`setIdentifier(Identifier value)`
`ResearchSubject`	`setIndividual(Reference value)`
`ResearchSubject`	`setIndividualTarget(Patient value)`
`ResearchSubject`	`setPeriod(Period value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ResearchSubject`	`setStatus(ResearchSubject.ResearchSubjectStatus value)`
`ResearchSubject`	`setStatusElement(Enumeration<ResearchSubject.ResearchSubjectStatus> value)`
`ResearchSubject`	`setStudy(Reference value)`
`ResearchSubject`	`setStudyTarget(ResearchStudy value)`
`protected ResearchSubject`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected Identifier identifier
```
    Identifiers assigned to this research study by the sponsor or other systems.
  - status
```
protected Enumeration<ResearchSubject.ResearchSubjectStatus> status
```
    The current state of the subject.
  - period
```
protected Period period
```
    The dates the subject began and ended their participation in the study.
  - study
```
protected Reference study
```
    Reference to the study the subject is participating in.
  - studyTarget
```
protected ResearchStudy studyTarget
```
    The actual object that is the target of the reference (Reference to the study the subject is participating in.)
  - individual
```
protected Reference individual
```
    The record of the person or animal who is involved in the study.
  - individualTarget
```
protected Patient individualTarget
```
    The actual object that is the target of the reference (The record of the person or animal who is involved in the study.)
  - assignedArm
```
protected StringType assignedArm
```
    The name of the arm in the study the subject is expected to follow as part of this study.
  - actualArm
```
protected StringType actualArm
```
    The name of the arm in the study the subject actually followed as part of this study.
  - consent
```
protected Reference consent
```
    A record of the patient's informed agreement to participate in the study.
  - consentTarget
```
protected Consent consentTarget
```
    The actual object that is the target of the reference (A record of the patient's informed agreement to participate in the study.)
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Start and end of participation
    Type: date
    Path: ResearchSubject.period
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Start and end of participation
    Type: date
    Path: ResearchSubject.period
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Business Identifier for research subject
    Type: token
    Path: ResearchSubject.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Business Identifier for research subject
    Type: token
    Path: ResearchSubject.identifier
  - SP_INDIVIDUAL
```
public static final String SP_INDIVIDUAL
```
    Search parameter: individual
    Description: Who is part of study
    Type: reference
    Path: ResearchSubject.individual
    
    See Also:
    
    Constant Field Values
  - INDIVIDUAL
```
public static final ReferenceClientParam INDIVIDUAL
```
    Fluent Client search parameter constant for individual
    Description: Who is part of study
    Type: reference
    Path: ResearchSubject.individual
  - INCLUDE_INDIVIDUAL
```
public static final Include INCLUDE_INDIVIDUAL
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:individual".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Who is part of study
    Type: reference
    Path: ResearchSubject.individual
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Who is part of study
    Type: reference
    Path: ResearchSubject.individual
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:patient".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: candidate | enrolled | active | suspended | withdrawn | completed
    Type: token
    Path: ResearchSubject.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: candidate | enrolled | active | suspended | withdrawn | completed
    Type: token
    Path: ResearchSubject.status
- Constructor Detail
  - ResearchSubject
```
public ResearchSubject()
```
    Constructor
  - ResearchSubject
```
public ResearchSubject(Enumeration<ResearchSubject.ResearchSubjectStatus> status,
                       Reference study,
                       Reference individual)
```
    Constructor
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Identifiers assigned to this research study by the sponsor or other systems.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public ResearchSubject setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Identifiers assigned to this research study by the sponsor or other systems.)
  - getStatusElement
```
public Enumeration<ResearchSubject.ResearchSubjectStatus> getStatusElement()
```
    Returns:
    
    status (The current state of the subject.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public ResearchSubject setStatusElement(Enumeration<ResearchSubject.ResearchSubjectStatus> value)
```
    Parameters:
    
    value - status (The current state of the subject.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public ResearchSubject.ResearchSubjectStatus getStatus()
```
    Returns:
    
    The current state of the subject.
  - setStatus
```
public ResearchSubject setStatus(ResearchSubject.ResearchSubjectStatus value)
```
    Parameters:
    
    value - The current state of the subject.
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The dates the subject began and ended their participation in the study.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public ResearchSubject setPeriod(Period value)
```
    Parameters:
    
    value - period (The dates the subject began and ended their participation in the study.)
  - getStudy
```
public Reference getStudy()
```
    Returns:
    
    study (Reference to the study the subject is participating in.)
  - hasStudy
```
public boolean hasStudy()
```
  - setStudy
```
public ResearchSubject setStudy(Reference value)
```
    Parameters:
    
    value - study (Reference to the study the subject is participating in.)
  - getStudyTarget
```
public ResearchStudy getStudyTarget()
```
    Returns:
    
    study The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Reference to the study the subject is participating in.)
  - setStudyTarget
```
public ResearchSubject setStudyTarget(ResearchStudy value)
```
    Parameters:
    
    value - study The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Reference to the study the subject is participating in.)
  - getIndividual
```
public Reference getIndividual()
```
    Returns:
    
    individual (The record of the person or animal who is involved in the study.)
  - hasIndividual
```
public boolean hasIndividual()
```
  - setIndividual
```
public ResearchSubject setIndividual(Reference value)
```
    Parameters:
    
    value - individual (The record of the person or animal who is involved in the study.)
  - getIndividualTarget
```
public Patient getIndividualTarget()
```
    Returns:
    
    individual The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The record of the person or animal who is involved in the study.)
  - setIndividualTarget
```
public ResearchSubject setIndividualTarget(Patient value)
```
    Parameters:
    
    value - individual The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The record of the person or animal who is involved in the study.)
  - getAssignedArmElement
```
public StringType getAssignedArmElement()
```
    Returns:
    
    assignedArm (The name of the arm in the study the subject is expected to follow as part of this study.). This is the underlying object with id, value and extensions. The accessor "getAssignedArm" gives direct access to the value
  - hasAssignedArmElement
```
public boolean hasAssignedArmElement()
```
  - hasAssignedArm
```
public boolean hasAssignedArm()
```
  - setAssignedArmElement
```
public ResearchSubject setAssignedArmElement(StringType value)
```
    Parameters:
    
    value - assignedArm (The name of the arm in the study the subject is expected to follow as part of this study.). This is the underlying object with id, value and extensions. The accessor "getAssignedArm" gives direct access to the value
  - getAssignedArm
```
public String getAssignedArm()
```
    Returns:
    
    The name of the arm in the study the subject is expected to follow as part of this study.
  - setAssignedArm
```
public ResearchSubject setAssignedArm(String value)
```
    Parameters:
    
    value - The name of the arm in the study the subject is expected to follow as part of this study.
  - getActualArmElement
```
public StringType getActualArmElement()
```
    Returns:
    
    actualArm (The name of the arm in the study the subject actually followed as part of this study.). This is the underlying object with id, value and extensions. The accessor "getActualArm" gives direct access to the value
  - hasActualArmElement
```
public boolean hasActualArmElement()
```
  - hasActualArm
```
public boolean hasActualArm()
```
  - setActualArmElement
```
public ResearchSubject setActualArmElement(StringType value)
```
    Parameters:
    
    value - actualArm (The name of the arm in the study the subject actually followed as part of this study.). This is the underlying object with id, value and extensions. The accessor "getActualArm" gives direct access to the value
  - getActualArm
```
public String getActualArm()
```
    Returns:
    
    The name of the arm in the study the subject actually followed as part of this study.
  - setActualArm
```
public ResearchSubject setActualArm(String value)
```
    Parameters:
    
    value - The name of the arm in the study the subject actually followed as part of this study.
  - getConsent
```
public Reference getConsent()
```
    Returns:
    
    consent (A record of the patient's informed agreement to participate in the study.)
  - hasConsent
```
public boolean hasConsent()
```
  - setConsent
```
public ResearchSubject setConsent(Reference value)
```
    Parameters:
    
    value - consent (A record of the patient's informed agreement to participate in the study.)
  - getConsentTarget
```
public Consent getConsentTarget()
```
    Returns:
    
    consent The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A record of the patient's informed agreement to participate in the study.)
  - setConsentTarget
```
public ResearchSubject setConsentTarget(Consent value)
```
    Parameters:
    
    value - consent The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A record of the patient's informed agreement to participate in the study.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public ResearchSubject copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected ResearchSubject typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class ResearchSubject

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

period

study

studyTarget

individual

individualTarget

assignedArm

actualArm

consent

consentTarget

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_INDIVIDUAL

INDIVIDUAL

INCLUDE_INDIVIDUAL

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_STATUS

STATUS

Constructor Detail

ResearchSubject

ResearchSubject

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getPeriod

hasPeriod

setPeriod

getStudy

hasStudy

setStudy

getStudyTarget

setStudyTarget

getIndividual

hasIndividual

setIndividual

getIndividualTarget

setIndividualTarget

getAssignedArmElement

hasAssignedArmElement

hasAssignedArm

setAssignedArmElement

getAssignedArm

setAssignedArm

getActualArmElement

hasActualArmElement

hasActualArm

setActualArmElement

getActualArm

setActualArm

getConsent