
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionSponsors, collaborators, and other parties.protected List<CodeableConcept>
Codes categorizing the type of study such as investigational vs.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryClassification for the study.Describes an expected sequence of events for one of the participants of a study.protected List<CodeableConcept>
The condition that is the focus of the study.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for conditionprotected List<ContactDetail>
Contact details to assist a user in learning more about or engaging with the study.protected List<CodeableConcept>
Current status of the study.protected DateTimeType
Date the resource last changed.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected MarkdownType
A full description of how the study is being conducted.protected MarkdownType
A brief summary of the study description.protected List<ResearchStudy.ResearchStudyFocusComponent>
The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for focusprotected List<Identifier>
Identifiers assigned to this research study by the sponsor or other systems.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.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 List<CodeableConcept>
Key terms to aid in searching for or filtering the study.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for keywordprotected List<ResearchStudy.ResearchStudyLabelComponent>
Additional names for the study.protected List<CodeableConcept>
Indicates a country, state or other region where the study is taking place.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for locationprotected StringType
Name for this study (computer friendly).protected List<Annotation>
Comments made about the study by the performer, subject or other participants.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.An outcome or planned variable to measure during the study.A larger research study of which this particular study is a component or step.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for partofprotected Period
Identifies the start date and the expected (or actual, depending on status) end date for the study.protected CodeableConcept
The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.protected CodeableConcept
The type of study based upon the intent of the study activities.protected 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.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for principalinvestigatorThe set of steps expected to be performed as part of the execution of the study.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for protocolTarget or actual group of participants enrolled in study.static final ca.uhn.fhir.rest.gclient.NumberClientParam
Fluent Client search parameter constant for recruitment_actualstatic final ca.uhn.fhir.rest.gclient.NumberClientParam
Fluent Client search parameter constant for recruitment_targetprotected List<RelatedArtifact>
Citations, references and other related documents.Link to one or more sets of results generated by the study.A facility in which study activities are conducted.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for sitestatic final String
Search parameter: categorystatic final String
Search parameter: conditionstatic final String
Search parameter: datestatic final String
Search parameter: focusstatic final String
Search parameter: identifierstatic final String
Search parameter: keywordstatic final String
Search parameter: locationstatic final String
Search parameter: partofstatic final String
Search parameter: principalinvestigatorstatic final String
Search parameter: protocolstatic final String
Search parameter: recruitment_actualstatic final String
Search parameter: recruitment_targetstatic final String
Search parameter: sitestatic final String
Search parameter: sponsorstatic final String
Search parameter: statusstatic final String
Search parameter: titleprotected Reference
An organization that initiates the investigation and is legally responsible for the study.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for sponsorprotected Enumeration<Enumerations.PublicationStatus>
The publication state of the resource (not of the study).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusStatus of study with time for that status.protected StringType
A short, descriptive label for the study particularly for compouter use.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected UriType
Canonical identifier for this study resource, represented as a globally unique URI.protected StringType
Business identifier for the study record.A general storage or archive location for the study.protected CodeableConcept
A description and/or code explaining the premature termination of the study.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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddFocus()
addLabel()
addNote()
addSite()
copy()
void
copyValues
(ResearchStudy dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getDate()
getFocus()
getLabel()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
getPhase()
Base[]
getProperty
(int hash, String name, boolean checkValid) getSite()
getTitle()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
hasFocus()
boolean
boolean
boolean
hasLabel()
boolean
boolean
hasName()
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
hasPhase()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasSite()
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setAssociatedParty
(List<ResearchStudy.ResearchStudyAssociatedPartyComponent> theAssociatedParty) setCategory
(List<CodeableConcept> theCategory) setClassification
(List<ResearchStudy.ResearchStudyClassificationComponent> theClassification) setComparisonGroup
(List<ResearchStudy.ResearchStudyComparisonGroupComponent> theComparisonGroup) setCondition
(List<CodeableConcept> theCondition) setContact
(List<ContactDetail> theContact) setCurrentState
(List<CodeableConcept> theCurrentState) setDateElement
(DateTimeType value) setDescription
(String value) setDescriptionSummary
(String value) setIdentifier
(List<Identifier> theIdentifier) setKeyword
(List<CodeableConcept> theKeyword) setLocation
(List<CodeableConcept> theLocation) setNameElement
(StringType value) setNote
(List<Annotation> theNote) setObjective
(List<ResearchStudy.ResearchStudyObjectiveComponent> theObjective) setOutcomeMeasure
(List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> theOutcomeMeasure) setPhase
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProtocol
(List<Reference> theProtocol) setRelatedArtifact
(List<RelatedArtifact> theRelatedArtifact) setSponsor
(Reference value) setStatusDate
(List<ResearchStudy.ResearchStudyStatusDateComponent> theStatusDate) setTitleElement
(StringType value) setUrlElement
(UriType value) setVersion
(String value) setVersionElement
(StringType value) setWebLocation
(List<ResearchStudy.ResearchStudyWebLocationComponent> theWebLocation) setWhyStopped
(CodeableConcept value) protected ResearchStudy
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
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, setId
-
Field Details
-
url
Canonical identifier for this study resource, represented as a globally unique URI. -
identifier
Identifiers assigned to this research study by the sponsor or other systems. -
version
Business identifier for the study record. -
name
Name for this study (computer friendly). -
title
A short, descriptive label for the study particularly for compouter use. -
label
Additional names for the study. -
protocol
The set of steps expected to be performed as part of the execution of the study. -
partOf
A larger research study of which this particular study is a component or step. -
date
Date the resource last changed. -
status
The publication state of the resource (not of the study). -
The type of study based upon the intent of the study activities. A classification of the intent of the study.
-
phase
The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. -
category
Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. -
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
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. -
keyword
Key terms to aid in searching for or filtering the study. -
location
Indicates a country, state or other region where the study is taking place. -
descriptionSummary
A brief summary of the study description. -
description
A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description. -
period
Identifies the start date and the expected (or actual, depending on status) end date for the study. -
contact
Contact details to assist a user in learning more about or engaging with the study. -
sponsor
An organization that initiates the investigation and is legally responsible for the study. -
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. -
site
A facility in which study activities are conducted. -
note
Comments made about the study by the performer, subject or other participants. -
classification
Classification for the study. -
associatedParty
Sponsors, collaborators, and other parties. -
currentState
Current status of the study. -
statusDate
Status of study with time for that status. -
whyStopped
A description and/or code explaining the premature termination of the study. -
recruitment
Target or actual group of participants enrolled in study. -
comparisonGroup
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
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. -
outcomeMeasure
An outcome or planned variable to measure during the study. -
result
Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov. -
webLocation
A general storage or archive location for the study. This may contain an assortment of content which is not specified in advance. -
SP_CATEGORY
Search parameter: categoryDescription: Classifications for the study
Type: token
Path: ResearchStudy.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Classifications for the study
Type: token
Path: ResearchStudy.category
-
SP_CONDITION
Search parameter: conditionDescription: Condition being studied
Type: token
Path: ResearchStudy.condition
- See Also:
-
CONDITION
Fluent Client search parameter constant for conditionDescription: Condition being studied
Type: token
Path: ResearchStudy.condition
-
SP_DATE
Search parameter: dateDescription: When the study began and ended
Type: date
Path: ResearchStudy.period
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: When the study began and ended
Type: date
Path: ResearchStudy.period
-
SP_FOCUS
Search parameter: focusDescription: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus
- See Also:
-
FOCUS
Fluent Client search parameter constant for focusDescription: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business Identifier for study
Type: token
Path: ResearchStudy.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business Identifier for study
Type: token
Path: ResearchStudy.identifier
-
SP_KEYWORD
Search parameter: keywordDescription: Used to search for the study
Type: token
Path: ResearchStudy.keyword
- See Also:
-
KEYWORD
Fluent Client search parameter constant for keywordDescription: Used to search for the study
Type: token
Path: ResearchStudy.keyword
-
SP_LOCATION
Search parameter: locationDescription: Geographic region(s) for study
Type: token
Path: ResearchStudy.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Geographic region(s) for study
Type: token
Path: ResearchStudy.location
-
SP_PARTOF
Search parameter: partofDescription: Part of larger study
Type: reference
Path: ResearchStudy.partOf
- See Also:
-
PARTOF
Fluent Client search parameter constant for partofDescription: Part of larger study
Type: reference
Path: ResearchStudy.partOf
-
INCLUDE_PARTOF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:partof". -
SP_PRINCIPALINVESTIGATOR
Search parameter: principalinvestigatorDescription: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator
- See Also:
-
PRINCIPALINVESTIGATOR
Fluent Client search parameter constant for principalinvestigatorDescription: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator
-
INCLUDE_PRINCIPALINVESTIGATOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:principalinvestigator". -
SP_PROTOCOL
Search parameter: protocolDescription: Steps followed in executing study
Type: reference
Path: ResearchStudy.protocol
- See Also:
-
PROTOCOL
Fluent Client search parameter constant for protocolDescription: Steps followed in executing study
Type: reference
Path: ResearchStudy.protocol
-
INCLUDE_PROTOCOL
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:protocol". -
SP_RECRUITMENTACTUAL
Search parameter: recruitment_actualDescription: Actual number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.actualNumber
- See Also:
-
RECRUITMENTACTUAL
Fluent Client search parameter constant for recruitment_actualDescription: Actual number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.actualNumber
-
SP_RECRUITMENTTARGET
Search parameter: recruitment_targetDescription: Target number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.targetNumber
- See Also:
-
RECRUITMENTTARGET
Fluent Client search parameter constant for recruitment_targetDescription: Target number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.targetNumber
-
SP_SITE
Search parameter: siteDescription: Facility where study activities are conducted
Type: reference
Path: ResearchStudy.site
- See Also:
-
SITE
Fluent Client search parameter constant for siteDescription: Facility where study activities are conducted
Type: reference
Path: ResearchStudy.site
-
INCLUDE_SITE
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:site". -
SP_SPONSOR
Search parameter: sponsorDescription: Organization that initiates and is legally responsible for the study
Type: reference
Path: ResearchStudy.sponsor
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:sponsor". -
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:
-
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
-
SP_TITLE
Search parameter: titleDescription: Name for this study
Type: string
Path: ResearchStudy.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: Name for this study
Type: string
Path: ResearchStudy.title
-
-
Constructor Details
-
ResearchStudy
public ResearchStudy()Constructor -
ResearchStudy
Constructor
-
-
Method Details
-
getUrlElement
- Returns:
url
(Canonical identifier for this study resource, represented as a globally unique URI.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
-
hasUrl
-
setUrlElement
- Parameters:
value
-url
(Canonical identifier for this study resource, represented as a globally unique URI.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Returns:
- Canonical identifier for this study resource, represented as a globally unique URI.
-
setUrl
- Parameters:
value
- Canonical identifier for this study resource, represented as a globally unique URI.
-
getIdentifier
- Returns:
identifier
(Identifiers assigned to this research study by the sponsor or other systems.)
-
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 {3}
-
getVersionElement
- Returns:
version
(Business identifier for the study record.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
-
hasVersion
-
setVersionElement
- Parameters:
value
-version
(Business identifier for the study record.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
- Returns:
- Business identifier for the study record.
-
setVersion
- Parameters:
value
- Business identifier for the study record.
-
getNameElement
- Returns:
name
(Name for this study (computer friendly).). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-name
(Name for this study (computer friendly).). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- Name for this study (computer friendly).
-
setName
- Parameters:
value
- Name for this study (computer friendly).
-
getTitleElement
- Returns:
title
(A short, descriptive label for the study particularly for compouter use.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(A short, descriptive label for the study particularly for compouter use.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- A short, descriptive label for the study particularly for compouter use.
-
setTitle
- Parameters:
value
- A short, descriptive label for the study particularly for compouter use.
-
getLabel
- Returns:
label
(Additional names for the study.)
-
setLabel
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLabel
-
addLabel
-
addLabel
-
getLabelFirstRep
- Returns:
- The first repetition of repeating field
label
, creating it if it does not already exist {3}
-
getProtocol
- Returns:
protocol
(The set of steps expected to be performed as part of the execution of the study.)
-
setProtocol
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProtocol
-
addProtocol
-
addProtocol
-
getProtocolFirstRep
- Returns:
- The first repetition of repeating field
protocol
, creating it if it does not already exist {3}
-
getPartOf
- Returns:
partOf
(A larger research study of which this particular study is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist {3}
-
getRelatedArtifact
- Returns:
relatedArtifact
(Citations, references and other related documents.)
-
setRelatedArtifact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
-
addRelatedArtifact
-
addRelatedArtifact
-
getRelatedArtifactFirstRep
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist {3}
-
getDateElement
- Returns:
date
(Date the resource last changed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
-
hasDate
-
setDateElement
- Parameters:
value
-date
(Date the resource last changed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Returns:
- Date the resource last changed.
-
setDate
- Parameters:
value
- Date the resource last changed.
-
getStatusElement
- Returns:
status
(The publication state of the resource (not of the study).). 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 publication state of the resource (not of the study).). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- The publication state of the resource (not of the study).
-
setStatus
- Parameters:
value
- The publication state of the resource (not of the study).
-
getPrimaryPurposeType
- Returns:
primaryPurposeType
(The type of study based upon the intent of the study activities. A classification of the intent of the study.)
-
hasPrimaryPurposeType
-
setPrimaryPurposeType
- Parameters:
value
-primaryPurposeType
(The type of study based upon the intent of the study activities. A classification of the intent of the study.)
-
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
-
setPhase
- 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
- Returns:
category
(Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFocus
-
addFocus
-
addFocus
-
getFocusFirstRep
- Returns:
- The first repetition of repeating field
focus
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCondition
-
addCondition
-
addCondition
-
getConditionFirstRep
- Returns:
- The first repetition of repeating field
condition
, creating it if it does not already exist {3}
-
getKeyword
- Returns:
keyword
(Key terms to aid in searching for or filtering the study.)
-
setKeyword
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasKeyword
-
addKeyword
-
addKeyword
-
getKeywordFirstRep
- Returns:
- The first repetition of repeating field
keyword
, creating it if it does not already exist {3}
-
getLocation
- Returns:
location
(Indicates a country, state or other region where the study is taking place.)
-
setLocation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLocation
-
addLocation
-
addLocation
-
getLocationFirstRep
- Returns:
- The first repetition of repeating field
location
, creating it if it does not already exist {3}
-
getDescriptionSummaryElement
- Returns:
descriptionSummary
(A brief summary of the study description.). This is the underlying object with id, value and extensions. The accessor "getDescriptionSummary" gives direct access to the value
-
hasDescriptionSummaryElement
-
hasDescriptionSummary
-
setDescriptionSummaryElement
- Parameters:
value
-descriptionSummary
(A brief summary of the study description.). This is the underlying object with id, value and extensions. The accessor "getDescriptionSummary" gives direct access to the value
-
getDescriptionSummary
- Returns:
- A brief summary of the study description.
-
setDescriptionSummary
- Parameters:
value
- A brief summary of the study description.
-
getDescriptionElement
- Returns:
description
(A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.
-
setDescription
- Parameters:
value
- A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.
-
getPeriod
- Returns:
period
(Identifies the start date and the expected (or actual, depending on status) end date for the study.)
-
hasPeriod
-
setPeriod
- Parameters:
value
-period
(Identifies the start date and the expected (or actual, depending on status) end date for the study.)
-
getContact
- Returns:
contact
(Contact details to assist a user in learning more about or engaging with the study.)
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist {3}
-
getSponsor
- Returns:
sponsor
(An organization that initiates the investigation and is legally responsible for the study.)
-
hasSponsor
-
setSponsor
- Parameters:
value
-sponsor
(An organization that initiates the investigation and is legally responsible for the study.)
-
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
-
setPrincipalInvestigator
- 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.)
-
getSite
- Returns:
site
(A facility in which study activities are conducted.)
-
setSite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSite
-
addSite
-
addSite
-
getSiteFirstRep
- Returns:
- The first repetition of repeating field
site
, creating it if it does not already exist {3}
-
getNote
- Returns:
note
(Comments made about the study by the performer, subject or other participants.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
getClassification
- Returns:
classification
(Classification for the study.)
-
setClassification
public ResearchStudy setClassification(List<ResearchStudy.ResearchStudyClassificationComponent> theClassification) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassification
-
addClassification
-
addClassification
-
getClassificationFirstRep
- Returns:
- The first repetition of repeating field
classification
, creating it if it does not already exist {3}
-
getAssociatedParty
- Returns:
associatedParty
(Sponsors, collaborators, and other parties.)
-
setAssociatedParty
public ResearchStudy setAssociatedParty(List<ResearchStudy.ResearchStudyAssociatedPartyComponent> theAssociatedParty) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAssociatedParty
-
addAssociatedParty
-
addAssociatedParty
-
getAssociatedPartyFirstRep
- Returns:
- The first repetition of repeating field
associatedParty
, creating it if it does not already exist {3}
-
getCurrentState
- Returns:
currentState
(Current status of the study.)
-
setCurrentState
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCurrentState
-
addCurrentState
-
addCurrentState
-
getCurrentStateFirstRep
- Returns:
- The first repetition of repeating field
currentState
, creating it if it does not already exist {3}
-
getStatusDate
- Returns:
statusDate
(Status of study with time for that status.)
-
setStatusDate
public ResearchStudy setStatusDate(List<ResearchStudy.ResearchStudyStatusDateComponent> theStatusDate) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasStatusDate
-
addStatusDate
-
addStatusDate
-
getStatusDateFirstRep
- Returns:
- The first repetition of repeating field
statusDate
, creating it if it does not already exist {3}
-
getWhyStopped
- Returns:
whyStopped
(A description and/or code explaining the premature termination of the study.)
-
hasWhyStopped
-
setWhyStopped
- Parameters:
value
-whyStopped
(A description and/or code explaining the premature termination of the study.)
-
getRecruitment
- Returns:
recruitment
(Target or actual group of participants enrolled in study.)
-
hasRecruitment
-
setRecruitment
- Parameters:
value
-recruitment
(Target or actual group of participants enrolled in study.)
-
getComparisonGroup
- Returns:
comparisonGroup
(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.)
-
setComparisonGroup
public ResearchStudy setComparisonGroup(List<ResearchStudy.ResearchStudyComparisonGroupComponent> theComparisonGroup) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasComparisonGroup
-
addComparisonGroup
-
addComparisonGroup
-
getComparisonGroupFirstRep
- Returns:
- The first repetition of repeating field
comparisonGroup
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasObjective
-
addObjective
-
addObjective
-
getObjectiveFirstRep
- Returns:
- The first repetition of repeating field
objective
, creating it if it does not already exist {3}
-
getOutcomeMeasure
- Returns:
outcomeMeasure
(An outcome or planned variable to measure during the study.)
-
setOutcomeMeasure
public ResearchStudy setOutcomeMeasure(List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> theOutcomeMeasure) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutcomeMeasure
-
addOutcomeMeasure
-
addOutcomeMeasure
-
getOutcomeMeasureFirstRep
- Returns:
- The first repetition of repeating field
outcomeMeasure
, creating it if it does not already exist {3}
-
getResult
- Returns:
result
(Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.)
-
setResult
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasResult
-
addResult
-
addResult
-
getResultFirstRep
- Returns:
- The first repetition of repeating field
result
, creating it if it does not already exist {3}
-
getWebLocation
- Returns:
webLocation
(A general storage or archive location for the study. This may contain an assortment of content which is not specified in advance.)
-
setWebLocation
public ResearchStudy setWebLocation(List<ResearchStudy.ResearchStudyWebLocationComponent> theWebLocation) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasWebLocation
-
addWebLocation
-
addWebLocation
-
getWebLocationFirstRep
- Returns:
- The first repetition of repeating field
webLocation
, creating it if it does not already exist {3}
-
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
-
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
-