Class ResearchSubject
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.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.ResearchSubjectProgressComponent
-
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.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_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.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.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.protected List<ResearchSubject.ResearchSubjectProgressComponent>progressThe current state (status) of the subject and resons for status change where appropriate.static StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_STATUSSearch parameter: statusstatic StringSP_STUDYSearch parameter: studystatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_SUBJECTSTATESearch parameter: subject_stateprotected Enumeration<Enumerations.PublicationStatus>statusThe publication state of the resource (not 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 ReferencesubjectThe record of the person, animal or other entity involved in the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.TokenClientParamSUBJECTSTATEFluent Client search parameter constant for subject_state-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ResearchSubject()ConstructorResearchSubject(Enumerations.PublicationStatus status, Reference study, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.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.r5.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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers assigned to this research subject for a study.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The publication state of the resource (not of the subject).
-
progress
protected List<ResearchSubject.ResearchSubjectProgressComponent> progress
The current state (status) of the subject and resons for status change where appropriate.
-
period
protected Period period
The dates the subject began and ended their participation in the study.
-
subject
protected Reference subject
The record of the person, animal or other entity 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.
-
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_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Who or what is part of study
Type: reference
Path: ResearchSubject.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Who or what is part of study
Type: reference
Path: ResearchSubject.subject
-
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: draft | active | retired | unknown
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: draft | active | retired | unknown
Type: token
Path: ResearchSubject.status
-
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_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: Who or what is part of study
Type: reference
Path: ResearchSubject.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: Who or what is part of study
Type: reference
Path: ResearchSubject.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:subject".
-
SP_SUBJECTSTATE
public static final String SP_SUBJECTSTATE
Search parameter: subject_stateDescription: 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.progress.subjectState
- See Also:
- Constant Field Values
-
SUBJECTSTATE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBJECTSTATE
Fluent Client search parameter constant for subject_stateDescription: 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.progress.subjectState
-
-
Constructor Detail
-
ResearchSubject
public ResearchSubject()
Constructor
-
ResearchSubject
public ResearchSubject(Enumerations.PublicationStatus status, Reference study, Reference subject)
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 {3}
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status(The publication state of the resource (not 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<Enumerations.PublicationStatus> value)
- Parameters:
value-status(The publication state of the resource (not of the subject).). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- The publication state of the resource (not of the subject).
-
setStatus
public ResearchSubject setStatus(Enumerations.PublicationStatus value)
- Parameters:
value- The publication state of the resource (not of the subject).
-
getProgress
public List<ResearchSubject.ResearchSubjectProgressComponent> getProgress()
- Returns:
progress(The current state (status) of the subject and resons for status change where appropriate.)
-
setProgress
public ResearchSubject setProgress(List<ResearchSubject.ResearchSubjectProgressComponent> theProgress)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProgress
public boolean hasProgress()
-
addProgress
public ResearchSubject.ResearchSubjectProgressComponent addProgress()
-
addProgress
public ResearchSubject addProgress(ResearchSubject.ResearchSubjectProgressComponent t)
-
getProgressFirstRep
public ResearchSubject.ResearchSubjectProgressComponent getProgressFirstRep()
- Returns:
- The first repetition of repeating field
progress, creating it if it does not already exist {3}
-
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.)
-
getSubject
public Reference getSubject()
- Returns:
subject(The record of the person, animal or other entity involved in the study.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public ResearchSubject setSubject(Reference value)
- Parameters:
value-subject(The record of the person, animal or other entity 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.)
-
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
-
-