Struct ResearchSubjectBuilder

pub struct ResearchSubjectBuilder { /* private fields */ }

Builder for ResearchSubjectInner.

Implementations

impl ResearchSubjectBuilder

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

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

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

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

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

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

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

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

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 identifier( self, value: Vec<Option<Identifier>>, ) -> ResearchSubjectBuilder

Business Identifier for research subject in a study

Identifiers assigned to this research subject for a study.

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

Extension field.

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

PublicationStatus; draft | active | retired | unknown

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

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

Extension field.

pub fn progress( self, value: Vec<Option<ResearchSubjectProgress>>, ) -> ResearchSubjectBuilder

Subject status

The current state (status) of the subject and resons for status change where appropriate.

This is intended to deal with the confusion routinely created by haing two conflated concepts of being in a particular state and having achieved a particular milestone. In strict terms a milestone is a point of time event that results in a change from one state to another. The state before the milestone is achieved is often given the same name as the milestone, and sometimes the state may have the same description. For instance “Randomised” and “Visit 1” may be different milestones but the state remains at “on study” after each of them.

It is likely that more than one “state” pattern will be recorded for a subject and a type has been introduced to allow this simultaneous recording.

pub fn progress_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchSubjectBuilder

Extension field.

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

Start and end of participation

The dates the subject began and ended their participation in the study.

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

Extension field.

pub fn study(self, value: Reference) -> ResearchSubjectBuilder

Study subject is part of

Reference to the study the subject is participating in.

pub fn study_ext(self, value: FieldExtension) -> ResearchSubjectBuilder

Extension field.

pub fn subject(self, value: Reference) -> ResearchSubjectBuilder

Who or what is part of study

The record of the person, animal or other entity involved in the study.

pub fn subject_ext(self, value: FieldExtension) -> ResearchSubjectBuilder

Extension field.

pub fn assigned_comparison_group(self, value: String) -> ResearchSubjectBuilder

What path should be followed

The name of the arm in the study the subject is expected to follow as part of this study.

Maybe this is really PlanDefinition.

pub fn assigned_comparison_group_ext( self, value: FieldExtension, ) -> ResearchSubjectBuilder

Extension field.

pub fn actual_comparison_group(self, value: String) -> ResearchSubjectBuilder

What path was followed

The name of the arm in the study the subject actually followed as part of this study.

pub fn actual_comparison_group_ext( self, value: FieldExtension, ) -> ResearchSubjectBuilder

Extension field.

pub fn consent(self, value: Vec<Option<Reference>>) -> ResearchSubjectBuilder

Agreement to participate in study

A record of the patient’s informed agreement to participate in the study.

pub fn consent_ext( self, value: Vec<Option<FieldExtension>>, ) -> ResearchSubjectBuilder

Extension field.

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

Builds a new ResearchSubjectInner.

Errors

If a required field has not been initialized.

impl ResearchSubjectBuilder

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

Finalize building ResearchSubject.

Trait Implementations

impl Default for ResearchSubjectBuilder

fn default() -> ResearchSubjectBuilder

Returns the “default value” for a type.