ResearchStudy class
ResearchStudy A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
ResearchStudy({@Default(R5ResourceType.ResearchStudy) @JsonKey(unknownEnumValue: R5ResourceType.ResearchStudy) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, List<Identifier> ? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, List<ResearchStudyLabel> ? label, List<Reference> ? protocol, List<Reference> ? partOf, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? primaryPurposeType, CodeableConcept? phase, List<CodeableConcept> ? studyDesign, List<CodeableReference> ? focus, List<CodeableConcept> ? condition, List<CodeableConcept> ? keyword, List<CodeableConcept> ? region, FhirMarkdown? descriptionSummary, @JsonKey(name: '_descriptionSummary') Element? descriptionSummaryElement, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, Period? period, List<Reference> ? site, List<Annotation> ? note, List<CodeableConcept> ? classifier, List<ResearchStudyAssociatedParty> ? associatedParty, List<ResearchStudyProgressStatus> ? progressStatus, CodeableConcept? whyStopped, ResearchStudyRecruitment? recruitment, List<ResearchStudyComparisonGroup> ? comparisonGroup, List<ResearchStudyObjective> ? objective, List<ResearchStudyOutcomeMeasure> ? outcomeMeasure, List<Reference> ? result}) -
ResearchStudy A scientific study of nature that sometimes includes
processes involved in health and disease. For example, clinical trials
are research studies that involve people. These studies may be related
to new ways to screen, prevent, diagnose, and treat disease. They may
also study certain outcomes and certain groups of people by looking at
data collected in the past or future.
constfactory
-
ResearchStudy.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- ResearchStudy.fromJsonString(String source)
-
Acts like a constructor, returns a ResearchStudy, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- ResearchStudy.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
associatedParty
→ List<
ResearchStudyAssociatedParty> ? -
associatedParty Sponsors, collaborators, and other parties.
no setterinherited
-
classifier
→ List<
CodeableConcept> ? -
classifier Additional grouping mechanism or categorization of a
research study. Example: FDA regulated device, FDA regulated drug, MPG
Paragraph 23b (a German legal requirement), IRB-exempt, etc.
Implementation Note: do not use the classifier element to support
existing semantics that are already supported thru explicit elements
in the resource.
no setterinherited
-
comparisonGroup
→ List<
ResearchStudyComparisonGroup> ? -
comparisonGroup Describes an expected event or sequence of events for
one of the subjects of a study. E.g. for a living subject: exposure to
drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a
stability study: {store sample from lot A at 25 degrees for 1 month},
{store sample from lot A at 40 degrees for 1 month}.
no setterinherited
-
condition
→ 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.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $ResearchStudyCopyWith<
ResearchStudy> -
no setterinherited
- date → FhirDateTime?
-
date The date (and optionally time) when the ResearchStudy Resource
was last significantly changed. The date must change when the business
version changes and it must change if the status code changes. In
addition, it should change when the substantive content of the
ResearchStudy Resource changes.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- description → FhirMarkdown?
-
description A detailed and human-readable narrative of the study.
E.g., study abstract.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- descriptionSummary → FhirMarkdown?
-
descriptionSummary A brief text for explaining the study.
no setterinherited
- descriptionSummaryElement → Element?
-
descriptionSummaryElement ("_descriptionSummary") Extensions for
descriptionSummary
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") 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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
focus
→ List<
CodeableReference> ? -
focus The medication(s), food(s), therapy(ies), device(s) or other
concerns or interventions that the study is seeking to gain more
information about.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifiers assigned to this research study by the sponsor
or other systems.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules 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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
-
keyword
→ List<
CodeableConcept> ? -
keyword Key terms to aid in searching for or filtering the study.
no setterinherited
-
label
→ List<
ResearchStudyLabel> ? -
label Additional names for the study.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension 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 managable, 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).
no setterinherited
- name → String?
-
name Name for this study (computer friendly).
no setterinherited
- nameElement → Element?
-
nameElement ("_name") Extensions for name
no setterinherited
-
note
→ List<
Annotation> ? -
note Comments made about the study by the performer, subject or other
participants.
no setterinherited
-
objective
→ List<
ResearchStudyObjective> ? -
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.
no setterinherited
-
outcomeMeasure
→ List<
ResearchStudyOutcomeMeasure> ? -
outcomeMeasure An "outcome measure", "endpoint", "effect measure" or
"measure of effect" is a specific measurement or observation used to
quantify the effect of experimental variables on the participants in a
study, or for observational studies, to describe patterns of diseases
or traits or associations with exposures, risk factors or treatment.
no setterinherited
-
partOf
→ List<
Reference> ? -
partOf A larger research study of which this particular study is a
component or step.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- period → Period?
-
period Identifies the start date and the expected (or actual,
depending on status) end date for the study.
no setterinherited
- phase → CodeableConcept?
-
phase The stage in the progression of a therapy from initial
experimental use in humans in clinical trials to post-market
evaluation.
no setterinherited
- primaryPurposeType → CodeableConcept?
-
primaryPurposeType The type of study based upon the intent of the
study activities. A classification of the intent of the study.
no setterinherited
-
progressStatus
→ List<
ResearchStudyProgressStatus> ? -
progressStatus Status of study with time for that status.
no setterinherited
-
protocol
→ List<
Reference> ? -
protocol The set of steps expected to be performed as part of the
execution of the study.
no setterinherited
- recruitment → ResearchStudyRecruitment?
-
recruitment Target or actual group of participants enrolled in study.
no setterinherited
-
region
→ List<
CodeableConcept> ? -
region A country, state or other area where the study is taking place
rather than its precise geographic location or address.
no setterinherited
-
relatedArtifact Citations, references, URLs and other related
documents. When using relatedArtifact to share URLs, the
relatedArtifact.type will often be set to one of "documentation" or
"supported-with" and the URL value will often be in
relatedArtifact.document.url but another possible location is
relatedArtifact.resource when it is a canonical URL.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a ResearchStudy resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
-
result
→ 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.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
site
→ List<
Reference> ? -
site A facility in which study activities are conducted.
no setterinherited
- status → FhirCode?
-
status The publication state of the resource (not of the study).
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
-
studyDesign
→ List<
CodeableConcept> ? -
studyDesign Codes categorizing the type of study such as
investigational vs. observational, type of blinding, type of
randomization, safety vs. efficacy, etc.
no setterinherited
- text → Narrative?
-
text 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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title The human readable name of the research study.
no setterinherited
- titleElement → Element?
-
titleElement ("_title") Extensions for title
no setterinherited
- url → FhirUri?
-
url Canonical identifier for this study resource, represented as a
globally unique URI.
no setterinherited
- urlElement → Element?
-
urlElement ("_url") Extensions for url
no setterinherited
- version → String?
-
version The business version for the study record.
no setterinherited
- versionElement → Element?
-
versionElement ("_version") Extensions for version
no setterinherited
- whyStopped → CodeableConcept?
-
whyStopped A description and/or code explaining the premature
termination of the study.
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited