Struct TestScriptSetupActionOperationBuilder

pub struct TestScriptSetupActionOperationBuilder { /* private fields */ }

Builder for TestScriptSetupActionOperation.

Implementations

impl TestScriptSetupActionOperationBuilder

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

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

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

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 type(self, value: Coding) -> TestScriptSetupActionOperationBuilder

TestScriptOperationCode; The operation code type that will be executed

Server interaction or operation type.

See the list of server interactions.

pub fn type_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn resource(self, value: String) -> TestScriptSetupActionOperationBuilder

FHIRConcreteTypes; Resource type

The type of the FHIR resource. See the resource list. Data type of uri is needed when non-HL7 artifacts are identified.

If “url” element is specified, then “targetId”, “params”, and “resource” elements will be ignored as “url” element will have everything needed for constructing the request url. If “params” element is specified, then “targetId” element is ignored. For FHIR operations that require a resource (e.g. “read” and “vread” operations), the “resource” element must be specified when “params” element is specified. If “url” and “params” elements are absent, then the request url will be constructed from “targetId” fixture if present. For “read” operation, the resource and id values will be extracted from “targetId” fixture and used to construct the url. For “vread” and “history” operations, the versionId value will also be used.

pub fn resource_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn label(self, value: String) -> TestScriptSetupActionOperationBuilder

Tracking/logging operation label

The label would be used for tracking/logging purposes by test engines.

This has no impact on the verification itself.

pub fn label_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

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

Tracking/reporting operation description

The description would be used by test engines for tracking and reporting purposes.

This has no impact on the verification itself.

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

Extension field.

pub fn accept(self, value: String) -> TestScriptSetupActionOperationBuilder

MimeType; Mime type to accept in the payload of the response, with charset etc

The mime-type to use for RESTful operation in the ‘Accept’ header.

If this is specified, then test engine shall set the ‘Accept’ header to the corresponding value. If you’d like to explicitly set the ‘Accept’ to some other value then use the ‘requestHeader’ element.

pub fn accept_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn content_type( self, value: String, ) -> TestScriptSetupActionOperationBuilder

MimeType; Mime type of the request payload contents, with charset etc

The mime-type to use for RESTful operation in the ‘Content-Type’ header.

If this is specified, then test engine shall set the ‘Content-Type’ header to the corresponding value. If you’d like to explicitly set the ‘Content-Type’ to some other value then use the ‘requestHeader’ element.

pub fn content_type_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn destination(self, value: i32) -> TestScriptSetupActionOperationBuilder

Server responding to the request

The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.

If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.

pub fn destination_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn encode_request_url( self, value: bool, ) -> TestScriptSetupActionOperationBuilder

Whether or not to send the request url in encoded format

Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.

pub fn encode_request_url_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn method( self, value: TestScriptRequestMethodCode, ) -> TestScriptSetupActionOperationBuilder

TestScriptRequestMethodCode; delete | get | options | patch | post | put | head

The HTTP method the test engine MUST use for this operation regardless of any other operation details.

The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing.

pub fn method_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn origin(self, value: i32) -> TestScriptSetupActionOperationBuilder

Server initiating the request

The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.

If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.

pub fn origin_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn params(self, value: String) -> TestScriptSetupActionOperationBuilder

Explicitly defined path parameters

Path plus parameters after [type]. Used to set parts of the request URL explicitly.

If “url” element is specified, then “targetId”, “params”, and “resource” elements will be ignored as “url” element will have everything needed for constructing the request url. If “params” element is specified, then “targetId” element is ignored. For FHIR operations that require a resource (e.g. “read” and “vread” operations), the “resource” element must be specified when “params” element is specified. If “url” and “params” elements are absent, then the request url will be constructed from “targetId” fixture if present. For “read” operation, the resource and id values will be extracted from “targetId” fixture and used to construct the url. For “vread” and “history” operations, the versionId value will also be used. Test engines would append whatever is specified for “params” to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The “params” element does not correspond exactly to “search parameters”. Nor is it the “path”. It corresponds to the part of the URL that comes after the [type] (when “resource” element is specified); e.g. It corresponds to “/[id]/_history/[vid] {?_format=[mime-type]}” in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.

pub fn params_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn request_header( self, value: Vec<Option<TestScriptSetupActionOperationRequestHeader>>, ) -> TestScriptSetupActionOperationBuilder

Each operation can have one or more header elements

Header elements would be used to set HTTP headers.

This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - “If-Modified-Since” and “If-None-Match” headers. “If-Match” header. See Conditional Create using “If-None-Exist”. See Invalid “Content-Type” header for negative testing. - etc.

pub fn request_header_ext( self, value: Vec<Option<FieldExtension>>, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn request_id(self, value: String) -> TestScriptSetupActionOperationBuilder

Fixture Id of mapped request

The fixture id (maybe new) to map to the request.

If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by “requestId”. If requestId is not specified, it is the test engine’s responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.

pub fn request_id_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

pub fn response_id(self, value: String) -> TestScriptSetupActionOperationBuilder

Fixture Id of mapped response

The fixture id (maybe new) to map to the response.

If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by “responseId”. If responseId is not specified, it is the test engine’s responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.

pub fn response_id_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

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

Fixture Id of body for PUT and POST requests

The id of the fixture used as the body of a PUT or POST request.

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

Extension field.

pub fn target_id(self, value: String) -> TestScriptSetupActionOperationBuilder

Id of fixture used for extracting the [id], [type], and [vid] for GET requests

Id of fixture used for extracting the [id], [type], and [vid] for GET requests.

If “url” element is specified, then “targetId”, “params”, and “resource” elements will be ignored as “url” element will have everything needed for constructing the request url. If “params” element is specified, then “targetId” element is ignored. For FHIR operations that require a resource (e.g. “read” and “vread” operations), the “resource” element must be specified when “params” element is specified. If “url” and “params” elements are absent, then the request url will be constructed from “targetId” fixture if present. For “read” operation, the resource and id values will be extracted from “targetId” fixture and used to construct the url. For “vread” and “history” operations, the versionId value will also be used.

pub fn target_id_ext( self, value: FieldExtension, ) -> TestScriptSetupActionOperationBuilder

Extension field.

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

Request URL

Complete request URL.

Used to set the request URL explicitly. If “url” element is defined, then “targetId”, “resource”, and “params” elements will be ignored. Test engines would use whatever is specified in “url” without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.

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

Extension field.

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

Builds a new TestScriptSetupActionOperation.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for TestScriptSetupActionOperationBuilder

fn default() -> TestScriptSetupActionOperationBuilder

Returns the “default value” for a type.