Struct TestScriptVariableBuilder

pub struct TestScriptVariableBuilder { /* private fields */ }

Builder for TestScriptVariable.

Implementations

impl TestScriptVariableBuilder

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

Unique id for inter-element referencing

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

Additional content defined by implementations

May be used to represent additional information that is not part of the basic definition of the element. 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>, ) -> TestScriptVariableBuilder

Extensions that cannot be ignored even if unrecognized

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 name(self, value: String) -> TestScriptVariableBuilder

Descriptive name for this variable

Descriptive name for this variable.

Placeholders would contain the variable name wrapped in ${} in “operation.params”, “operation.requestHeader.value”, and “operation.url” elements. These placeholders would need to be replaced by the variable value before the operation is executed.

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

Extension field.

pub fn default_value(self, value: String) -> TestScriptVariableBuilder

Default, hard-coded, or user-defined value for this variable

A default, hard-coded, or user-defined value for this variable.

The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.

pub fn default_value_ext( self, value: FieldExtension, ) -> TestScriptVariableBuilder

Extension field.

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

Natural language description of the variable

A free text natural language description of the variable and its purpose.

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

Extension field.

pub fn expression(self, value: String) -> TestScriptVariableBuilder

The FHIRPath expression against the fixture body

The FHIRPath expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.

pub fn expression_ext(self, value: FieldExtension) -> TestScriptVariableBuilder

Extension field.

pub fn header_field(self, value: String) -> TestScriptVariableBuilder

HTTP header field name for source

Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.

pub fn header_field_ext( self, value: FieldExtension, ) -> TestScriptVariableBuilder

Extension field.

pub fn hint(self, value: String) -> TestScriptVariableBuilder

Hint help text for default value to enter

Displayable text string with hint help information to the user when entering a default value.

pub fn hint_ext(self, value: FieldExtension) -> TestScriptVariableBuilder

Extension field.

pub fn path(self, value: String) -> TestScriptVariableBuilder

XPath or JSONPath against the fixture body

XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.

pub fn path_ext(self, value: FieldExtension) -> TestScriptVariableBuilder

Extension field.

pub fn source_id(self, value: String) -> TestScriptVariableBuilder

Fixture Id of source expression or headerField within this variable

Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.

This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the action.operation element.

pub fn source_id_ext(self, value: FieldExtension) -> TestScriptVariableBuilder

Extension field.

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

Builds a new TestScriptVariable.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for TestScriptVariableBuilder

fn default() -> TestScriptVariableBuilder

Returns the “default value” for a type.