HS.FHIRModel.R4.ResearchStudy
class HS.FHIRModel.R4.ResearchStudy extends HS.FHIRModel.FHIRClassSuper
******************************************* ResearchStudy generated class schema
*****************************************
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.
Property Inventory
- _description
- _implicitRules
- _language
- _status
- _title
- arm
- category
- condition
- contact
- contained
- description
- enrollment
- extension
- fhirID
- focus
- identifier
- implicitRules
- keyword
- language
- location
- meta
- modifierExtension
- note
- objective
- partOf
- period
- phase
- primaryPurposeType
- principalInvestigator
- protocol
- reasonStopped
- relatedArtifact
- resourceType
- site
- sponsor
- status
- text
- title
Method Inventory
- IncludeArm()
- IncludeCategory()
- IncludeCondition()
- IncludeContact()
- IncludeContained()
- IncludeEnrollment()
- IncludeExtension()
- IncludeFocus()
- IncludeIdentifier()
- IncludeKeyword()
- IncludeLocation()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNote()
- IncludeObjective()
- IncludePartOf()
- IncludePeriod()
- IncludePhase()
- IncludePrimaryPurposeType()
- IncludePrincipalInvestigator()
- IncludeProtocol()
- IncludeReasonStopped()
- IncludeRelatedArtifact()
- IncludeSite()
- IncludeSponsor()
- IncludeText()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_RESEARCHSTUDY;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property arm as HS.FHIRModel.R4.ResearchStudyX.SeqOfResearchStudyXArm;
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.
Property methods: armGet(), armGetSwizzled(), armIsValid(), armNewObject(), armSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
Codes categorizing the type of study such as investigational vs.
observational, type of blinding, type of randomization, safety vs.
efficacy, etc.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property condition as HS.FHIRModel.R4.SeqOfCodeableConcept;
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.
Property methods: conditionGet(), conditionGetSwizzled(), conditionIsValid(), conditionNewObject(), conditionSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in learning more about or engaging
with the study.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property description as %String;
A full description of how the study is being conducted.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property enrollment as HS.FHIRModel.R4.SeqOfReference;
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".
Property methods: enrollmentGet(), enrollmentGetSwizzled(), enrollmentIsValid(), enrollmentNewObject(), enrollmentSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property focus as HS.FHIRModel.R4.SeqOfCodeableConcept;
The medication(s), food(s), therapy(ies), device(s) or other concerns
or interventions that the study is seeking to gain more information
about.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers assigned to this research study by the sponsor or other
systems.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property keyword as HS.FHIRModel.R4.SeqOfCodeableConcept;
Key terms to aid in searching for or filtering the study.
Property methods: keywordGet(), keywordGetSwizzled(), keywordIsValid(), keywordNewObject(), keywordSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.SeqOfCodeableConcept;
Indicates a country, state or other region where the study is taking
place.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property note as HS.FHIRModel.R4.SeqOfAnnotation;
Comments made about the study by the performer, subject or other
participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property objective as HS.FHIRModel.R4.ResearchStudyX.SeqOfResearchStudyXObjective;
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.
Property methods: objectiveGet(), objectiveGetSwizzled(), objectiveIsValid(), objectiveNewObject(), objectiveSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger research study of which this particular study is a component
or step.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property period as HS.FHIRModel.R4.Period;
Identifies the start date and the expected (or actual, depending
on status) end date for the study.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property phase as HS.FHIRModel.R4.CodeableConcept;
The stage in the progression of a therapy from initial experimental
use in humans in clinical trials to post-market evaluation.
Property methods: phaseGet(), phaseGetSwizzled(), phaseIsValid(), phaseNewObject(), phaseSet()
property primaryPurposeType as HS.FHIRModel.R4.CodeableConcept;
The type of study based upon the intent of the study's activities.
A classification of the intent of the study.
Property methods: primaryPurposeTypeGet(), primaryPurposeTypeGetSwizzled(), primaryPurposeTypeIsValid(), primaryPurposeTypeNewObject(), primaryPurposeTypeSet()
property principalInvestigator as HS.FHIRModel.R4.Reference;
A researcher in a study who oversees multiple aspects of the study,
such as concept development, protocol writing, protocol submission
for IRB approval, participant recruitment, informed consent, data
collection, analysis, interpretation and presentation.
Property methods: principalInvestigatorGet(), principalInvestigatorGetSwizzled(), principalInvestigatorIsValid(), principalInvestigatorNewObject(), principalInvestigatorSet()
property protocol as HS.FHIRModel.R4.SeqOfReference;
The set of steps expected to be performed as part of the execution
of the study.
Property methods: protocolGet(), protocolGetSwizzled(), protocolIsValid(), protocolNewObject(), protocolSet()
property reasonStopped as HS.FHIRModel.R4.CodeableConcept;
A description and/or code explaining the premature termination of
the study.
Property methods: reasonStoppedGet(), reasonStoppedGetSwizzled(), reasonStoppedIsValid(), reasonStoppedNewObject(), reasonStoppedSet()
Citations, references and other related documents.
Property methods: relatedArtifactGet(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactNewObject(), relatedArtifactSet()
property resourceType as %String [ InitialExpression = "ResearchStudy" , Required ];
This is a ResearchStudy resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property site as HS.FHIRModel.R4.SeqOfReference;
A facility in which study activities are conducted.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property sponsor as HS.FHIRModel.R4.Reference;
An organization that initiates the investigation and is legally responsible
for the study.
Property methods: sponsorGet(), sponsorGetSwizzled(), sponsorIsValid(), sponsorNewObject(), sponsorSet()
property status as %String (VALUELIST = ",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");
The current state of the study.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive user-friendly label for the study.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
Methods
method IncludeArm()
method IncludeCategory()
method IncludeCondition()
method IncludeContact()
method IncludeContained()
method IncludeEnrollment()
method IncludeExtension()
method IncludeFocus()
method IncludeIdentifier()
method IncludeKeyword()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeObjective()
method IncludePartOf()
method IncludePeriod()
method IncludePhase()
method IncludePrimaryPurposeType()
method IncludePrincipalInvestigator()
method IncludeProtocol()
method IncludeReasonStopped()
method IncludeRelatedArtifact()
method IncludeSite()
method IncludeSponsor()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.ResearchStudy
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()