Package org.hl7.fhir.r5.model

Class ResearchStudy

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.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 scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResearchStudy.ResearchStudyAssociatedPartyComponent
static class	ResearchStudy.ResearchStudyComparisonGroupComponent
static class	ResearchStudy.ResearchStudyLabelComponent
static class	ResearchStudy.ResearchStudyObjectiveComponent
static class	ResearchStudy.ResearchStudyOutcomeMeasureComponent
static class	ResearchStudy.ResearchStudyProgressStatusComponent
static class	ResearchStudy.ResearchStudyRecruitmentComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ResearchStudy.ResearchStudyAssociatedPartyComponent>	associatedParty	Sponsors, collaborators, and other parties.
protected List<CodeableConcept>	classifier	Additional grouping mechanism or categorization of a research study.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CLASSIFIER	Fluent Client search parameter constant for classifier
protected List<ResearchStudy.ResearchStudyComparisonGroupComponent>	comparisonGroup	Describes an expected event or sequence of events for one of the subjects of a study.
protected List<CodeableConcept>	condition	The condition that is the focus of the study.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONDITION	Fluent Client search parameter constant for condition
protected DateTimeType	date	The date (and optionally time) when the ResearchStudy Resource was last significantly changed.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected MarkdownType	description	A detailed and human-readable narrative of the study.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected MarkdownType	descriptionSummary	A brief text for explaining the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ELIGIBILITY	Fluent Client search parameter constant for eligibility
protected List<CodeableReference>	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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FOCUS_CODE	Fluent Client search parameter constant for focus-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FOCUS_REFERENCE	Fluent Client search parameter constant for focus-reference
protected List<Identifier>	identifier	Identifiers assigned to this research study by the sponsor or other systems.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ELIGIBILITY	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FOCUS_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PART_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PROTOCOL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SITE	Constant for fluent queries to be used to add include statements.
protected List<CodeableConcept>	keyword	Key terms to aid in searching for or filtering the study.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	KEYWORD	Fluent Client search parameter constant for keyword
protected List<ResearchStudy.ResearchStudyLabelComponent>	label	Additional names for the study.
protected StringType	name	Name for this study (computer friendly).
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<Annotation>	note	Comments made about the study by the performer, subject or other participants.
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.
static final ca.uhn.fhir.rest.gclient.StringClientParam	OBJECTIVE_DESCRIPTION	Fluent Client search parameter constant for objective-description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	OBJECTIVE_TYPE	Fluent Client search parameter constant for objective-type
protected List<ResearchStudy.ResearchStudyOutcomeMeasureComponent>	outcomeMeasure	An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PART_OF	Fluent Client search parameter constant for part-of
protected List<Reference>	partOf	A larger research study of which this particular study is a component or step.
protected Period	period	Identifies the start date and the expected (or actual, depending on status) end date for the study.
protected CodeableConcept	phase	The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PHASE	Fluent Client search parameter constant for phase
protected CodeableConcept	primaryPurposeType	The type of study based upon the intent of the study activities.
protected List<ResearchStudy.ResearchStudyProgressStatusComponent>	progressStatus	Status of study with time for that status.
protected List<Reference>	protocol	The set of steps expected to be performed as part of the execution of the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PROTOCOL	Fluent Client search parameter constant for protocol
protected ResearchStudy.ResearchStudyRecruitmentComponent	recruitment	Target or actual group of participants enrolled in study.
static final ca.uhn.fhir.rest.gclient.NumberClientParam	RECRUITMENT_ACTUAL	Fluent Client search parameter constant for recruitment-actual
static final ca.uhn.fhir.rest.gclient.NumberClientParam	RECRUITMENT_TARGET	Fluent Client search parameter constant for recruitment-target
protected List<CodeableConcept>	region	A country, state or other area where the study is taking place rather than its precise geographic location or address.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REGION	Fluent Client search parameter constant for region
protected List<RelatedArtifact>	relatedArtifact	Citations, references, URLs and other related documents.
protected List<Reference>	result	Link to one or more sets of results generated by the study.
protected List<Reference>	site	A facility in which study activities are conducted.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SITE	Fluent Client search parameter constant for site
static final String	SP_CLASSIFIER	Search parameter: classifier
static final String	SP_CONDITION	Search parameter: condition
static final String	SP_DATE	Search parameter: date
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_ELIGIBILITY	Search parameter: eligibility
static final String	SP_FOCUS_CODE	Search parameter: focus-code
static final String	SP_FOCUS_REFERENCE	Search parameter: focus-reference
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_KEYWORD	Search parameter: keyword
static final String	SP_NAME	Search parameter: name
static final String	SP_OBJECTIVE_DESCRIPTION	Search parameter: objective-description
static final String	SP_OBJECTIVE_TYPE	Search parameter: objective-type
static final String	SP_PART_OF	Search parameter: part-of
static final String	SP_PHASE	Search parameter: phase
static final String	SP_PROTOCOL	Search parameter: protocol
static final String	SP_RECRUITMENT_ACTUAL	Search parameter: recruitment-actual
static final String	SP_RECRUITMENT_TARGET	Search parameter: recruitment-target
static final String	SP_REGION	Search parameter: region
static final String	SP_SITE	Search parameter: site
static final String	SP_STATUS	Search parameter: status
static final String	SP_STUDY_DESIGN	Search parameter: study-design
static final String	SP_TITLE	Search parameter: title
protected Enumeration<Enumerations.PublicationStatus>	status	The publication state of the resource (not of the study).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STUDY_DESIGN	Fluent Client search parameter constant for study-design
protected List<CodeableConcept>	studyDesign	Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
protected StringType	title	The human readable name of the research study.
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
protected UriType	url	Canonical identifier for this study resource, represented as a globally unique URI.
protected StringType	version	The business version for the study record.
protected CodeableConcept	whyStopped	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, 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

