Package org.hl7.fhir.r4.model

Class ResearchSubject

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.ResearchSubject

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class ResearchSubject
extends DomainResource

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ResearchSubject.ResearchSubjectStatus
static class	ResearchSubject.ResearchSubjectStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	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 final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected List<Identifier>	identifier	Identifiers assigned to this research subject for a study.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_INDIVIDUAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_STUDY	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 final ca.uhn.fhir.rest.gclient.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 final ca.uhn.fhir.rest.gclient.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 final String	SP_DATE	Search parameter: date
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INDIVIDUAL	Search parameter: individual
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_STATUS	Search parameter: status
static final String	SP_STUDY	Search parameter: study
protected Enumeration<ResearchSubject.ResearchSubjectStatus>	status	The current state of the subject.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	study	Reference to the study the subject is participating in.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	STUDY	Fluent Client search parameter constant for study
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.r4.model.DomainResource

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
ResearchSubject	addIdentifier(Identifier t)
ResearchSubject	copy()
void	copyValues(ResearchSubject dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getActualArm()
StringType	getActualArmElement()
String	getAssignedArm()
StringType	getAssignedArmElement()
Reference	getConsent()
Consent	getConsentTarget()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Reference	getIndividual()
Patient	getIndividualTarget()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
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> children)
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(List<Identifier> theIdentifier)
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.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifiers assigned to this research subject for a study.

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 ca.uhn.fhir.rest.gclient.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 in a study
Type: token
Path: ResearchSubject.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Business Identifier for research subject in a study
Type: token
Path: ResearchSubject.identifier

SP_STUDY

public static final String SP_STUDY

Search parameter: study

Description: Study subject is part of
Type: reference
Path: ResearchSubject.study

See Also:

• Constant Field Values

STUDY

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam STUDY

Fluent Client search parameter constant for study

Description: Study subject is part of
Type: reference
Path: ResearchSubject.study

INCLUDE_STUDY

public static final ca.uhn.fhir.model.api.Include INCLUDE_STUDY

Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:study".

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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.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 | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
Type: token
Path: ResearchSubject.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
Type: token
Path: ResearchSubject.status

Constructor Details

ResearchSubject

public ResearchSubject()

Constructor

ResearchSubject

public ResearchSubject(Enumeration<ResearchSubject.ResearchSubjectStatus> status,
 Reference study,
 Reference individual)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this research subject for a study.)

setIdentifier

public ResearchSubject setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ResearchSubject addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

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> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public ResearchSubject copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(ResearchSubject dst)

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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource