Struct ResearchStudyBuilder

pub struct ResearchStudyBuilder { /* private fields */ }

Builder for ResearchStudyInner.

Implementations

impl ResearchStudyBuilder

pub fn id(self, value: String) -> ResearchStudyBuilder

Logical id of this artifact

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

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

pub fn meta(self, value: Meta) -> ResearchStudyBuilder

Metadata about the resource

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.

pub fn implicit_rules(self, value: String) -> ResearchStudyBuilder

A set of rules under which this content was created

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

pub fn language(self, value: String) -> ResearchStudyBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

pub fn text(self, value: Narrative) -> ResearchStudyBuilder

Text summary of the resource, for human interpretation

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.

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

pub fn contained(self, value: Vec<Resource>) -> ResearchStudyBuilder

Contained, inline Resources

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.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

pub fn extension(self, value: Vec<Extension>) -> ResearchStudyBuilder

Additional content defined by implementations

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn modifier_extension(self, value: Vec<Extension>) -> ResearchStudyBuilder

Extensions that cannot be ignored

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

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn url(self, value: String) -> ResearchStudyBuilder

Canonical identifier for this study resource

Canonical identifier for this study resource, represented as a globally unique URI.

pub fn url_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn identifier(self, value: Vec<Option<Identifier>>) -> ResearchStudyBuilder

Business Identifier for study

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

pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn version(self, value: String) -> ResearchStudyBuilder

The business version for the study record

The business version for the study record.

pub fn version_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn name(self, value: String) -> ResearchStudyBuilder

Name for this study (computer friendly)

Name for this study (computer friendly).

pub fn name_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn title(self, value: String) -> ResearchStudyBuilder

Human readable name of the study

The human readable name of the research study.

pub fn title_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn label( self, value: Vec<Option<ResearchStudyLabel>>, ) -> ResearchStudyBuilder

Additional names for the study

Additional names for the study.

pub fn label_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn protocol(self, value: Vec<Option<Reference>>) -> ResearchStudyBuilder

Steps followed in executing study

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

pub fn protocol_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn part_of(self, value: Vec<Option<Reference>>) -> ResearchStudyBuilder

Part of larger study

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

pub fn part_of_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn related_artifact( self, value: Vec<Option<RelatedArtifact>>, ) -> ResearchStudyBuilder

References, URLs, and attachments

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.

pub fn related_artifact_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn date(self, value: DateTime) -> ResearchStudyBuilder

Date the resource last changed

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.

pub fn date_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn status(self, value: PublicationStatus) -> ResearchStudyBuilder

PublicationStatus; draft | active | retired | unknown

The publication state of the resource (not of the study).

pub fn status_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn primary_purpose_type( self, value: CodeableConcept, ) -> ResearchStudyBuilder

ResearchStudyPrimaryPurposeType; treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility

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

pub fn primary_purpose_type_ext( self, value: FieldExtension, ) -> ResearchStudyBuilder

Extension field.

pub fn phase(self, value: CodeableConcept) -> ResearchStudyBuilder

ResearchStudyPhase; n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4

The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

pub fn phase_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn study_design( self, value: Vec<Option<CodeableConcept>>, ) -> ResearchStudyBuilder

StudyDesign; Classifications of the study design characteristics

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

pub fn study_design_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn focus( self, value: Vec<Option<CodeableReference>>, ) -> ResearchStudyBuilder

ResearchStudyFocusType; Drugs, devices, etc. under study

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

pub fn focus_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn condition( self, value: Vec<Option<CodeableConcept>>, ) -> ResearchStudyBuilder

ConditionCode; Condition being studied

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.

pub fn condition_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn keyword( self, value: Vec<Option<CodeableConcept>>, ) -> ResearchStudyBuilder

ResearchStudyKeyword; Used to search for the study

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

pub fn keyword_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn region(self, value: Vec<Option<CodeableConcept>>) -> ResearchStudyBuilder

Jurisdiction; Geographic area for the study

A country, state or other area where the study is taking place rather than its precise geographic location or address.

pub fn region_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn description_summary(self, value: String) -> ResearchStudyBuilder

Brief text explaining the study

A brief text for explaining the study.

pub fn description_summary_ext( self, value: FieldExtension, ) -> ResearchStudyBuilder

Extension field.

pub fn description(self, value: String) -> ResearchStudyBuilder

Detailed narrative of the study

A detailed and human-readable narrative of the study. E.g., study abstract.

pub fn description_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn period(self, value: Period) -> ResearchStudyBuilder

When the study began and ended

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

pub fn period_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn site(self, value: Vec<Option<Reference>>) -> ResearchStudyBuilder

Facility where study activities are conducted

A facility in which study activities are conducted.

pub fn site_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn note(self, value: Vec<Option<Annotation>>) -> ResearchStudyBuilder

Comments made about the study

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

pub fn note_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn classifier( self, value: Vec<Option<CodeableConcept>>, ) -> ResearchStudyBuilder

ResearchStudyClassifiers; Classification for the study

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.

pub fn classifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn associated_party( self, value: Vec<Option<ResearchStudyAssociatedParty>>, ) -> ResearchStudyBuilder

Sponsors, collaborators, and other parties

Sponsors, collaborators, and other parties.

For a Sponsor or a PrincipalInvestigator use the dedicated attributes provided.

pub fn associated_party_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn progress_status( self, value: Vec<Option<ResearchStudyProgressStatus>>, ) -> ResearchStudyBuilder

Status of study with time for that status

Status of study with time for that status.

pub fn progress_status_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn why_stopped(self, value: CodeableConcept) -> ResearchStudyBuilder

ResearchStudyReasonStopped; accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design

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

pub fn why_stopped_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn recruitment( self, value: ResearchStudyRecruitment, ) -> ResearchStudyBuilder

Target or actual group of participants enrolled in study

Target or actual group of participants enrolled in study.

pub fn recruitment_ext(self, value: FieldExtension) -> ResearchStudyBuilder

Extension field.

pub fn comparison_group( self, value: Vec<Option<ResearchStudyComparisonGroup>>, ) -> ResearchStudyBuilder

Defined path through the study for a subject

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

In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.

pub fn comparison_group_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn objective( self, value: Vec<Option<ResearchStudyObjective>>, ) -> ResearchStudyBuilder

A goal for the study

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.

pub fn objective_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn outcome_measure( self, value: Vec<Option<ResearchStudyOutcomeMeasure>>, ) -> ResearchStudyBuilder

A variable measured during the study

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.

A study may have multiple distinct outcome measures that can be used to assess the overall goal for a study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BP

pub fn outcome_measure_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn result(self, value: Vec<Option<Reference>>) -> ResearchStudyBuilder

Link to results generated during the study

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.

pub fn result_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchStudyBuilder

Extension field.

pub fn build_inner(self) -> Result<ResearchStudyInner, BuilderError>

Builds a new ResearchStudyInner.

Errors

If a required field has not been initialized.

impl ResearchStudyBuilder

pub fn build(self) -> Result<ResearchStudy, BuilderError>

Finalize building ResearchStudy.

Trait Implementations

impl Default for ResearchStudyBuilder

fn default() -> ResearchStudyBuilder

Returns the “default value” for a type.