Constructors

Constructor	Description
ResearchStudy()	Constructor
ResearchStudy(Enumerations.PublicationStatus status)	Constructor

Method Summary

Modifier and Type	Method	Description
ResearchStudy.ResearchStudyAssociatedPartyComponent	addAssociatedParty()
ResearchStudy	addAssociatedParty(ResearchStudy.ResearchStudyAssociatedPartyComponent t)
Base	addChild(String name)
CodeableConcept	addClassifier()
ResearchStudy	addClassifier(CodeableConcept t)
ResearchStudy.ResearchStudyComparisonGroupComponent	addComparisonGroup()
ResearchStudy	addComparisonGroup(ResearchStudy.ResearchStudyComparisonGroupComponent t)
CodeableConcept	addCondition()
ResearchStudy	addCondition(CodeableConcept t)
CodeableReference	addFocus()
ResearchStudy	addFocus(CodeableReference t)
Identifier	addIdentifier()
ResearchStudy	addIdentifier(Identifier t)
CodeableConcept	addKeyword()
ResearchStudy	addKeyword(CodeableConcept t)
ResearchStudy.ResearchStudyLabelComponent	addLabel()
ResearchStudy	addLabel(ResearchStudy.ResearchStudyLabelComponent t)
Annotation	addNote()
ResearchStudy	addNote(Annotation t)
ResearchStudy.ResearchStudyObjectiveComponent	addObjective()
ResearchStudy	addObjective(ResearchStudy.ResearchStudyObjectiveComponent t)
ResearchStudy.ResearchStudyOutcomeMeasureComponent	addOutcomeMeasure()
ResearchStudy	addOutcomeMeasure(ResearchStudy.ResearchStudyOutcomeMeasureComponent t)
Reference	addPartOf()
ResearchStudy	addPartOf(Reference t)
ResearchStudy.ResearchStudyProgressStatusComponent	addProgressStatus()
ResearchStudy	addProgressStatus(ResearchStudy.ResearchStudyProgressStatusComponent t)
Reference	addProtocol()
ResearchStudy	addProtocol(Reference t)
CodeableConcept	addRegion()
ResearchStudy	addRegion(CodeableConcept t)
RelatedArtifact	addRelatedArtifact()
ResearchStudy	addRelatedArtifact(RelatedArtifact t)
Reference	addResult()
ResearchStudy	addResult(Reference t)
Reference	addSite()
ResearchStudy	addSite(Reference t)
CodeableConcept	addStudyDesign()
ResearchStudy	addStudyDesign(CodeableConcept t)
ResearchStudy	copy()
void	copyValues(ResearchStudy dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ResearchStudy.ResearchStudyAssociatedPartyComponent>	getAssociatedParty()
ResearchStudy.ResearchStudyAssociatedPartyComponent	getAssociatedPartyFirstRep()
List<CodeableConcept>	getClassifier()
CodeableConcept	getClassifierFirstRep()
List<ResearchStudy.ResearchStudyComparisonGroupComponent>	getComparisonGroup()
ResearchStudy.ResearchStudyComparisonGroupComponent	getComparisonGroupFirstRep()
List<CodeableConcept>	getCondition()
CodeableConcept	getConditionFirstRep()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
String	getDescriptionSummary()
MarkdownType	getDescriptionSummaryElement()
List<CodeableReference>	getFocus()
CodeableReference	getFocusFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getKeyword()
CodeableConcept	getKeywordFirstRep()
List<ResearchStudy.ResearchStudyLabelComponent>	getLabel()
ResearchStudy.ResearchStudyLabelComponent	getLabelFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
List<ResearchStudy.ResearchStudyObjectiveComponent>	getObjective()
ResearchStudy.ResearchStudyObjectiveComponent	getObjectiveFirstRep()
List<ResearchStudy.ResearchStudyOutcomeMeasureComponent>	getOutcomeMeasure()
ResearchStudy.ResearchStudyOutcomeMeasureComponent	getOutcomeMeasureFirstRep()
List<Reference>	getPartOf()
Reference	getPartOfFirstRep()
Period	getPeriod()
CodeableConcept	getPhase()
CodeableConcept	getPrimaryPurposeType()
List<ResearchStudy.ResearchStudyProgressStatusComponent>	getProgressStatus()
ResearchStudy.ResearchStudyProgressStatusComponent	getProgressStatusFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getProtocol()
Reference	getProtocolFirstRep()
ResearchStudy.ResearchStudyRecruitmentComponent	getRecruitment()
List<CodeableConcept>	getRegion()
CodeableConcept	getRegionFirstRep()
List<RelatedArtifact>	getRelatedArtifact()
RelatedArtifact	getRelatedArtifactFirstRep()
ResourceType	getResourceType()
List<Reference>	getResult()
Reference	getResultFirstRep()
List<Reference>	getSite()
Reference	getSiteFirstRep()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
List<CodeableConcept>	getStudyDesign()
CodeableConcept	getStudyDesignFirstRep()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
String	getVersion()
StringType	getVersionElement()
CodeableConcept	getWhyStopped()
boolean	hasAssociatedParty()
boolean	hasClassifier()
boolean	hasComparisonGroup()
boolean	hasCondition()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDescriptionSummary()
boolean	hasDescriptionSummaryElement()
boolean	hasFocus()
boolean	hasIdentifier()
boolean	hasKeyword()
boolean	hasLabel()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNote()
boolean	hasObjective()
boolean	hasOutcomeMeasure()
boolean	hasPartOf()
boolean	hasPeriod()
boolean	hasPhase()
boolean	hasPrimaryPurposeType()
boolean	hasProgressStatus()
boolean	hasProtocol()
boolean	hasRecruitment()
boolean	hasRegion()
boolean	hasRelatedArtifact()
boolean	hasResult()
boolean	hasSite()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStudyDesign()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	hasWhyStopped()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ResearchStudy	setAssociatedParty(List<ResearchStudy.ResearchStudyAssociatedPartyComponent> theAssociatedParty)
ResearchStudy	setClassifier(List<CodeableConcept> theClassifier)
ResearchStudy	setComparisonGroup(List<ResearchStudy.ResearchStudyComparisonGroupComponent> theComparisonGroup)
ResearchStudy	setCondition(List<CodeableConcept> theCondition)
ResearchStudy	setDate(Date value)
ResearchStudy	setDateElement(DateTimeType value)
ResearchStudy	setDescription(String value)
ResearchStudy	setDescriptionElement(MarkdownType value)
ResearchStudy	setDescriptionSummary(String value)
ResearchStudy	setDescriptionSummaryElement(MarkdownType value)
ResearchStudy	setFocus(List<CodeableReference> theFocus)
ResearchStudy	setIdentifier(List<Identifier> theIdentifier)
ResearchStudy	setKeyword(List<CodeableConcept> theKeyword)
ResearchStudy	setLabel(List<ResearchStudy.ResearchStudyLabelComponent> theLabel)
ResearchStudy	setName(String value)
ResearchStudy	setNameElement(StringType value)
ResearchStudy	setNote(List<Annotation> theNote)
ResearchStudy	setObjective(List<ResearchStudy.ResearchStudyObjectiveComponent> theObjective)
ResearchStudy	setOutcomeMeasure(List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> theOutcomeMeasure)
ResearchStudy	setPartOf(List<Reference> thePartOf)
ResearchStudy	setPeriod(Period value)
ResearchStudy	setPhase(CodeableConcept value)
ResearchStudy	setPrimaryPurposeType(CodeableConcept value)
ResearchStudy	setProgressStatus(List<ResearchStudy.ResearchStudyProgressStatusComponent> theProgressStatus)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ResearchStudy	setProtocol(List<Reference> theProtocol)
ResearchStudy	setRecruitment(ResearchStudy.ResearchStudyRecruitmentComponent value)
ResearchStudy	setRegion(List<CodeableConcept> theRegion)
ResearchStudy	setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
ResearchStudy	setResult(List<Reference> theResult)
ResearchStudy	setSite(List<Reference> theSite)
ResearchStudy	setStatus(Enumerations.PublicationStatus value)
ResearchStudy	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
ResearchStudy	setStudyDesign(List<CodeableConcept> theStudyDesign)
ResearchStudy	setTitle(String value)
ResearchStudy	setTitleElement(StringType value)
ResearchStudy	setUrl(String value)
ResearchStudy	setUrlElement(UriType value)
ResearchStudy	setVersion(String value)
ResearchStudy	setVersionElement(StringType value)
ResearchStudy	setWhyStopped(CodeableConcept value)
protected ResearchStudy	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

url

protected UriType url

Canonical identifier for this study resource, represented as a globally unique URI.

identifier

protected List<Identifier> identifier

Identifiers assigned to this research study by the sponsor or other systems.

version

protected StringType version

The business version for the study record.

name

protected StringType name

Name for this study (computer friendly).

title

protected StringType title

The human readable name of the research study.

label

protected List<ResearchStudy.ResearchStudyLabelComponent> label

Additional names for the study.

protocol

protected List<Reference> protocol

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.

relatedArtifact

protected List<RelatedArtifact> relatedArtifact

Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of "documentation" or "supported-with" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.

date

protected DateTimeType date

The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.

status

protected Enumeration<Enumerations.PublicationStatus> status

The publication state of the resource (not of the study).

primaryPurposeType

protected CodeableConcept primaryPurposeType

The type of study based upon the intent of the study 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.

studyDesign

protected List<CodeableConcept> studyDesign

Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

focus

protected List<CodeableReference> 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.

keyword

protected List<CodeableConcept> keyword

Key terms to aid in searching for or filtering the study.

region

protected List<CodeableConcept> region

A country, state or other area where the study is taking place rather than its precise geographic location or address.

descriptionSummary

protected MarkdownType descriptionSummary

A brief text for explaining the study.

description

protected MarkdownType description

A detailed and human-readable narrative of the study. E.g., study abstract.

period

protected Period period

Identifies the start date and the expected (or actual, depending on status) end date for the study.

site

protected List<Reference> site

A facility in which study activities are conducted.

note

protected List<Annotation> note

Comments made about the study by the performer, subject or other participants.

classifier

protected List<CodeableConcept> classifier

Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.

associatedParty

protected List<ResearchStudy.ResearchStudyAssociatedPartyComponent> associatedParty

Sponsors, collaborators, and other parties.

progressStatus

protected List<ResearchStudy.ResearchStudyProgressStatusComponent> progressStatus

Status of study with time for that status.

whyStopped

protected CodeableConcept whyStopped

A description and/or code explaining the premature termination of the study.

recruitment

protected ResearchStudy.ResearchStudyRecruitmentComponent recruitment

Target or actual group of participants enrolled in study.

comparisonGroup

protected List<ResearchStudy.ResearchStudyComparisonGroupComponent> comparisonGroup

Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.

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.

outcomeMeasure

protected List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> outcomeMeasure

An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.

result

protected List<Reference> 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.

SP_CLASSIFIER

public static final String SP_CLASSIFIER

Search parameter: classifier

Description: Classification for the study
Type: token
Path: ResearchStudy.classifier

See Also:

• Constant Field Values

CLASSIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASSIFIER

Fluent Client search parameter constant for classifier

Description: Classification for the study
Type: token
Path: ResearchStudy.classifier

SP_CONDITION

public static final String SP_CONDITION

Search parameter: condition

Description: Condition being studied
Type: token
Path: ResearchStudy.condition

See Also:

• Constant Field Values

CONDITION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONDITION

Fluent Client search parameter constant for condition

Description: Condition being studied
Type: token
Path: ResearchStudy.condition

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: 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 date

Description: When the study began and ended
Type: date
Path: ResearchStudy.period

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: Detailed narrative of the study
Type: string
Path: ResearchStudy.description

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: Detailed narrative of the study
Type: string
Path: ResearchStudy.description

SP_ELIGIBILITY

public static final String SP_ELIGIBILITY

Search parameter: eligibility

Description: Inclusion and exclusion criteria
Type: reference
Path: ResearchStudy.recruitment.eligibility

See Also:

• Constant Field Values

ELIGIBILITY

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ELIGIBILITY

Fluent Client search parameter constant for eligibility

Description: Inclusion and exclusion criteria
Type: reference
Path: ResearchStudy.recruitment.eligibility

INCLUDE_ELIGIBILITY

public static final ca.uhn.fhir.model.api.Include INCLUDE_ELIGIBILITY

Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:eligibility".

SP_FOCUS_CODE

public static final String SP_FOCUS_CODE

Search parameter: focus-code

Description: Drugs, devices, etc. under study, as a code
Type: token
Path: ResearchStudy.focus.concept

See Also:

• Constant Field Values

FOCUS_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam FOCUS_CODE

Fluent Client search parameter constant for focus-code

Description: Drugs, devices, etc. under study, as a code
Type: token
Path: ResearchStudy.focus.concept

SP_FOCUS_REFERENCE

public static final String SP_FOCUS_REFERENCE

Search parameter: focus-reference

Description: Drugs, devices, etc. under study, as a reference
Type: reference
Path: ResearchStudy.focus.reference

See Also:

• Constant Field Values

FOCUS_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS_REFERENCE

Fluent Client search parameter constant for focus-reference

Description: Drugs, devices, etc. under study, as a reference
Type: reference
Path: ResearchStudy.focus.reference

INCLUDE_FOCUS_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:focus-reference".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: 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 identifier

Description: Business Identifier for study
Type: token
Path: ResearchStudy.identifier

SP_KEYWORD

public static final String SP_KEYWORD

Search parameter: keyword

Description: 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 keyword

Description: Used to search for the study
Type: token
Path: ResearchStudy.keyword

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Name for this study
Type: string
Path: ResearchStudy.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: Name for this study
Type: string
Path: ResearchStudy.name

SP_OBJECTIVE_DESCRIPTION

public static final String SP_OBJECTIVE_DESCRIPTION

Search parameter: objective-description

Description: Free text description of the objective of the study
Type: string
Path: ResearchStudy.objective.description

See Also:

• Constant Field Values

OBJECTIVE_DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam OBJECTIVE_DESCRIPTION

Fluent Client search parameter constant for objective-description

Description: Free text description of the objective of the study
Type: string
Path: ResearchStudy.objective.description

SP_OBJECTIVE_TYPE

public static final String SP_OBJECTIVE_TYPE

Search parameter: objective-type

Description: The kind of study objective
Type: token
Path: ResearchStudy.objective.type

See Also:

• Constant Field Values

OBJECTIVE_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam OBJECTIVE_TYPE

Fluent Client search parameter constant for objective-type

Description: The kind of study objective
Type: token
Path: ResearchStudy.objective.type

SP_PART_OF

public static final String SP_PART_OF

Search parameter: part-of

Description: Part of larger study
Type: reference
Path: ResearchStudy.partOf

See Also:

• Constant Field Values

PART_OF

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF

Fluent Client search parameter constant for part-of

Description: Part of larger study
Type: reference
Path: ResearchStudy.partOf

INCLUDE_PART_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchStudy:part-of".

SP_PHASE

public static final String SP_PHASE

Search parameter: phase

Description: The stage in the progression of a study
Type: token
Path: ResearchStudy.phase

See Also:

• Constant Field Values

PHASE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHASE

Fluent Client search parameter constant for phase

Description: The stage in the progression of a study
Type: token
Path: ResearchStudy.phase

SP_PROTOCOL

public static final String SP_PROTOCOL

Search parameter: protocol

Description: 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 protocol

Description: 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_RECRUITMENT_ACTUAL

public static final String SP_RECRUITMENT_ACTUAL

Search parameter: recruitment-actual

Description: Actual number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.actualNumber

See Also:

• Constant Field Values

RECRUITMENT_ACTUAL

public static final ca.uhn.fhir.rest.gclient.NumberClientParam RECRUITMENT_ACTUAL

Fluent Client search parameter constant for recruitment-actual

Description: Actual number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.actualNumber

SP_RECRUITMENT_TARGET

public static final String SP_RECRUITMENT_TARGET

Search parameter: recruitment-target

Description: Target number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.targetNumber

See Also:

• Constant Field Values

RECRUITMENT_TARGET

public static final ca.uhn.fhir.rest.gclient.NumberClientParam RECRUITMENT_TARGET

Fluent Client search parameter constant for recruitment-target

Description: Target number of participants enrolled in study across all groups
Type: number
Path: ResearchStudy.recruitment.targetNumber

SP_REGION

public static final String SP_REGION

Search parameter: region

Description: Geographic area for the study
Type: token
Path: ResearchStudy.region

See Also:

• Constant Field Values

REGION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam REGION

Fluent Client search parameter constant for region

Description: Geographic area for the study
Type: token
Path: ResearchStudy.region

SP_SITE

public static final String SP_SITE

Search parameter: site

Description: 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 site

Description: 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_STATUS

public static final String SP_STATUS

Search parameter: status

Description: active | active-but-not-recruiting | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | enrolling-by-invitation | in-review | not-yet-recruiting | recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | terminated | 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 status

Description: active | active-but-not-recruiting | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | enrolling-by-invitation | in-review | not-yet-recruiting | recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | terminated | withdrawn
Type: token
Path: ResearchStudy.status

SP_STUDY_DESIGN

public static final String SP_STUDY_DESIGN

Search parameter: study-design

Description: Classifications of the study design characteristics
Type: token
Path: ResearchStudy.studyDesign

See Also:

• Constant Field Values

STUDY_DESIGN

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STUDY_DESIGN

Fluent Client search parameter constant for study-design

Description: Classifications of the study design characteristics
Type: token
Path: ResearchStudy.studyDesign

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human readable name of the research 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 title

Description: The human readable name of the research study
Type: string
Path: ResearchStudy.title

Constructor Details

ResearchStudy

public ResearchStudy()

Constructor

ResearchStudy

public ResearchStudy(Enumerations.PublicationStatus status)

Constructor

Method Details

getUrlElement

public UriType 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

public boolean hasUrlElement()

hasUrl

public boolean hasUrl()

setUrlElement

public ResearchStudy setUrlElement(UriType value)

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

public String getUrl()

Returns:

Canonical identifier for this study resource, represented as a globally unique URI.

setUrl

public ResearchStudy setUrl(String value)

Parameters:

value - Canonical identifier for this study resource, represented as a globally unique URI.

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 this for 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 {3}

getVersionElement

public StringType getVersionElement()

Returns:

version (The business version for the study record.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

hasVersion

public boolean hasVersion()

setVersionElement

public ResearchStudy setVersionElement(StringType value)

Parameters:

value - version (The business version for the study record.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Returns:

The business version for the study record.

setVersion

public ResearchStudy setVersion(String value)

Parameters:

value - The business version for the study record.

getNameElement

public StringType 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

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public ResearchStudy setNameElement(StringType value)

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

public String getName()

Returns:

Name for this study (computer friendly).

setName

public ResearchStudy setName(String value)

Parameters:

value - Name for this study (computer friendly).

getTitleElement

public StringType getTitleElement()

Returns:

title (The human readable name of the research 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 (The human readable name of the research study.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

The human readable name of the research study.

setTitle

public ResearchStudy setTitle(String value)

Parameters:

value - The human readable name of the research study.

getLabel

public List<ResearchStudy.ResearchStudyLabelComponent> getLabel()

Returns:

label (Additional names for the study.)

setLabel

public ResearchStudy setLabel(List<ResearchStudy.ResearchStudyLabelComponent> theLabel)

Returns:

Returns a reference to this for easy method chaining

hasLabel

public boolean hasLabel()

addLabel

public ResearchStudy.ResearchStudyLabelComponent addLabel()

addLabel

public ResearchStudy addLabel(ResearchStudy.ResearchStudyLabelComponent t)

getLabelFirstRep

public ResearchStudy.ResearchStudyLabelComponent getLabelFirstRep()

Returns:

The first repetition of repeating field label, creating it if it does not already exist {3}

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 this for 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 {3}

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 this for easy method chaining

hasPartOf

public boolean hasPartOf()

addPartOf

public Reference addPartOf()

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 {3}

getRelatedArtifact

public List<RelatedArtifact> getRelatedArtifact()

Returns:

relatedArtifact (Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of "documentation" or "supported-with" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.)

setRelatedArtifact

public ResearchStudy setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)

Returns:

Returns a reference to this for 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 {3}

getDateElement

public DateTimeType getDateElement()

Returns:

date (The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public ResearchStudy setDateElement(DateTimeType value)

Parameters:

value - date (The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.

setDate

public ResearchStudy setDate(Date value)

Parameters:

value - The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> 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

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public ResearchStudy setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

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

public Enumerations.PublicationStatus getStatus()

Returns:

The publication state of the resource (not of the study).

setStatus

public ResearchStudy setStatus(Enumerations.PublicationStatus value)

Parameters:

value - The publication state of the resource (not of the study).

getPrimaryPurposeType

public CodeableConcept getPrimaryPurposeType()

Returns:

primaryPurposeType (The type of study based upon the intent of the study 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 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.)

getStudyDesign

public List<CodeableConcept> getStudyDesign()

Returns:

studyDesign (Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.)

setStudyDesign

public ResearchStudy setStudyDesign(List<CodeableConcept> theStudyDesign)

Returns:

Returns a reference to this for easy method chaining

hasStudyDesign

public boolean hasStudyDesign()

addStudyDesign

public CodeableConcept addStudyDesign()

addStudyDesign

public ResearchStudy addStudyDesign(CodeableConcept t)

getStudyDesignFirstRep

public CodeableConcept getStudyDesignFirstRep()

Returns:

The first repetition of repeating field studyDesign, creating it if it does not already exist {3}

getFocus

public List<CodeableReference> 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<CodeableReference> theFocus)

Returns:

Returns a reference to this for easy method chaining

hasFocus

public boolean hasFocus()

addFocus

public CodeableReference addFocus()

addFocus

public ResearchStudy addFocus(CodeableReference t)

getFocusFirstRep

public CodeableReference getFocusFirstRep()

Returns:

The first repetition of repeating field focus, creating it if it does not already exist {3}

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 this for 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 {3}

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 this for 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 {3}

getRegion

public List<CodeableConcept> getRegion()

Returns:

region (A country, state or other area where the study is taking place rather than its precise geographic location or address.)

setRegion

public ResearchStudy setRegion(List<CodeableConcept> theRegion)

Returns:

Returns a reference to this for easy method chaining

hasRegion

public boolean hasRegion()

addRegion

public CodeableConcept addRegion()

addRegion

public ResearchStudy addRegion(CodeableConcept t)

getRegionFirstRep

public CodeableConcept getRegionFirstRep()

Returns:

The first repetition of repeating field region, creating it if it does not already exist {3}

getDescriptionSummaryElement

public MarkdownType getDescriptionSummaryElement()

Returns:

descriptionSummary (A brief text for explaining the study.). This is the underlying object with id, value and extensions. The accessor "getDescriptionSummary" gives direct access to the value

hasDescriptionSummaryElement

public boolean hasDescriptionSummaryElement()

hasDescriptionSummary

public boolean hasDescriptionSummary()

setDescriptionSummaryElement

public ResearchStudy setDescriptionSummaryElement(MarkdownType value)

Parameters:

value - descriptionSummary (A brief text for explaining the study.). This is the underlying object with id, value and extensions. The accessor "getDescriptionSummary" gives direct access to the value

getDescriptionSummary

public String getDescriptionSummary()

Returns:

A brief text for explaining the study.

setDescriptionSummary

public ResearchStudy setDescriptionSummary(String value)

Parameters:

value - A brief text for explaining the study.

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (A detailed and human-readable narrative of the study. E.g., study abstract.). 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 detailed and human-readable narrative of the study. E.g., study abstract.). 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 detailed and human-readable narrative of the study. E.g., study abstract.

setDescription

public ResearchStudy setDescription(String value)

Parameters:

value - A detailed and human-readable narrative of the study. E.g., study abstract.

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.)

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 this for easy method chaining

hasSite

public boolean hasSite()

addSite

public Reference addSite()

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 {3}

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 this for 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 {3}

getClassifier

public List<CodeableConcept> getClassifier()

Returns:

classifier (Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.)

setClassifier

public ResearchStudy setClassifier(List<CodeableConcept> theClassifier)

Returns:

Returns a reference to this for easy method chaining

hasClassifier

public boolean hasClassifier()

addClassifier

public CodeableConcept addClassifier()

addClassifier

public ResearchStudy addClassifier(CodeableConcept t)

getClassifierFirstRep

public CodeableConcept getClassifierFirstRep()

Returns:

The first repetition of repeating field classifier, creating it if it does not already exist {3}

getAssociatedParty

public List<ResearchStudy.ResearchStudyAssociatedPartyComponent> 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

public boolean hasAssociatedParty()

addAssociatedParty

public ResearchStudy.ResearchStudyAssociatedPartyComponent addAssociatedParty()

addAssociatedParty

public ResearchStudy addAssociatedParty(ResearchStudy.ResearchStudyAssociatedPartyComponent t)

getAssociatedPartyFirstRep

public ResearchStudy.ResearchStudyAssociatedPartyComponent getAssociatedPartyFirstRep()

Returns:

The first repetition of repeating field associatedParty, creating it if it does not already exist {3}

getProgressStatus

public List<ResearchStudy.ResearchStudyProgressStatusComponent> getProgressStatus()

Returns:

progressStatus (Status of study with time for that status.)

setProgressStatus

public ResearchStudy setProgressStatus(List<ResearchStudy.ResearchStudyProgressStatusComponent> theProgressStatus)

Returns:

Returns a reference to this for easy method chaining

hasProgressStatus

public boolean hasProgressStatus()

addProgressStatus

public ResearchStudy.ResearchStudyProgressStatusComponent addProgressStatus()

addProgressStatus

public ResearchStudy addProgressStatus(ResearchStudy.ResearchStudyProgressStatusComponent t)

getProgressStatusFirstRep

public ResearchStudy.ResearchStudyProgressStatusComponent getProgressStatusFirstRep()

Returns:

The first repetition of repeating field progressStatus, creating it if it does not already exist {3}

getWhyStopped

public CodeableConcept getWhyStopped()

Returns:

whyStopped (A description and/or code explaining the premature termination of the study.)

hasWhyStopped

public boolean hasWhyStopped()

setWhyStopped

public ResearchStudy setWhyStopped(CodeableConcept value)

Parameters:

value - whyStopped (A description and/or code explaining the premature termination of the study.)

getRecruitment

public ResearchStudy.ResearchStudyRecruitmentComponent getRecruitment()

Returns:

recruitment (Target or actual group of participants enrolled in study.)

hasRecruitment

public boolean hasRecruitment()

setRecruitment

public ResearchStudy setRecruitment(ResearchStudy.ResearchStudyRecruitmentComponent value)

Parameters:

value - recruitment (Target or actual group of participants enrolled in study.)

getComparisonGroup

public List<ResearchStudy.ResearchStudyComparisonGroupComponent> getComparisonGroup()

Returns:

comparisonGroup (Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.)

setComparisonGroup

public ResearchStudy setComparisonGroup(List<ResearchStudy.ResearchStudyComparisonGroupComponent> theComparisonGroup)

Returns:

Returns a reference to this for easy method chaining

hasComparisonGroup

public boolean hasComparisonGroup()

addComparisonGroup

public ResearchStudy.ResearchStudyComparisonGroupComponent addComparisonGroup()

addComparisonGroup

public ResearchStudy addComparisonGroup(ResearchStudy.ResearchStudyComparisonGroupComponent t)

getComparisonGroupFirstRep

public ResearchStudy.ResearchStudyComparisonGroupComponent getComparisonGroupFirstRep()

Returns:

The first repetition of repeating field comparisonGroup, creating it if it does not already exist {3}

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 this for 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 {3}

getOutcomeMeasure

public List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> getOutcomeMeasure()

Returns:

outcomeMeasure (An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.)

setOutcomeMeasure

public ResearchStudy setOutcomeMeasure(List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> theOutcomeMeasure)

Returns:

Returns a reference to this for easy method chaining

hasOutcomeMeasure

public boolean hasOutcomeMeasure()

addOutcomeMeasure

public ResearchStudy.ResearchStudyOutcomeMeasureComponent addOutcomeMeasure()

addOutcomeMeasure

public ResearchStudy addOutcomeMeasure(ResearchStudy.ResearchStudyOutcomeMeasureComponent t)

getOutcomeMeasureFirstRep

public ResearchStudy.ResearchStudyOutcomeMeasureComponent getOutcomeMeasureFirstRep()

Returns:

The first repetition of repeating field outcomeMeasure, creating it if it does not already exist {3}

getResult

public List<Reference> 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

public ResearchStudy setResult(List<Reference> theResult)

Returns:

Returns a reference to this for easy method chaining

hasResult

public boolean hasResult()

addResult

public Reference addResult()

addResult

public ResearchStudy addResult(Reference t)

getResultFirstRep

public Reference getResultFirstRep()

Returns:

The first repetition of repeating field result, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class DomainResource

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 class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public ResearchStudy copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(ResearchStudy dst)

typedCopy

protected ResearchStudy typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource