Struct TestScriptVariable

pub struct TestScriptVariable {

    pub id: Option<String>,
    pub extension: Vec<Extension>,
    pub modifier_extension: Vec<Extension>,
    pub name: String,
    pub name_ext: Option<FieldExtension>,
    pub default_value: Option<String>,
    pub default_value_ext: Option<FieldExtension>,
    pub description: Option<String>,
    pub description_ext: Option<FieldExtension>,
    pub expression: Option<String>,
    pub expression_ext: Option<FieldExtension>,
    pub header_field: Option<String>,
    pub header_field_ext: Option<FieldExtension>,
    pub hint: Option<String>,
    pub hint_ext: Option<FieldExtension>,
    pub path: Option<String>,
    pub path_ext: Option<FieldExtension>,
    pub source_id: Option<String>,
    pub source_id_ext: Option<FieldExtension>,
}

Sub-fields of the variable field in TestScript

Fields

id: Option<String>

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.

extension: Vec<Extension>

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.

modifier_extension: Vec<Extension>

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.

name: String

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.

name_ext: Option<FieldExtension>

Extension field.

default_value: Option<String>

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.

default_value_ext: Option<FieldExtension>

Extension field.

description: Option<String>

Natural language description of the variable

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

description_ext: Option<FieldExtension>

Extension field.

expression: Option<String>

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.

expression_ext: Option<FieldExtension>

Extension field.

header_field: Option<String>

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.

header_field_ext: Option<FieldExtension>

Extension field.

hint: Option<String>

Hint help text for default value to enter

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

hint_ext: Option<FieldExtension>

Extension field.

path: Option<String>

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.

path_ext: Option<FieldExtension>

Extension field.

source_id: Option<String>

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.

source_id_ext: Option<FieldExtension>

Extension field.

Implementations

impl TestScriptVariable

pub fn builder() -> TestScriptVariableBuilder

Start building a new instance

Trait Implementations

impl Clone for TestScriptVariable

fn clone(&self) -> TestScriptVariable

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TestScriptVariable

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TestScriptVariable

fn deserialize<__D>( __deserializer: __D, ) -> Result<TestScriptVariable, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TestScriptVariable

fn eq(&self, other: &TestScriptVariable) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TestScriptVariable

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TestScriptVariable