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 process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResearchStudy.ResearchStudyAssociatedPartyComponent
static class	ResearchStudy.ResearchStudyClassificationComponent
static class	ResearchStudy.ResearchStudyComparisonGroupComponent
static class	ResearchStudy.ResearchStudyFocusComponent
static class	ResearchStudy.ResearchStudyLabelComponent
static class	ResearchStudy.ResearchStudyObjectiveComponent
static class	ResearchStudy.ResearchStudyOutcomeMeasureComponent
static class	ResearchStudy.ResearchStudyRecruitmentComponent
static class	ResearchStudy.ResearchStudyStatusDateComponent
static class	ResearchStudy.ResearchStudyWebLocationComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ResearchStudy.ResearchStudyAssociatedPartyComponent>	associatedParty	Sponsors, collaborators, and other parties.
protected List<CodeableConcept>	category	Codes categorizing the type of study such as investigational vs.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected List<ResearchStudy.ResearchStudyClassificationComponent>	classification	Classification for the study.
protected List<ResearchStudy.ResearchStudyComparisonGroupComponent>	comparisonGroup	Describes an expected sequence of events for one of the participants 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 List<ContactDetail>	contact	Contact details to assist a user in learning more about or engaging with the study.
protected List<CodeableConcept>	currentState	Current status of the study.
protected DateTimeType	date	Date the resource last changed.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected MarkdownType	description	A full description of how the study is being conducted.
protected MarkdownType	descriptionSummary	A brief summary of the study description.
protected List<ResearchStudy.ResearchStudyFocusComponent>	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	Fluent Client search parameter constant for focus
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_PARTOF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRINCIPALINVESTIGATOR	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.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SPONSOR	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 List<CodeableConcept>	location	Indicates a country, state or other region where the study is taking place.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	LOCATION	Fluent Client search parameter constant for location
protected StringType	name	Name for this study (computer friendly).
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.
protected List<ResearchStudy.ResearchStudyOutcomeMeasureComponent>	outcomeMeasure	An outcome or planned variable to measure during the study.
protected List<Reference>	partOf	A larger research study of which this particular study is a component or step.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PARTOF	Fluent Client search parameter constant for partof
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.
protected CodeableConcept	primaryPurposeType	The type of study based upon the intent of the study activities.
protected Reference	principalInvestigator	A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRINCIPALINVESTIGATOR	Fluent Client search parameter constant for principalinvestigator
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	RECRUITMENTACTUAL	Fluent Client search parameter constant for recruitment_actual
static final ca.uhn.fhir.rest.gclient.NumberClientParam	RECRUITMENTTARGET	Fluent Client search parameter constant for recruitment_target
protected List<RelatedArtifact>	relatedArtifact	Citations, references 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_CATEGORY	Search parameter: category
static final String	SP_CONDITION	Search parameter: condition
static final String	SP_DATE	Search parameter: date
static final String	SP_FOCUS	Search parameter: focus
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_KEYWORD	Search parameter: keyword
static final String	SP_LOCATION	Search parameter: location
static final String	SP_PARTOF	Search parameter: partof
static final String	SP_PRINCIPALINVESTIGATOR	Search parameter: principalinvestigator
static final String	SP_PROTOCOL	Search parameter: protocol
static final String	SP_RECRUITMENTACTUAL	Search parameter: recruitment_actual
static final String	SP_RECRUITMENTTARGET	Search parameter: recruitment_target
static final String	SP_SITE	Search parameter: site
static final String	SP_SPONSOR	Search parameter: sponsor
static final String	SP_STATUS	Search parameter: status
static final String	SP_TITLE	Search parameter: title
protected Reference	sponsor	An organization that initiates the investigation and is legally responsible for the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SPONSOR	Fluent Client search parameter constant for sponsor
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
protected List<ResearchStudy.ResearchStudyStatusDateComponent>	statusDate	Status of study with time for that status.
protected StringType	title	A short, descriptive label for the study particularly for compouter use.
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	Business identifier for the study record.
protected List<ResearchStudy.ResearchStudyWebLocationComponent>	webLocation	A general storage or archive location for the study.
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, SP_RES_ID

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)
CodeableConcept	addCategory()
ResearchStudy	addCategory(CodeableConcept t)
Base	addChild(String name)
ResearchStudy.ResearchStudyClassificationComponent	addClassification()
ResearchStudy	addClassification(ResearchStudy.ResearchStudyClassificationComponent t)
ResearchStudy.ResearchStudyComparisonGroupComponent	addComparisonGroup()
ResearchStudy	addComparisonGroup(ResearchStudy.ResearchStudyComparisonGroupComponent t)
CodeableConcept	addCondition()
ResearchStudy	addCondition(CodeableConcept t)
ContactDetail	addContact()
ResearchStudy	addContact(ContactDetail t)
CodeableConcept	addCurrentState()
ResearchStudy	addCurrentState(CodeableConcept t)
ResearchStudy.ResearchStudyFocusComponent	addFocus()
ResearchStudy	addFocus(ResearchStudy.ResearchStudyFocusComponent t)
Identifier	addIdentifier()
ResearchStudy	addIdentifier(Identifier t)
CodeableConcept	addKeyword()
ResearchStudy	addKeyword(CodeableConcept t)
ResearchStudy.ResearchStudyLabelComponent	addLabel()
ResearchStudy	addLabel(ResearchStudy.ResearchStudyLabelComponent t)
CodeableConcept	addLocation()
ResearchStudy	addLocation(CodeableConcept 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)
Reference	addProtocol()
ResearchStudy	addProtocol(Reference t)
RelatedArtifact	addRelatedArtifact()
ResearchStudy	addRelatedArtifact(RelatedArtifact t)
Reference	addResult()
ResearchStudy	addResult(Reference t)
Reference	addSite()
ResearchStudy	addSite(Reference t)
ResearchStudy.ResearchStudyStatusDateComponent	addStatusDate()
ResearchStudy	addStatusDate(ResearchStudy.ResearchStudyStatusDateComponent t)
ResearchStudy.ResearchStudyWebLocationComponent	addWebLocation()
ResearchStudy	addWebLocation(ResearchStudy.ResearchStudyWebLocationComponent 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>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<ResearchStudy.ResearchStudyClassificationComponent>	getClassification()
ResearchStudy.ResearchStudyClassificationComponent	getClassificationFirstRep()
List<ResearchStudy.ResearchStudyComparisonGroupComponent>	getComparisonGroup()
ResearchStudy.ResearchStudyComparisonGroupComponent	getComparisonGroupFirstRep()
List<CodeableConcept>	getCondition()
CodeableConcept	getConditionFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
List<CodeableConcept>	getCurrentState()
CodeableConcept	getCurrentStateFirstRep()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
String	getDescriptionSummary()
MarkdownType	getDescriptionSummaryElement()
List<ResearchStudy.ResearchStudyFocusComponent>	getFocus()
ResearchStudy.ResearchStudyFocusComponent	getFocusFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getKeyword()
CodeableConcept	getKeywordFirstRep()
List<ResearchStudy.ResearchStudyLabelComponent>	getLabel()
ResearchStudy.ResearchStudyLabelComponent	getLabelFirstRep()
List<CodeableConcept>	getLocation()
CodeableConcept	getLocationFirstRep()
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()
Reference	getPrincipalInvestigator()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getProtocol()
Reference	getProtocolFirstRep()
ResearchStudy.ResearchStudyRecruitmentComponent	getRecruitment()
List<RelatedArtifact>	getRelatedArtifact()
RelatedArtifact	getRelatedArtifactFirstRep()
ResourceType	getResourceType()
List<Reference>	getResult()
Reference	getResultFirstRep()
List<Reference>	getSite()
Reference	getSiteFirstRep()
Reference	getSponsor()
Enumerations.PublicationStatus	getStatus()
List<ResearchStudy.ResearchStudyStatusDateComponent>	getStatusDate()
ResearchStudy.ResearchStudyStatusDateComponent	getStatusDateFirstRep()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
String	getVersion()
StringType	getVersionElement()
List<ResearchStudy.ResearchStudyWebLocationComponent>	getWebLocation()
ResearchStudy.ResearchStudyWebLocationComponent	getWebLocationFirstRep()
CodeableConcept	getWhyStopped()
boolean	hasAssociatedParty()
boolean	hasCategory()
boolean	hasClassification()
boolean	hasComparisonGroup()
boolean	hasCondition()
boolean	hasContact()
boolean	hasCurrentState()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDescriptionSummary()
boolean	hasDescriptionSummaryElement()
boolean	hasFocus()
boolean	hasIdentifier()
boolean	hasKeyword()
boolean	hasLabel()
boolean	hasLocation()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNote()
boolean	hasObjective()
boolean	hasOutcomeMeasure()
boolean	hasPartOf()
boolean	hasPeriod()
boolean	hasPhase()
boolean	hasPrimaryPurposeType()
boolean	hasPrincipalInvestigator()
boolean	hasProtocol()
boolean	hasRecruitment()
boolean	hasRelatedArtifact()
boolean	hasResult()
boolean	hasSite()
boolean	hasSponsor()
boolean	hasStatus()
boolean	hasStatusDate()
boolean	hasStatusElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	hasWebLocation()
boolean	hasWhyStopped()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ResearchStudy	setAssociatedParty(List<ResearchStudy.ResearchStudyAssociatedPartyComponent> theAssociatedParty)
ResearchStudy	setCategory(List<CodeableConcept> theCategory)
ResearchStudy	setClassification(List<ResearchStudy.ResearchStudyClassificationComponent> theClassification)
ResearchStudy	setComparisonGroup(List<ResearchStudy.ResearchStudyComparisonGroupComponent> theComparisonGroup)
ResearchStudy	setCondition(List<CodeableConcept> theCondition)
ResearchStudy	setContact(List<ContactDetail> theContact)
ResearchStudy	setCurrentState(List<CodeableConcept> theCurrentState)
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<ResearchStudy.ResearchStudyFocusComponent> theFocus)
ResearchStudy	setIdentifier(List<Identifier> theIdentifier)
ResearchStudy	setKeyword(List<CodeableConcept> theKeyword)
ResearchStudy	setLabel(List<ResearchStudy.ResearchStudyLabelComponent> theLabel)
ResearchStudy	setLocation(List<CodeableConcept> theLocation)
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	setPrincipalInvestigator(Reference value)
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	setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
ResearchStudy	setResult(List<Reference> theResult)
ResearchStudy	setSite(List<Reference> theSite)
ResearchStudy	setSponsor(Reference value)
ResearchStudy	setStatus(Enumerations.PublicationStatus value)
ResearchStudy	setStatusDate(List<ResearchStudy.ResearchStudyStatusDateComponent> theStatusDate)
ResearchStudy	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
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	setWebLocation(List<ResearchStudy.ResearchStudyWebLocationComponent> theWebLocation)
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, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Details

