ResearchStudy class

ResearchStudy A process where a researcher or organization plans and

Mixed in types

• Resource

Annotations

• @freezed

Constructors

ResearchStudy({@Default(R4ResourceType.ResearchStudy) @JsonKey(unknownEnumValue: R4ResourceType.ResearchStudy) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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, List<Identifier>? identifier, String? title, @JsonKey(name: '_title') Element? titleElement, List<Reference>? protocol, List<Reference>? partOf, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? primaryPurposeType, CodeableConcept? phase, List<CodeableConcept>? category, List<CodeableConcept>? focus, List<CodeableConcept>? condition, List<ContactDetail>? contact, List<RelatedArtifact>? relatedArtifact, List<CodeableConcept>? keyword, List<CodeableConcept>? location, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<Reference>? enrollment, Period? period, Reference? sponsor, Reference? principalInvestigator, List<Reference>? site, CodeableConcept? reasonStopped, List<Annotation>? note, List<ResearchStudyArm>? arm, List<ResearchStudyObjective>? objective})

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

const

factory

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

arm → List<ResearchStudyArm>?

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.

no setter, inherited

category → List<CodeableConcept>?

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

no setter, inherited

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 setter, inherited

contact → List<ContactDetail>?

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

no setter, inherited

contained → List<Resource>?

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

no setter, inherited

copyWith → $ResearchStudyCopyWith<ResearchStudy>

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

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

no setter, inherited

descriptionElement → Element?

descriptionElement Extensions for description

no setter, inherited

enrollment → 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".

no setter, inherited

extension_ → List<FhirExtension>?

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

no setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

focus → List<CodeableConcept>?

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 setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

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

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

keyword → List<CodeableConcept>?

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

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

location → List<CodeableConcept>?

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

no setter, inherited

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 setter, inherited

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

no setter, inherited

note → List<Annotation>?

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

no setter, inherited

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 setter, inherited

partOf → List<Reference>?

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

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

period → Period?

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

no setter, inherited

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 setter, inherited

primaryPurposeType → CodeableConcept?

primaryPurposeType The type of study based upon the intent of the study's activities. A classification of the intent of the study.

no setter, inherited

principalInvestigator → 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.

no setter, inherited

protocol → List<Reference>?

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

no setter, inherited

reasonStopped → CodeableConcept?

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

no setter, inherited

relatedArtifact → List<RelatedArtifact>?

relatedArtifact Citations, references and other related documents.

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

site → List<Reference>?

site A facility in which study activities are conducted.

no setter, inherited

sponsor → Reference?

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

no setter, inherited

status → FhirCode?

status The current state of the study.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

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

no setter, inherited

titleElement → Element?

titleElement Extensions for title

no setter, inherited

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

inherited

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