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 classResearchSubject.ResearchSubjectStatusstatic classResearchSubject.ResearchSubjectStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected StringTypeactualArmThe name of the arm in the study the subject actually followed as part of this study.protected StringTypeassignedArmThe name of the arm in the study the subject is expected to follow as part of this study.protected ReferenceconsentA record of the patient's informed agreement to participate in the study.protected ConsentconsentTargetThe actual object that is the target of the reference (A record of the patient's informed agreement to participate in the study.)static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Identifier>identifierIdentifiers assigned to this research subject for a study.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_INDIVIDUALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_STUDYConstant for fluent queries to be used to add include statements.protected ReferenceindividualThe record of the person or animal who is involved in the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINDIVIDUALFluent Client search parameter constant for individualprotected PatientindividualTargetThe actual object that is the target of the reference (The record of the person or animal who is involved in the study.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PeriodperiodThe dates the subject began and ended their participation in the study.static StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INDIVIDUALSearch parameter: individualstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_STATUSSearch parameter: statusstatic StringSP_STUDYSearch parameter: studyprotected Enumeration<ResearchSubject.ResearchSubjectStatus>statusThe current state of the subject.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencestudyReference to the study the subject is participating in.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSTUDYFluent Client search parameter constant for studyprotected ResearchStudystudyTargetThe 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
-
-
Constructor Summary
Constructors Constructor Description ResearchSubject()ConstructorResearchSubject(Enumeration<ResearchSubject.ResearchSubjectStatus> status, Reference study, Reference individual)Constructor
-
Method Summary
-
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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
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.
-
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: dateDescription: 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 dateDescription: Start and end of participation
Type: date
Path: ResearchSubject.period
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: Business Identifier for research subject in a study
Type: token
Path: ResearchSubject.identifier
-
SP_STUDY
public static final String SP_STUDY
Search parameter: studyDescription: 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 studyDescription: 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: individualDescription: 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 individualDescription: 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: patientDescription: 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 patientDescription: 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: 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:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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 Detail
-
ResearchSubject
public ResearchSubject()
Constructor
-
ResearchSubject
public ResearchSubject(Enumeration<ResearchSubject.ResearchSubjectStatus> status, Reference study, Reference individual)
Constructor
-
-
Method Detail
-
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
thisfor 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:
studyThe 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-studyThe 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:
individualThe 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-individualThe 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:
consentThe 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-consentThe 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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ResearchSubject copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ResearchSubject dst)
-
typedCopy
protected ResearchSubject typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-