url

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

Business identifier for the study record.

name

protected StringType name

Name for this study (computer friendly).

title

protected StringType title

A short, descriptive label for the study particularly for compouter use.

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 and other related documents.

date

protected DateTimeType date

Date the resource last changed.

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.

category

protected List<CodeableConcept> category

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

focus

protected List<ResearchStudy.ResearchStudyFocusComponent> 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.

location

protected List<CodeableConcept> location

Indicates a country, state or other region where the study is taking place.

descriptionSummary

protected MarkdownType descriptionSummary

A brief summary of the study description.

description

protected MarkdownType description

A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.

period

protected Period period

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

contact

protected List<ContactDetail> contact

Contact details to assist a user in learning more about or engaging with the study.

sponsor

protected Reference sponsor

An organization that initiates the investigation and is legally responsible for the study.

principalInvestigator

protected Reference principalInvestigator

A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.

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.

classification

protected List<ResearchStudy.ResearchStudyClassificationComponent> classification

Classification for the study.

associatedParty

protected List<ResearchStudy.ResearchStudyAssociatedPartyComponent> associatedParty

Sponsors, collaborators, and other parties.

currentState

protected List<CodeableConcept> currentState

Current status of the study.

statusDate

protected List<ResearchStudy.ResearchStudyStatusDateComponent> statusDate

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 sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

