Class ResearchStudy
- 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.ResearchStudy
-
- 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 ResearchStudy 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 Description static classResearchStudy.ResearchStudyArmComponentstatic classResearchStudy.ResearchStudyObjectiveComponentstatic classResearchStudy.ResearchStudyStatusstatic classResearchStudy.ResearchStudyStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<ResearchStudy.ResearchStudyArmComponent>armDescribes an expected sequence of events for one of the participants of a study.protected List<CodeableConcept>categoryCodes categorizing the type of study such as investigational vs.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected List<CodeableConcept>conditionThe condition that is the focus of the study.protected List<ContactDetail>contactContact details to assist a user in learning more about or engaging with the study.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected MarkdownTypedescriptionA full description of how the study is being conducted.protected List<Reference>enrollmentReference to a Group that defines the criteria for and quantity of subjects participating in the study.protected List<Group>enrollmentTargetThe actual objects that are the target of the reference (Reference to a Group that defines the criteria for and quantity of subjects participating in the study.protected List<CodeableConcept>focusThe medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.static ca.uhn.fhir.rest.gclient.TokenClientParamFOCUSFluent Client search parameter constant for focusprotected List<Identifier>identifierIdentifiers assigned to this research study by the sponsor or other systems.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_PARTOFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRINCIPALINVESTIGATORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PROTOCOLConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SITEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SPONSORConstant for fluent queries to be used to add include statements.protected List<CodeableConcept>keywordKey terms to aid in searching for or filtering the study.static ca.uhn.fhir.rest.gclient.TokenClientParamKEYWORDFluent Client search parameter constant for keywordprotected List<CodeableConcept>locationIndicates a country, state or other region where the study is taking place.static ca.uhn.fhir.rest.gclient.TokenClientParamLOCATIONFluent Client search parameter constant for locationprotected List<Annotation>noteComments made about the study by the performer, subject or other participants.protected List<ResearchStudy.ResearchStudyObjectiveComponent>objectiveA goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.protected List<Reference>partOfA larger research study of which this particular study is a component or step.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARTOFFluent Client search parameter constant for partofprotected List<ResearchStudy>partOfTargetThe actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)protected PeriodperiodIdentifies the start date and the expected (or actual, depending on status) end date for the study.protected CodeableConceptphaseThe stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.protected CodeableConceptprimaryPurposeTypeThe type of study based upon the intent of the study's activities.protected ReferenceprincipalInvestigatorA researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPRINCIPALINVESTIGATORFluent Client search parameter constant for principalinvestigatorprotected ResourceprincipalInvestigatorTargetThe actual object that is the target of the reference (A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)protected List<Reference>protocolThe set of steps expected to be performed as part of the execution of the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPROTOCOLFluent Client search parameter constant for protocolprotected List<PlanDefinition>protocolTargetThe actual objects that are the target of the reference (The set of steps expected to be performed as part of the execution of the study.)protected CodeableConceptreasonStoppedA description and/or code explaining the premature termination of the study.protected List<RelatedArtifact>relatedArtifactCitations, references and other related documents.protected List<Reference>siteA facility in which study activities are conducted.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSITEFluent Client search parameter constant for siteprotected List<Location>siteTargetThe actual objects that are the target of the reference (A facility in which study activities are conducted.)static StringSP_CATEGORYSearch parameter: categorystatic StringSP_DATESearch parameter: datestatic StringSP_FOCUSSearch parameter: focusstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_KEYWORDSearch parameter: keywordstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_PARTOFSearch parameter: partofstatic StringSP_PRINCIPALINVESTIGATORSearch parameter: principalinvestigatorstatic StringSP_PROTOCOLSearch parameter: protocolstatic StringSP_SITESearch parameter: sitestatic StringSP_SPONSORSearch parameter: sponsorstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titleprotected ReferencesponsorAn organization that initiates the investigation and is legally responsible for the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSPONSORFluent Client search parameter constant for sponsorprotected OrganizationsponsorTargetThe actual object that is the target of the reference (An organization that initiates the investigation and is legally responsible for the study.)protected Enumeration<ResearchStudy.ResearchStudyStatus>statusThe current state of the study.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected StringTypetitleA short, descriptive user-friendly label for the study.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for title-
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 ResearchStudy()ConstructorResearchStudy(Enumeration<ResearchStudy.ResearchStudyStatus> status)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 study by the sponsor or other systems.
-
title
protected StringType title
A short, descriptive user-friendly label for the study.
-
protocol
protected List<Reference> protocol
The set of steps expected to be performed as part of the execution of the study.
-
protocolTarget
protected List<PlanDefinition> protocolTarget
The actual objects that are the target of the reference (The set of steps expected to be performed as part of the execution of the study.)
-
partOf
protected List<Reference> partOf
A larger research study of which this particular study is a component or step.
-
partOfTarget
protected List<ResearchStudy> partOfTarget
The actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)
-
status
protected Enumeration<ResearchStudy.ResearchStudyStatus> status
The current state of the study.
-
primaryPurposeType
protected CodeableConcept primaryPurposeType
The type of study based upon the intent of the study's activities. A classification of the intent of the study.
-
phase
protected CodeableConcept phase
The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
-
category
protected List<CodeableConcept> category
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
-
focus
protected List<CodeableConcept> focus
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
-
condition
protected List<CodeableConcept> condition
The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in learning more about or engaging with the study.
-
relatedArtifact
protected List<RelatedArtifact> relatedArtifact
Citations, references and other related documents.
-
keyword
protected List<CodeableConcept> keyword
Key terms to aid in searching for or filtering the study.
-
location
protected List<CodeableConcept> location
Indicates a country, state or other region where the study is taking place.
-
description
protected MarkdownType description
A full description of how the study is being conducted.
-
enrollment
protected List<Reference> enrollment
Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
-
enrollmentTarget
protected List<Group> enrollmentTarget
The actual objects that are the target of the reference (Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".)
-
period
protected Period period
Identifies the start date and the expected (or actual, depending on status) end date for the study.
-
sponsor
protected Reference sponsor
An organization that initiates the investigation and is legally responsible for the study.
-
sponsorTarget
protected Organization sponsorTarget
The actual object that is the target of the reference (An organization that initiates the investigation and is legally responsible for the study.)
-
principalInvestigator
protected Reference principalInvestigator
A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
-
principalInvestigatorTarget
protected Resource principalInvestigatorTarget
The actual object that is the target of the reference (A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)
-
siteTarget
protected List<Location> siteTarget
The actual objects that are the target of the reference (A facility in which study activities are conducted.)
-
reasonStopped
protected CodeableConcept reasonStopped
A description and/or code explaining the premature termination of the study.
-
note
protected List<Annotation> note
Comments made about the study by the performer, subject or other participants.
-
arm
protected List<ResearchStudy.ResearchStudyArmComponent> arm
Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
-
objective
protected List<ResearchStudy.ResearchStudyObjectiveComponent> objective
A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: When the study began and ended
Type: date
Path: ResearchStudy.period
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: When the study began and ended
Type: date
Path: ResearchStudy.period
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business Identifier for study
Type: token
Path: ResearchStudy.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 study
Type: token
Path: ResearchStudy.identifier
-
SP_PARTOF
public static final String SP_PARTOF
Search parameter: partofDescription: Part of larger study
Type: reference
Path: ResearchStudy.partOf
- See Also:
- Constant Field Values
-
PARTOF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTOF
Fluent Client search parameter constant for partofDescription: Part of larger study
Type: reference
Path: ResearchStudy.partOf
-
INCLUDE_PARTOF
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTOF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:partof".
-
SP_SPONSOR
public static final String SP_SPONSOR
Search parameter: sponsorDescription: Organization that initiates and is legally responsible for the study
Type: reference
Path: ResearchStudy.sponsor
- See Also:
- Constant Field Values
-
SPONSOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SPONSOR
Fluent Client search parameter constant for sponsorDescription: Organization that initiates and is legally responsible for the study
Type: reference
Path: ResearchStudy.sponsor
-
INCLUDE_SPONSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_SPONSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:sponsor".
-
SP_FOCUS
public static final String SP_FOCUS
Search parameter: focusDescription: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus
- See Also:
- Constant Field Values
-
FOCUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam FOCUS
Fluent Client search parameter constant for focusDescription: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus
-
SP_PRINCIPALINVESTIGATOR
public static final String SP_PRINCIPALINVESTIGATOR
Search parameter: principalinvestigatorDescription: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator
- See Also:
- Constant Field Values
-
PRINCIPALINVESTIGATOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRINCIPALINVESTIGATOR
Fluent Client search parameter constant for principalinvestigatorDescription: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator
-
INCLUDE_PRINCIPALINVESTIGATOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRINCIPALINVESTIGATOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:principalinvestigator".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Name for this study
Type: string
Path: ResearchStudy.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: Name for this study
Type: string
Path: ResearchStudy.title
-
SP_PROTOCOL
public static final String SP_PROTOCOL
Search parameter: protocolDescription: Steps followed in executing study
Type: reference
Path: ResearchStudy.protocol
- See Also:
- Constant Field Values
-
PROTOCOL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROTOCOL
Fluent Client search parameter constant for protocolDescription: Steps followed in executing study
Type: reference
Path: ResearchStudy.protocol
-
INCLUDE_PROTOCOL
public static final ca.uhn.fhir.model.api.Include INCLUDE_PROTOCOL
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:protocol".
-
SP_SITE
public static final String SP_SITE
Search parameter: siteDescription: Facility where study activities are conducted
Type: reference
Path: ResearchStudy.site
- See Also:
- Constant Field Values
-
SITE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SITE
Fluent Client search parameter constant for siteDescription: Facility where study activities are conducted
Type: reference
Path: ResearchStudy.site
-
INCLUDE_SITE
public static final ca.uhn.fhir.model.api.Include INCLUDE_SITE
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:site".
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: Geographic region(s) for study
Type: token
Path: ResearchStudy.location
- See Also:
- Constant Field Values
-
LOCATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam LOCATION
Fluent Client search parameter constant for locationDescription: Geographic region(s) for study
Type: token
Path: ResearchStudy.location
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Classifications for the study
Type: token
Path: ResearchStudy.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Classifications for the study
Type: token
Path: ResearchStudy.category
-
SP_KEYWORD
public static final String SP_KEYWORD
Search parameter: keywordDescription: Used to search for the study
Type: token
Path: ResearchStudy.keyword
- See Also:
- Constant Field Values
-
KEYWORD
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KEYWORD
Fluent Client search parameter constant for keywordDescription: Used to search for the study
Type: token
Path: ResearchStudy.keyword
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
Type: token
Path: ResearchStudy.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
Type: token
Path: ResearchStudy.status
-
-
Constructor Detail
-
ResearchStudy
public ResearchStudy()
Constructor
-
ResearchStudy
public ResearchStudy(Enumeration<ResearchStudy.ResearchStudyStatus> status)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers assigned to this research study by the sponsor or other systems.)
-
setIdentifier
public ResearchStudy setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ResearchStudy addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getTitleElement
public StringType getTitleElement()
- Returns:
title(A short, descriptive user-friendly label for the study.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public ResearchStudy setTitleElement(StringType value)
- Parameters:
value-title(A short, descriptive user-friendly label for the study.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
setTitle
public ResearchStudy setTitle(String value)
- Parameters:
value- A short, descriptive user-friendly label for the study.
-
getProtocol
public List<Reference> getProtocol()
- Returns:
protocol(The set of steps expected to be performed as part of the execution of the study.)
-
setProtocol
public ResearchStudy setProtocol(List<Reference> theProtocol)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProtocol
public boolean hasProtocol()
-
addProtocol
public Reference addProtocol()
-
addProtocol
public ResearchStudy addProtocol(Reference t)
-
getProtocolFirstRep
public Reference getProtocolFirstRep()
- Returns:
- The first repetition of repeating field
protocol, creating it if it does not already exist
-
getProtocolTarget
@Deprecated public List<PlanDefinition> getProtocolTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addProtocolTarget
@Deprecated public PlanDefinition addProtocolTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(A larger research study of which this particular study is a component or step.)
-
setPartOf
public ResearchStudy setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOf
public ResearchStudy addPartOf(Reference t)
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<ResearchStudy> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addPartOfTarget
@Deprecated public ResearchStudy addPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getStatusElement
public Enumeration<ResearchStudy.ResearchStudyStatus> getStatusElement()
- Returns:
status(The current state of the study.). 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 ResearchStudy setStatusElement(Enumeration<ResearchStudy.ResearchStudyStatus> value)
- Parameters:
value-status(The current state of the study.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public ResearchStudy.ResearchStudyStatus getStatus()
- Returns:
- The current state of the study.
-
setStatus
public ResearchStudy setStatus(ResearchStudy.ResearchStudyStatus value)
- Parameters:
value- The current state of the study.
-
getPrimaryPurposeType
public CodeableConcept getPrimaryPurposeType()
- Returns:
primaryPurposeType(The type of study based upon the intent of the study's activities. A classification of the intent of the study.)
-
hasPrimaryPurposeType
public boolean hasPrimaryPurposeType()
-
setPrimaryPurposeType
public ResearchStudy setPrimaryPurposeType(CodeableConcept value)
- Parameters:
value-primaryPurposeType(The type of study based upon the intent of the study's activities. A classification of the intent of the study.)
-
getPhase
public CodeableConcept getPhase()
- Returns:
phase(The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.)
-
hasPhase
public boolean hasPhase()
-
setPhase
public ResearchStudy setPhase(CodeableConcept value)
- Parameters:
value-phase(The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.)
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.)
-
setCategory
public ResearchStudy setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public ResearchStudy addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist
-
getFocus
public List<CodeableConcept> getFocus()
- Returns:
focus(The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.)
-
setFocus
public ResearchStudy setFocus(List<CodeableConcept> theFocus)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFocus
public boolean hasFocus()
-
addFocus
public CodeableConcept addFocus()
-
addFocus
public ResearchStudy addFocus(CodeableConcept t)
-
getFocusFirstRep
public CodeableConcept getFocusFirstRep()
- Returns:
- The first repetition of repeating field
focus, creating it if it does not already exist
-
getCondition
public List<CodeableConcept> getCondition()
- Returns:
condition(The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.)
-
setCondition
public ResearchStudy setCondition(List<CodeableConcept> theCondition)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCondition
public boolean hasCondition()
-
addCondition
public CodeableConcept addCondition()
-
addCondition
public ResearchStudy addCondition(CodeableConcept t)
-
getConditionFirstRep
public CodeableConcept getConditionFirstRep()
- Returns:
- The first repetition of repeating field
condition, creating it if it does not already exist
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact(Contact details to assist a user in learning more about or engaging with the study.)
-
setContact
public ResearchStudy setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public ResearchStudy addContact(ContactDetail t)
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
- Returns:
relatedArtifact(Citations, references and other related documents.)
-
setRelatedArtifact
public ResearchStudy setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedArtifact
public boolean hasRelatedArtifact()
-
addRelatedArtifact
public RelatedArtifact addRelatedArtifact()
-
addRelatedArtifact
public ResearchStudy addRelatedArtifact(RelatedArtifact t)
-
getRelatedArtifactFirstRep
public RelatedArtifact getRelatedArtifactFirstRep()
- Returns:
- The first repetition of repeating field
relatedArtifact, creating it if it does not already exist
-
getKeyword
public List<CodeableConcept> getKeyword()
- Returns:
keyword(Key terms to aid in searching for or filtering the study.)
-
setKeyword
public ResearchStudy setKeyword(List<CodeableConcept> theKeyword)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasKeyword
public boolean hasKeyword()
-
addKeyword
public CodeableConcept addKeyword()
-
addKeyword
public ResearchStudy addKeyword(CodeableConcept t)
-
getKeywordFirstRep
public CodeableConcept getKeywordFirstRep()
- Returns:
- The first repetition of repeating field
keyword, creating it if it does not already exist
-
getLocation
public List<CodeableConcept> getLocation()
- Returns:
location(Indicates a country, state or other region where the study is taking place.)
-
setLocation
public ResearchStudy setLocation(List<CodeableConcept> theLocation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLocation
public boolean hasLocation()
-
addLocation
public CodeableConcept addLocation()
-
addLocation
public ResearchStudy addLocation(CodeableConcept t)
-
getLocationFirstRep
public CodeableConcept getLocationFirstRep()
- Returns:
- The first repetition of repeating field
location, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(A full description of how the study is being conducted.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public ResearchStudy setDescriptionElement(MarkdownType value)
- Parameters:
value-description(A full description of how the study is being conducted.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A full description of how the study is being conducted.
-
setDescription
public ResearchStudy setDescription(String value)
- Parameters:
value- A full description of how the study is being conducted.
-
getEnrollment
public List<Reference> getEnrollment()
- Returns:
enrollment(Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".)
-
setEnrollment
public ResearchStudy setEnrollment(List<Reference> theEnrollment)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEnrollment
public boolean hasEnrollment()
-
addEnrollment
public Reference addEnrollment()
-
addEnrollment
public ResearchStudy addEnrollment(Reference t)
-
getEnrollmentFirstRep
public Reference getEnrollmentFirstRep()
- Returns:
- The first repetition of repeating field
enrollment, creating it if it does not already exist
-
getEnrollmentTarget
@Deprecated public List<Group> getEnrollmentTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEnrollmentTarget
@Deprecated public Group addEnrollmentTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPeriod
public Period getPeriod()
- Returns:
period(Identifies the start date and the expected (or actual, depending on status) end date for the study.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public ResearchStudy setPeriod(Period value)
- Parameters:
value-period(Identifies the start date and the expected (or actual, depending on status) end date for the study.)
-
getSponsor
public Reference getSponsor()
- Returns:
sponsor(An organization that initiates the investigation and is legally responsible for the study.)
-
hasSponsor
public boolean hasSponsor()
-
setSponsor
public ResearchStudy setSponsor(Reference value)
- Parameters:
value-sponsor(An organization that initiates the investigation and is legally responsible for the study.)
-
getSponsorTarget
public Organization getSponsorTarget()
- Returns:
sponsorThe 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. (An organization that initiates the investigation and is legally responsible for the study.)
-
setSponsorTarget
public ResearchStudy setSponsorTarget(Organization value)
- Parameters:
value-sponsorThe 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. (An organization that initiates the investigation and is legally responsible for the study.)
-
getPrincipalInvestigator
public Reference getPrincipalInvestigator()
- Returns:
principalInvestigator(A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)
-
hasPrincipalInvestigator
public boolean hasPrincipalInvestigator()
-
setPrincipalInvestigator
public ResearchStudy setPrincipalInvestigator(Reference value)
- Parameters:
value-principalInvestigator(A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)
-
getPrincipalInvestigatorTarget
public Resource getPrincipalInvestigatorTarget()
- Returns:
principalInvestigatorThe 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 researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)
-
setPrincipalInvestigatorTarget
public ResearchStudy setPrincipalInvestigatorTarget(Resource value)
- Parameters:
value-principalInvestigatorThe 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 researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)
-
getSite
public List<Reference> getSite()
- Returns:
site(A facility in which study activities are conducted.)
-
setSite
public ResearchStudy setSite(List<Reference> theSite)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSite
public boolean hasSite()
-
addSite
public ResearchStudy addSite(Reference t)
-
getSiteFirstRep
public Reference getSiteFirstRep()
- Returns:
- The first repetition of repeating field
site, creating it if it does not already exist
-
getSiteTarget
@Deprecated public List<Location> getSiteTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addSiteTarget
@Deprecated public Location addSiteTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReasonStopped
public CodeableConcept getReasonStopped()
- Returns:
reasonStopped(A description and/or code explaining the premature termination of the study.)
-
hasReasonStopped
public boolean hasReasonStopped()
-
setReasonStopped
public ResearchStudy setReasonStopped(CodeableConcept value)
- Parameters:
value-reasonStopped(A description and/or code explaining the premature termination of the study.)
-
getNote
public List<Annotation> getNote()
- Returns:
note(Comments made about the study by the performer, subject or other participants.)
-
setNote
public ResearchStudy setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public ResearchStudy addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getArm
public List<ResearchStudy.ResearchStudyArmComponent> getArm()
- Returns:
arm(Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.)
-
setArm
public ResearchStudy setArm(List<ResearchStudy.ResearchStudyArmComponent> theArm)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasArm
public boolean hasArm()
-
addArm
public ResearchStudy.ResearchStudyArmComponent addArm()
-
addArm
public ResearchStudy addArm(ResearchStudy.ResearchStudyArmComponent t)
-
getArmFirstRep
public ResearchStudy.ResearchStudyArmComponent getArmFirstRep()
- Returns:
- The first repetition of repeating field
arm, creating it if it does not already exist
-
getObjective
public List<ResearchStudy.ResearchStudyObjectiveComponent> getObjective()
- Returns:
objective(A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.)
-
setObjective
public ResearchStudy setObjective(List<ResearchStudy.ResearchStudyObjectiveComponent> theObjective)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasObjective
public boolean hasObjective()
-
addObjective
public ResearchStudy.ResearchStudyObjectiveComponent addObjective()
-
addObjective
public ResearchStudy addObjective(ResearchStudy.ResearchStudyObjectiveComponent t)
-
getObjectiveFirstRep
public ResearchStudy.ResearchStudyObjectiveComponent getObjectiveFirstRep()
- Returns:
- The first repetition of repeating field
objective, creating it if it does not already exist
-
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 ResearchStudy copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ResearchStudy dst)
-
typedCopy
protected ResearchStudy 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
-
-