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
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<ResearchStudy.ResearchStudyArmComponent> Describes an expected sequence of events for one of the participants of a study.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 categoryprotected List
<CodeableConcept> The condition that is the focus of the study.protected List
<ContactDetail> Contact details to assist a user in learning more about or engaging with the study.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.Reference to a Group that defines the criteria for and quantity of subjects participating in the study.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.protected List
<CodeableConcept> 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
<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 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.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 List
<ResearchStudy> The actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)protected 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's 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 principalinvestigatorprotected Resource
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.)The 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 protocolprotected List
<PlanDefinition> 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.)protected CodeableConcept
A description and/or code explaining the premature termination of the study.protected List
<RelatedArtifact> Citations, references and other related documents.A facility in which study activities are conducted.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for siteThe actual objects that are the target of the reference (A facility in which study activities are conducted.)static final String
Search parameter: categorystatic 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: 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 Organization
The 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> The current state of the study.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected StringType
A short, descriptive user-friendly label for the study.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddArm()
Deprecated.Use Reference#setResource(IBaseResource) insteadaddFocus()
addNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddSite()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(ResearchStudy dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getArm()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetFocus()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetPhase()
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetSite()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetTitle()
String[]
getTypesForProperty
(int hash, String name) boolean
hasArm()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasFocus()
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
hasPhase()
boolean
boolean
boolean
boolean
boolean
boolean
hasSite()
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCategory
(List<CodeableConcept> theCategory) setCondition
(List<CodeableConcept> theCondition) setContact
(List<ContactDetail> theContact) setDescription
(String value) setEnrollment
(List<Reference> theEnrollment) setFocus
(List<CodeableConcept> theFocus) setIdentifier
(List<Identifier> theIdentifier) setKeyword
(List<CodeableConcept> theKeyword) setLocation
(List<CodeableConcept> theLocation) setNote
(List<Annotation> theNote) setObjective
(List<ResearchStudy.ResearchStudyObjectiveComponent> theObjective) setPhase
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProtocol
(List<Reference> theProtocol) setReasonStopped
(CodeableConcept value) setRelatedArtifact
(List<RelatedArtifact> theRelatedArtifact) setSponsor
(Reference value) setSponsorTarget
(Organization value) setTitleElement
(StringType value) protected ResearchStudy
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifiers assigned to this research study by the sponsor or other systems. -
title
A short, descriptive user-friendly label for the study. -
protocol
The set of steps expected to be performed as part of the execution of the study. -
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
A larger research study of which this particular study is a component or step. -
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
The current state of the study. -
The type of study based upon the intent of the study's 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. -
contact
Contact details to assist a user in learning more about or engaging with the study. -
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. -
description
A full description of how the study is being conducted. -
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
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
Identifies the start date and the expected (or actual, depending on status) end date for the study. -
sponsor
An organization that initiates the investigation and is legally responsible for the study. -
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
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
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.) -
site
A facility in which study activities are conducted. -
siteTarget
The actual objects that are the target of the reference (A facility in which study activities are conducted.) -
reasonStopped
A description and/or code explaining the premature termination of the study. -
note
Comments made about the study by the performer, subject or other participants. -
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
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
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_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_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_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_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_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_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
-
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_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_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_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_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_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
-
-
Constructor Details
-
ResearchStudy
public ResearchStudy()Constructor -
ResearchStudy
Constructor
-
-
Method Details
-
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
-
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
-
hasTitle
-
setTitleElement
- 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
-
getTitle
- Returns:
- A short, descriptive user-friendly label for the study.
-
setTitle
- Parameters:
value
- A short, descriptive user-friendly label for the study.
-
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
-
getProtocolTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addProtocolTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The current state of the study.
-
setStatus
- Parameters:
value
- The current state of the study.
-
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
-
setPrimaryPurposeType
- 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
- 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- A full description of how the study is being conducted.
-
setDescription
- Parameters:
value
- A full description of how the study is being conducted.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEnrollment
-
addEnrollment
-
addEnrollment
-
getEnrollmentFirstRep
- Returns:
- The first repetition of repeating field
enrollment
, creating it if it does not already exist
-
getEnrollmentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEnrollmentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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.)
-
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.)
-
getSponsorTarget
- Returns:
sponsor
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An organization that initiates the investigation and is legally responsible for the study.)
-
setSponsorTarget
- Parameters:
value
-sponsor
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getPrincipalInvestigatorTarget
- Returns:
principalInvestigator
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A 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
- Parameters:
value
-principalInvestigator
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A 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
-
getSiteTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSiteTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getReasonStopped
- Returns:
reasonStopped
(A description and/or code explaining the premature termination of the study.)
-
hasReasonStopped
-
setReasonStopped
- Parameters:
value
-reasonStopped
(A description and/or code explaining the premature termination of the study.)
-
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
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasArm
-
addArm
-
addArm
-
getArmFirstRep
- Returns:
- The first repetition of repeating field
arm
, creating it if it does not already exist
-
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
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-