objective

protected List<ResearchStudy.ResearchStudyObjectiveComponent> objective

A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

outcomeMeasure

protected List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> outcomeMeasure

An outcome or planned variable to measure during the study.

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.

webLocation

protected List<ResearchStudy.ResearchStudyWebLocationComponent> webLocation

A general storage or archive location for the study. This may contain an assortment of content which is not specified in advance.

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Classifications for the study
Type: token
Path: ResearchStudy.category

See Also:

• Constant Field Values

CATEGORY

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

Fluent Client search parameter constant for category

Description: Classifications for the study
Type: token
Path: ResearchStudy.category

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_FOCUS

public static final String SP_FOCUS

Search parameter: focus

Description: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus

See Also:

• Constant Field Values

FOCUS

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

Fluent Client search parameter constant for focus

Description: Drugs, devices, etc. under study
Type: token
Path: ResearchStudy.focus

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_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: Geographic region(s) for study
Type: token
Path: ResearchStudy.location

See Also:

• Constant Field Values

LOCATION

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

Fluent Client search parameter constant for location

Description: Geographic region(s) for study
Type: token
Path: ResearchStudy.location

SP_PARTOF

public static final String SP_PARTOF

Search parameter: partof

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

See Also:

• Constant Field Values

PARTOF

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

Fluent Client search parameter constant for partof

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

