Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected StringType
The name of the arm in the study the subject actually followed as part of this study.protected StringType
The name of the arm in the study the subject is expected to follow as part of this study.protected Reference
A record of the patient's informed agreement to participate in the study.protected Consent
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
Fluent Client search parameter constant for dateprotected List
<Identifier> Identifiers assigned to this research subject for a study.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
The record of the person or animal who is involved in the study.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for individualprotected Patient
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
Fluent Client search parameter constant for patientprotected Period
The dates the subject began and ended their participation in the study.static final String
Search parameter: datestatic final String
Search parameter: identifierstatic final String
Search parameter: individualstatic final String
Search parameter: patientstatic final String
Search parameter: statusstatic final String
Search parameter: studyprotected Enumeration
<ResearchSubject.ResearchSubjectStatus> The current state of the subject.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
Reference to the study the subject is participating in.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for studyprotected ResearchStudy
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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorResearchSubject
(Enumeration<ResearchSubject.ResearchSubjectStatus> status, Reference study, Reference individual) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getStudy()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasStudy()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActualArm
(String value) setActualArmElement
(StringType value) setAssignedArm
(String value) setAssignedArmElement
(StringType value) setConsent
(Reference value) setConsentTarget
(Consent value) setIdentifier
(List<Identifier> theIdentifier) setIndividual
(Reference value) setIndividualTarget
(Patient value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStudyTarget
(ResearchStudy value) protected ResearchSubject
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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
Identifiers assigned to this research subject for a study. -
status
The current state of the subject. -
period
The dates the subject began and ended their participation in the study. -
study
Reference to the study the subject is participating in. -
studyTarget
The actual object that is the target of the reference (Reference to the study the subject is participating in.) -
individual
The record of the person or animal who is involved in the study. -
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
The name of the arm in the study the subject is expected to follow as part of this study. -
actualArm
The name of the arm in the study the subject actually followed as part of this study. -
consent
A record of the patient's informed agreement to participate in the study. -
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
Search parameter: dateDescription: Start and end of participation
Type: date
Path: ResearchSubject.period
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Start and end of participation
Type: date
Path: ResearchSubject.period
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business Identifier for research subject in a study
Type: token
Path: ResearchSubject.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business Identifier for research subject in a study
Type: token
Path: ResearchSubject.identifier
-
SP_STUDY
Search parameter: studyDescription: Study subject is part of
Type: reference
Path: ResearchSubject.study
- See Also:
-
STUDY
Fluent Client search parameter constant for studyDescription: Study subject is part of
Type: reference
Path: ResearchSubject.study
-
INCLUDE_STUDY
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:study". -
SP_INDIVIDUAL
Search parameter: individualDescription: Who is part of study
Type: reference
Path: ResearchSubject.individual
- See Also:
-
INDIVIDUAL
Fluent Client search parameter constant for individualDescription: Who is part of study
Type: reference
Path: ResearchSubject.individual
-
INCLUDE_INDIVIDUAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:individual". -
SP_PATIENT
Search parameter: patientDescription: Who is part of study
Type: reference
Path: ResearchSubject.individual
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who is part of study
Type: reference
Path: ResearchSubject.individual
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:patient". -
SP_STATUS
Search parameter: statusDescription: 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:
-
STATUS
Fluent Client search parameter constant for statusDescription: 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
- Returns:
identifier
(Identifiers assigned to this research subject for a study.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The current state of the subject.
-
setStatus
- Parameters:
value
- The current state of the subject.
-
getPeriod
- Returns:
period
(The dates the subject began and ended their participation in the study.)
-
hasPeriod
-
setPeriod
- Parameters:
value
-period
(The dates the subject began and ended their participation in the study.)
-
getStudy
- Returns:
study
(Reference to the study the subject is participating in.)
-
hasStudy
-
setStudy
- Parameters:
value
-study
(Reference to the study the subject is participating in.)
-
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
- 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
- Returns:
individual
(The record of the person or animal who is involved in the study.)
-
hasIndividual
-
setIndividual
- Parameters:
value
-individual
(The record of the person or animal who is involved in the study.)
-
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
- 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
- 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
-
hasAssignedArm
-
setAssignedArmElement
- 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
- Returns:
- The name of the arm in the study the subject is expected to follow as part of this study.
-
setAssignedArm
- Parameters:
value
- The name of the arm in the study the subject is expected to follow as part of this study.
-
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
-
hasActualArm
-
setActualArmElement
- 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
- Returns:
- The name of the arm in the study the subject actually followed as part of this study.
-
setActualArm
- Parameters:
value
- The name of the arm in the study the subject actually followed as part of this study.
-
getConsent
- Returns:
consent
(A record of the patient's informed agreement to participate in the study.)
-
hasConsent
-
setConsent
- Parameters:
value
-consent
(A record of the patient's informed agreement to participate in the study.)
-
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
- 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
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-