Package org.hl7.fhir.dstu3.model

Class ResearchStudy

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.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.ResearchStudyArmComponent
static enum	ResearchStudy.ResearchStudyStatus
static class	ResearchStudy.ResearchStudyStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ResearchStudy.ResearchStudyArmComponent>	arm	Describes an expected sequence of events for one of the participants of a study.
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<ContactDetail>	contact	Contact details to assist a user in learning more about or engaging with the study.
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 List<Reference>	enrollment	Reference to a Group that defines the criteria for and quantity of subjects participating in the study.
protected List<Group>	enrollmentTarget	The actual objects that are the target of the reference (Reference to a Group that defines the criteria for and quantity of subjects participating in the study.
protected List<CodeableConcept>	focus	The condition(s), 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>	jurisdiction	Indicates a country, state or other region where the study is taking place.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
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<Annotation>	note	Comments made about the event by the performer, subject or other participants.
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 List<ResearchStudy>	partOfTarget	The actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)
protected Period	period	Identifies the start date and the expected (or actual, depending on status) end date for the study.
protected Reference	principalInvestigator	Indicates the individual who has primary oversite of the execution of the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRINCIPALINVESTIGATOR	Fluent Client search parameter constant for principalinvestigator
protected Practitioner	principalInvestigatorTarget	The actual object that is the target of the reference (Indicates the individual who has primary oversite of the execution of the study.)
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 List<PlanDefinition>	protocolTarget	The actual objects that are the target of the reference (The set of steps expected to be performed as part of the execution of the study.)
protected CodeableConcept	reasonStopped	A description and/or code explaining the premature termination of the study.
protected List<RelatedArtifact>	relatedArtifact	Citations, references and other related documents.
protected List<Reference>	site	Clinic, hospital or other healthcare location that is participating in the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SITE	Fluent Client search parameter constant for site
protected List<Location>	siteTarget	The actual objects that are the target of the reference (Clinic, hospital or other healthcare location that is participating in the study.)
static final String	SP_CATEGORY	Search parameter: category
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_JURISDICTION	Search parameter: jurisdiction
static final String	SP_KEYWORD	Search parameter: keyword
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_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	The organization responsible for the execution of the study.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SPONSOR	Fluent Client search parameter constant for sponsor
protected Organization	sponsorTarget	The actual object that is the target of the reference (The organization responsible for the execution of the study.)
protected Enumeration<ResearchStudy.ResearchStudyStatus>	status	The current state of the study.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected StringType	title	A short, descriptive user-friendly label for the study.
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.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(Enumeration<ResearchStudy.ResearchStudyStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
ResearchStudy.ResearchStudyArmComponent	addArm()
ResearchStudy	addArm(ResearchStudy.ResearchStudyArmComponent t)
CodeableConcept	addCategory()
ResearchStudy	addCategory(CodeableConcept t)
Base	addChild(String name)
ContactDetail	addContact()
ResearchStudy	addContact(ContactDetail t)
Reference	addEnrollment()
ResearchStudy	addEnrollment(Reference t)
Group	addEnrollmentTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	addFocus()
ResearchStudy	addFocus(CodeableConcept t)
Identifier	addIdentifier()
ResearchStudy	addIdentifier(Identifier t)
CodeableConcept	addJurisdiction()
ResearchStudy	addJurisdiction(CodeableConcept t)
CodeableConcept	addKeyword()
ResearchStudy	addKeyword(CodeableConcept t)
Annotation	addNote()
ResearchStudy	addNote(Annotation t)
Reference	addPartOf()
ResearchStudy	addPartOf(Reference t)
ResearchStudy	addPartOfTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addProtocol()
ResearchStudy	addProtocol(Reference t)
PlanDefinition	addProtocolTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
RelatedArtifact	addRelatedArtifact()
ResearchStudy	addRelatedArtifact(RelatedArtifact t)
Reference	addSite()
ResearchStudy	addSite(Reference t)
Location	addSiteTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ResearchStudy	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ResearchStudy.ResearchStudyArmComponent>	getArm()
ResearchStudy.ResearchStudyArmComponent	getArmFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
String	getDescription()
MarkdownType	getDescriptionElement()
List<Reference>	getEnrollment()
Reference	getEnrollmentFirstRep()
List<Group>	getEnrollmentTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getFocus()
CodeableConcept	getFocusFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
List<CodeableConcept>	getKeyword()
CodeableConcept	getKeywordFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
List<Reference>	getPartOf()
Reference	getPartOfFirstRep()
List<ResearchStudy>	getPartOfTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Period	getPeriod()
Reference	getPrincipalInvestigator()
Practitioner	getPrincipalInvestigatorTarget()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getProtocol()
Reference	getProtocolFirstRep()
List<PlanDefinition>	getProtocolTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getReasonStopped()
List<RelatedArtifact>	getRelatedArtifact()
RelatedArtifact	getRelatedArtifactFirstRep()
ResourceType	getResourceType()
List<Reference>	getSite()
Reference	getSiteFirstRep()
List<Location>	getSiteTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	getSponsor()
Organization	getSponsorTarget()
ResearchStudy.ResearchStudyStatus	getStatus()
Enumeration<ResearchStudy.ResearchStudyStatus>	getStatusElement()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasArm()
boolean	hasCategory()
boolean	hasContact()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEnrollment()
boolean	hasFocus()
boolean	hasIdentifier()
boolean	hasJurisdiction()
boolean	hasKeyword()
boolean	hasNote()
boolean	hasPartOf()
boolean	hasPeriod()
boolean	hasPrincipalInvestigator()
boolean	hasProtocol()
boolean	hasReasonStopped()
boolean	hasRelatedArtifact()
boolean	hasSite()
boolean	hasSponsor()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ResearchStudy	setArm(List<ResearchStudy.ResearchStudyArmComponent> theArm)
ResearchStudy	setCategory(List<CodeableConcept> theCategory)
ResearchStudy	setContact(List<ContactDetail> theContact)
ResearchStudy	setDescription(String value)
ResearchStudy	setDescriptionElement(MarkdownType value)
ResearchStudy	setEnrollment(List<Reference> theEnrollment)
ResearchStudy	setFocus(List<CodeableConcept> theFocus)
ResearchStudy	setIdentifier(List<Identifier> theIdentifier)
ResearchStudy	setJurisdiction(List<CodeableConcept> theJurisdiction)
ResearchStudy	setKeyword(List<CodeableConcept> theKeyword)
ResearchStudy	setNote(List<Annotation> theNote)
ResearchStudy	setPartOf(List<Reference> thePartOf)
ResearchStudy	setPeriod(Period value)
ResearchStudy	setPrincipalInvestigator(Reference value)
ResearchStudy	setPrincipalInvestigatorTarget(Practitioner value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ResearchStudy	setProtocol(List<Reference> theProtocol)
ResearchStudy	setReasonStopped(CodeableConcept value)
ResearchStudy	setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
ResearchStudy	setSite(List<Reference> theSite)
ResearchStudy	setSponsor(Reference value)
ResearchStudy	setSponsorTarget(Organization value)
ResearchStudy	setStatus(ResearchStudy.ResearchStudyStatus value)
ResearchStudy	setStatusElement(Enumeration<ResearchStudy.ResearchStudyStatus> value)
ResearchStudy	setTitle(String value)
ResearchStudy	setTitleElement(StringType value)
protected ResearchStudy	typedCopy()

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

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

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

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

title

protected StringType title

A short, descriptive user-friendly label for the study.

protocol

protected List<Reference> protocol

The set of steps expected to be performed as part of the execution of the study.

protocolTarget

protected List<PlanDefinition> protocolTarget

The actual objects that are the target of the reference (The set of steps expected to be performed as part of the execution of the study.)

partOf

protected List<Reference> partOf

A larger research study of which this particular study is a component or step.

partOfTarget

protected List<ResearchStudy> partOfTarget

The actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)

status

protected Enumeration<ResearchStudy.ResearchStudyStatus> status

The current state of the study.

category

protected List<CodeableConcept> category

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

focus

protected List<CodeableConcept> focus

The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

contact

protected List<ContactDetail> contact

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

relatedArtifact

protected List<RelatedArtifact> relatedArtifact

Citations, references and other related documents.

keyword

protected List<CodeableConcept> keyword

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

jurisdiction

protected List<CodeableConcept> jurisdiction

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

description

protected MarkdownType description

A full description of how the study is being conducted.

enrollment

protected List<Reference> enrollment

Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".

enrollmentTarget

protected List<Group> enrollmentTarget

The actual objects that are the target of the reference (Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".)

period

protected Period period

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

sponsor

protected Reference sponsor

The organization responsible for the execution of the study.

sponsorTarget

protected Organization sponsorTarget

The actual object that is the target of the reference (The organization responsible for the execution of the study.)

principalInvestigator

protected Reference principalInvestigator

Indicates the individual who has primary oversite of the execution of the study.

principalInvestigatorTarget

protected Practitioner principalInvestigatorTarget

The actual object that is the target of the reference (Indicates the individual who has primary oversite of the execution of the study.)

site

protected List<Reference> site

Clinic, hospital or other healthcare location that is participating in the study.

siteTarget

protected List<Location> siteTarget

The actual objects that are the target of the reference (Clinic, hospital or other healthcare location that is participating in the study.)

reasonStopped

protected CodeableConcept reasonStopped

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

note

protected List<Annotation> note

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

arm

protected List<ResearchStudy.ResearchStudyArmComponent> arm

Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

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

public static final String SP_SPONSOR

Search parameter: sponsor

Description: Organization 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 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_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

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

See Also:

• Constant Field Values

JURISDICTION

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

Fluent Client search parameter constant for jurisdiction

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

SP_FOCUS

public static final String SP_FOCUS

Search parameter: focus

Description: Drugs, devices, conditions, 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, conditions, etc. under study
Type: token
Path: ResearchStudy.focus

SP_PRINCIPALINVESTIGATOR

public static final String SP_PRINCIPALINVESTIGATOR

Search parameter: principalinvestigator

Description: The individual responsible for 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: The individual responsible for the study
Type: reference
Path: ResearchStudy.principalInvestigator

INCLUDE_PRINCIPALINVESTIGATOR

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

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

SP_TITLE

public static final String SP_TITLE

Search parameter: 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

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_SITE

public static final String SP_SITE

Search parameter: site

Description: Location involved in study execution
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: Location involved in study execution
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_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_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_STATUS

public static final String SP_STATUS

Search parameter: status

Description: draft | in-progress | suspended | stopped | completed | entered-in-error
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: draft | in-progress | suspended | stopped | completed | entered-in-error
Type: token
Path: ResearchStudy.status

Constructor Details

ResearchStudy

public ResearchStudy()

Constructor

ResearchStudy

public ResearchStudy(Enumeration<ResearchStudy.ResearchStudyStatus> status)

Constructor

Method Details

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

getTitleElement

public StringType getTitleElement()

Returns:

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

hasTitleElement

public boolean hasTitleElement()

hasTitle

public boolean hasTitle()

setTitleElement

public ResearchStudy setTitleElement(StringType value)

Parameters:

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

getTitle

public String getTitle()

Returns:

A short, descriptive user-friendly label for the study.

setTitle

public ResearchStudy setTitle(String value)

Parameters:

value - A short, descriptive user-friendly label for the study.

getProtocol

public List<Reference> getProtocol()

Returns:

protocol (The set of steps expected to be performed as part of the execution of the study.)

setProtocol

public ResearchStudy setProtocol(List<Reference> theProtocol)

Returns:

Returns a reference to 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

getProtocolTarget

@Deprecated
public List<PlanDefinition> getProtocolTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addProtocolTarget

@Deprecated
public PlanDefinition addProtocolTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getPartOf

public List<Reference> getPartOf()

Returns:

partOf (A larger research study of which this particular study is a component or step.)

setPartOf

public ResearchStudy setPartOf(List<Reference> thePartOf)

Returns:

Returns a reference to 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

getPartOfTarget

@Deprecated
public List<ResearchStudy> getPartOfTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addPartOfTarget

@Deprecated
public ResearchStudy addPartOfTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getStatusElement

public Enumeration<ResearchStudy.ResearchStudyStatus> getStatusElement()

Returns:

status (The current state of the study.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public ResearchStudy setStatusElement(Enumeration<ResearchStudy.ResearchStudyStatus> value)

Parameters:

value - status (The current state of the study.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public ResearchStudy.ResearchStudyStatus getStatus()

Returns:

The current state of the study.

setStatus

public ResearchStudy setStatus(ResearchStudy.ResearchStudyStatus value)

Parameters:

value - The current state of the study.

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

getFocus

public List<CodeableConcept> getFocus()

Returns:

focus (The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.)

setFocus

public ResearchStudy setFocus(List<CodeableConcept> theFocus)

Returns:

Returns a reference to this for easy method chaining

hasFocus

public boolean hasFocus()

addFocus

public CodeableConcept addFocus()

addFocus

public ResearchStudy addFocus(CodeableConcept t)

getFocusFirstRep

public CodeableConcept getFocusFirstRep()

Returns:

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

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

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

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

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Returns:

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

setJurisdiction

public ResearchStudy setJurisdiction(List<CodeableConcept> theJurisdiction)

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

addJurisdiction

public CodeableConcept addJurisdiction()

addJurisdiction

public ResearchStudy addJurisdiction(CodeableConcept t)

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Returns:

The first repetition of repeating field jurisdiction, creating it if it does not already exist

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (A full description of how the study is being conducted.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public ResearchStudy setDescriptionElement(MarkdownType value)

Parameters:

value - description (A full description of how the study is being conducted.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A full description of how the study is being conducted.

setDescription

public ResearchStudy setDescription(String value)

Parameters:

value - A full description of how the study is being conducted.

getEnrollment

public List<Reference> getEnrollment()

Returns:

enrollment (Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".)

setEnrollment

public ResearchStudy setEnrollment(List<Reference> theEnrollment)

Returns:

Returns a reference to this for easy method chaining

hasEnrollment

public boolean hasEnrollment()

addEnrollment

public Reference addEnrollment()

addEnrollment

public ResearchStudy addEnrollment(Reference t)

getEnrollmentFirstRep

public Reference getEnrollmentFirstRep()

Returns:

The first repetition of repeating field enrollment, creating it if it does not already exist

getEnrollmentTarget

@Deprecated
public List<Group> getEnrollmentTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addEnrollmentTarget

@Deprecated
public Group addEnrollmentTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getPeriod

public Period getPeriod()

Returns:

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

hasPeriod

public boolean hasPeriod()

setPeriod

public ResearchStudy setPeriod(Period value)

Parameters:

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

getSponsor

public Reference getSponsor()

Returns:

sponsor (The organization responsible for the execution of the study.)

hasSponsor

public boolean hasSponsor()

setSponsor

public ResearchStudy setSponsor(Reference value)

Parameters:

value - sponsor (The organization responsible for the execution of the study.)

getSponsorTarget

public Organization getSponsorTarget()

Returns:

sponsor The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization responsible for the execution of the study.)

setSponsorTarget

public ResearchStudy setSponsorTarget(Organization value)

Parameters:

value - sponsor The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization responsible for the execution of the study.)

getPrincipalInvestigator

public Reference getPrincipalInvestigator()

Returns:

principalInvestigator (Indicates the individual who has primary oversite of the execution of the study.)

hasPrincipalInvestigator

public boolean hasPrincipalInvestigator()

setPrincipalInvestigator

public ResearchStudy setPrincipalInvestigator(Reference value)

Parameters:

value - principalInvestigator (Indicates the individual who has primary oversite of the execution of the study.)

getPrincipalInvestigatorTarget

public Practitioner getPrincipalInvestigatorTarget()

Returns:

principalInvestigator The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the individual who has primary oversite of the execution of the study.)

setPrincipalInvestigatorTarget

public ResearchStudy setPrincipalInvestigatorTarget(Practitioner value)

Parameters:

value - principalInvestigator The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the individual who has primary oversite of the execution of the study.)

getSite

public List<Reference> getSite()

Returns:

site (Clinic, hospital or other healthcare location that is participating in the study.)

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

getSiteTarget

@Deprecated
public List<Location> getSiteTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addSiteTarget

@Deprecated
public Location addSiteTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getReasonStopped

public CodeableConcept getReasonStopped()

Returns:

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

hasReasonStopped

public boolean hasReasonStopped()

setReasonStopped

public ResearchStudy setReasonStopped(CodeableConcept value)

Parameters:

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

getNote

public List<Annotation> getNote()

Returns:

note (Comments made about the event 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

getArm

public List<ResearchStudy.ResearchStudyArmComponent> getArm()

Returns:

arm (Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.)

setArm

public ResearchStudy setArm(List<ResearchStudy.ResearchStudyArmComponent> theArm)

Returns:

Returns a reference to this for easy method chaining

hasArm

public boolean hasArm()

addArm

public ResearchStudy.ResearchStudyArmComponent addArm()

addArm

public ResearchStudy addArm(ResearchStudy.ResearchStudyArmComponent t)

getArmFirstRep

public ResearchStudy.ResearchStudyArmComponent getArmFirstRep()

Returns:

The first repetition of repeating field arm, creating it if it does not already exist

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

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