INCLUDE_PARTOF

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

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

SP_PRINCIPALINVESTIGATOR

public static final String SP_PRINCIPALINVESTIGATOR

Search parameter: principalinvestigator

Description: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator

See Also:

• Constant Field Values

PRINCIPALINVESTIGATOR

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

Fluent Client search parameter constant for principalinvestigator

Description: Researcher who oversees multiple aspects of the study
Type: reference
Path: ResearchStudy.principalInvestigator

INCLUDE_PRINCIPALINVESTIGATOR

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

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

SP_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_RECRUITMENTACTUAL

public static final String SP_RECRUITMENTACTUAL

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

RECRUITMENTACTUAL

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

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_RECRUITMENTTARGET

public static final String SP_RECRUITMENTTARGET

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

RECRUITMENTTARGET

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

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_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_SPONSOR

public static final String SP_SPONSOR

Search parameter: sponsor

Description: Organization that initiates and is legally responsible for the study
Type: reference
Path: ResearchStudy.sponsor

See Also:

• Constant Field Values

SPONSOR

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

Fluent Client search parameter constant for sponsor

Description: Organization that initiates and is legally responsible for the study
Type: reference
Path: ResearchStudy.sponsor

INCLUDE_SPONSOR

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

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
Type: token
Path: ResearchStudy.status

See Also:

• Constant Field Values

STATUS

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

Fluent Client search parameter constant for status

Description: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
Type: token
Path: ResearchStudy.status

SP_TITLE

public static final String SP_TITLE

Search parameter: title

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

See Also:

• Constant Field Values

TITLE

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

Fluent Client search parameter constant for title

