Struct QuestionnaireResponseBuilder 

pub struct QuestionnaireResponseBuilder { /* private fields */ }

Builder for QuestionnaireResponseInner.

Implementations

impl QuestionnaireResponseBuilder

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

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

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

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

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

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

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

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>, ) -> QuestionnaireResponseBuilder

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>>, ) -> QuestionnaireResponseBuilder

Business identifier for this set of answers

Business identifiers assigned to this questionnaire response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Note: This is a business identifier, not a resource identifier (see discussion).

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

Extension field.

pub fn based_on( self, value: Vec<Option<Reference>>, ) -> QuestionnaireResponseBuilder

Request fulfilled by this QuestionnaireResponse

A plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

pub fn based_on_ext( self, value: Vec<Option<FieldExtension>>, ) -> QuestionnaireResponseBuilder

Extension field.

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

Part of referenced event

A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

Not to be used to link an questionnaire response to an Encounter - use ‘context’ for that.

Composition of questionnaire responses will be handled using the Assemble operation defined in the SDC IG. For relationships to referrals, and other types of requests, use basedOn.

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

Extension field.

pub fn questionnaire(self, value: String) -> QuestionnaireResponseBuilder

Canonical URL of Questionnaire being answered

The Questionnaire that defines and organizes the questions for which answers are being provided.

If a QuestionnaireResponse references a Questionnaire that can be resolved, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.). It is possible to have a QuestionnaireResponse whose ‘questionnaire’ element does not resolve. It is also possible for the questionnaire element to not have a value but only extensions (e.g. conveying the title or identifier for the questionnaire). This may happen for legacy data. If there is no formally defined Questionnaire, it is undefined what the ‘correct’ values for the linkId elements should be and it is possible that linkIds might be inconsistent for QuestionnaireResponses for the same form if captured by distinct systems.

pub fn questionnaire_ext( self, value: FieldExtension, ) -> QuestionnaireResponseBuilder

Extension field.

pub fn status( self, value: QuestionnaireResponseStatus, ) -> QuestionnaireResponseBuilder

QuestionnaireResponseStatus; in-progress | completed | amended | entered-in-error | stopped

The current state of the questionnaire response.

Unknown does not represent “other” - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

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

Extension field.

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

The subject of the questions

The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.

If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.

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

Extension field.

pub fn encounter(self, value: Reference) -> QuestionnaireResponseBuilder

Encounter the questionnaire response is part of

The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

This will typically be the encounter the questionnaire response was created during, but some questionnaire responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission forms). A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.

pub fn encounter_ext( self, value: FieldExtension, ) -> QuestionnaireResponseBuilder

Extension field.

pub fn authored(self, value: DateTime) -> QuestionnaireResponseBuilder

Date the answers were gathered

The date and/or time that this questionnaire response was last modified by the user - e.g. changing answers or revising status.

May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.

This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.

pub fn authored_ext(self, value: FieldExtension) -> QuestionnaireResponseBuilder

Extension field.

pub fn author(self, value: Reference) -> QuestionnaireResponseBuilder

The individual or device that received and recorded the answers

The individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

Mapping a subject’s answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.

pub fn author_ext(self, value: FieldExtension) -> QuestionnaireResponseBuilder

Extension field.

pub fn source(self, value: Reference) -> QuestionnaireResponseBuilder

The individual or device that answered the questions

The individual or device that answered the questions about the subject.

If not specified, no inference can be made about who provided the data. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.

pub fn source_ext(self, value: FieldExtension) -> QuestionnaireResponseBuilder

Extension field.

pub fn item( self, value: Vec<Option<QuestionnaireResponseItem>>, ) -> QuestionnaireResponseBuilder

Groups and questions

A group or question item from the original questionnaire for which answers are provided.

Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).\nWhen dealing with repeating items, each group repetition will be handled by a separate item. However, repeating questions are handled with a single question item and potentially multiple answers.

pub fn item_ext( self, value: Vec<Option<FieldExtension>>, ) -> QuestionnaireResponseBuilder

Extension field.

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

Builds a new QuestionnaireResponseInner.

Errors

If a required field has not been initialized.

impl QuestionnaireResponseBuilder

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

Finalize building QuestionnaireResponse.

Trait Implementations

impl Default for QuestionnaireResponseBuilder

fn default() -> QuestionnaireResponseBuilder

Returns the “default value” for a type.