Description: Name for this 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 (Business identifier for the study record.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

hasVersion

public boolean hasVersion()

setVersionElement

public ResearchStudy setVersionElement(StringType value)

Parameters:

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

getVersion

public String getVersion()

Returns:

Business identifier for the study record.

setVersion

public ResearchStudy setVersion(String value)

Parameters:

value - Business identifier 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 (A short, descriptive label for the study particularly for compouter use.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

hasTitle

public boolean hasTitle()

setTitleElement

public ResearchStudy setTitleElement(StringType value)

Parameters:

value - title (A short, descriptive label for the study particularly for compouter use.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

A short, descriptive label for the study particularly for compouter use.

setTitle

public ResearchStudy setTitle(String value)

Parameters:

value - A short, descriptive label for the study particularly for compouter use.

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 and other related documents.)

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 (Date the resource last changed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public ResearchStudy setDateElement(DateTimeType value)

Parameters:

value - date (Date the resource last changed.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

Date the resource last changed.

setDate

public ResearchStudy setDate(Date value)

Parameters:

value - Date the resource last changed.

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

getCategory

public List<CodeableConcept> getCategory()

Returns:

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

setCategory

public ResearchStudy setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public ResearchStudy addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

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

getFocus

public List<ResearchStudy.ResearchStudyFocusComponent> 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<ResearchStudy.ResearchStudyFocusComponent> theFocus)

Returns:

Returns a reference to this for easy method chaining

hasFocus

public boolean hasFocus()

addFocus

public ResearchStudy.ResearchStudyFocusComponent addFocus()

addFocus

public ResearchStudy addFocus(ResearchStudy.ResearchStudyFocusComponent t)

getFocusFirstRep

public ResearchStudy.ResearchStudyFocusComponent 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}

getLocation

public List<CodeableConcept> getLocation()

Returns:

location (Indicates a country, state or other region where the study is taking place.)

setLocation

public ResearchStudy setLocation(List<CodeableConcept> theLocation)

Returns:

Returns a reference to this for easy method chaining

hasLocation

public boolean hasLocation()

addLocation

public CodeableConcept addLocation()

addLocation

public ResearchStudy addLocation(CodeableConcept t)

getLocationFirstRep

public CodeableConcept getLocationFirstRep()

Returns:

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

getDescriptionSummaryElement

public MarkdownType getDescriptionSummaryElement()

Returns:

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

hasDescriptionSummaryElement

public boolean hasDescriptionSummaryElement()

hasDescriptionSummary

public boolean hasDescriptionSummary()

setDescriptionSummaryElement

public ResearchStudy setDescriptionSummaryElement(MarkdownType value)

Parameters:

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

getDescriptionSummary

public String getDescriptionSummary()

Returns:

A brief summary of the study description.

setDescriptionSummary

public ResearchStudy setDescriptionSummary(String value)

Parameters:

value - A brief summary of the study description.

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public ResearchStudy setDescriptionElement(MarkdownType value)

Parameters:

value - description (A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.

setDescription

public ResearchStudy setDescription(String value)

Parameters:

value - A full description of how the study is being conducted. For a description of what the study objectives are see ResearchStudy.objective.description.

getPeriod

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

getContact

public List<ContactDetail> getContact()

Returns:

contact (Contact details to assist a user in learning more about or engaging with the study.)

setContact

public ResearchStudy setContact(List<ContactDetail> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public ContactDetail addContact()

addContact

public ResearchStudy addContact(ContactDetail t)

getContactFirstRep

public ContactDetail getContactFirstRep()

Returns:

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

getSponsor

public Reference getSponsor()

Returns:

sponsor (An organization that initiates the investigation and is legally responsible for the study.)

hasSponsor

public boolean hasSponsor()

setSponsor

public ResearchStudy setSponsor(Reference value)

Parameters:

value - sponsor (An organization that initiates the investigation and is legally responsible for the study.)

getPrincipalInvestigator

public Reference getPrincipalInvestigator()

Returns:

principalInvestigator (A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)

hasPrincipalInvestigator

public boolean hasPrincipalInvestigator()

setPrincipalInvestigator

public ResearchStudy setPrincipalInvestigator(Reference value)

Parameters:

value - principalInvestigator (A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)

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}

getClassification

public List<ResearchStudy.ResearchStudyClassificationComponent> getClassification()

Returns:

classification (Classification for the study.)

setClassification

public ResearchStudy setClassification(List<ResearchStudy.ResearchStudyClassificationComponent> theClassification)

Returns:

Returns a reference to this for easy method chaining

hasClassification

public boolean hasClassification()

addClassification

public ResearchStudy.ResearchStudyClassificationComponent addClassification()

addClassification

public ResearchStudy addClassification(ResearchStudy.ResearchStudyClassificationComponent t)

getClassificationFirstRep

public ResearchStudy.ResearchStudyClassificationComponent getClassificationFirstRep()

Returns:

The first repetition of repeating field classification, 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}

getCurrentState

public List<CodeableConcept> getCurrentState()

Returns:

currentState (Current status of the study.)

setCurrentState

public ResearchStudy setCurrentState(List<CodeableConcept> theCurrentState)

Returns:

Returns a reference to this for easy method chaining

hasCurrentState

public boolean hasCurrentState()

addCurrentState

public CodeableConcept addCurrentState()

addCurrentState

public ResearchStudy addCurrentState(CodeableConcept t)

getCurrentStateFirstRep

public CodeableConcept getCurrentStateFirstRep()

Returns:

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

getStatusDate

public List<ResearchStudy.ResearchStudyStatusDateComponent> getStatusDate()

Returns:

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

setStatusDate

public ResearchStudy setStatusDate(List<ResearchStudy.ResearchStudyStatusDateComponent> theStatusDate)

Returns:

Returns a reference to this for easy method chaining

hasStatusDate

public boolean hasStatusDate()

addStatusDate

public ResearchStudy.ResearchStudyStatusDateComponent addStatusDate()

addStatusDate

public ResearchStudy addStatusDate(ResearchStudy.ResearchStudyStatusDateComponent t)

getStatusDateFirstRep

public ResearchStudy.ResearchStudyStatusDateComponent getStatusDateFirstRep()

Returns:

The first repetition of repeating field statusDate, 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 sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.)

setComparisonGroup

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

Returns:

Returns a reference to this for easy method chaining

hasComparisonGroup

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 or planned variable to measure during the study.)

setOutcomeMeasure

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

Returns:

Returns a reference to this for easy method chaining

hasOutcomeMeasure

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}

getWebLocation

public List<ResearchStudy.ResearchStudyWebLocationComponent> getWebLocation()

Returns:

webLocation (A general storage or archive location for the study. This may contain an assortment of content which is not specified in advance.)

setWebLocation

public ResearchStudy setWebLocation(List<ResearchStudy.ResearchStudyWebLocationComponent> theWebLocation)

Returns:

Returns a reference to this for easy method chaining

hasWebLocation

public boolean hasWebLocation()

addWebLocation

public ResearchStudy.ResearchStudyWebLocationComponent addWebLocation()

addWebLocation

public ResearchStudy addWebLocation(ResearchStudy.ResearchStudyWebLocationComponent t)

getWebLocationFirstRep

public ResearchStudy.ResearchStudyWebLocationComponent getWebLocationFirstRep()

Returns:

The first repetition of repeating field webLocation, 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

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

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