TestScriptOperation constructor
- @JsonKey(name: 'id') String? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - Coding? type,
- FhirUri? resource,
- @JsonKey(name: '_resource') Element? resourceElement,
- String? label,
- @JsonKey(name: '_label') Element? labelElement,
- String? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- FhirCode? accept,
- @JsonKey(name: '_accept') Element? acceptElement,
- FhirCode? contentType,
- @JsonKey(name: '_contentType') Element? contentTypeElement,
- FhirInteger? destination,
- @JsonKey(name: '_destination') Element? destinationElement,
- FhirBoolean? encodeRequestUrl,
- @JsonKey(name: '_encodeRequestUrl') Element? encodeRequestUrlElement,
- FhirCode? method,
- @JsonKey(name: '_method') Element? methodElement,
- FhirInteger? origin,
- @JsonKey(name: '_origin') Element? originElement,
- String? params,
- @JsonKey(name: '_params') Element? paramsElement,
- List<
TestScriptRequestHeader> ? requestHeader, - FhirId? requestId,
- @JsonKey(name: '_requestId') Element? requestIdElement,
- FhirId? responseId,
- @JsonKey(name: '_responseId') Element? responseIdElement,
- FhirId? sourceId,
- @JsonKey(name: '_sourceId') Element? sourceIdElement,
- FhirId? targetId,
- @JsonKey(name: '_targetId') Element? targetIdElement,
- String? url,
- @JsonKey(name: '_url') Element? urlElement,
TestScriptOperation A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension_
("extension") 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.
modifierExtension
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).
type
Server interaction or operation type.
resource
The type of the FHIR resource. See the resource
list. Data type of uri is needed when non-HL7
artifacts are identified.
resourceElement
("_resource") Extensions for resource
label
The label would be used for tracking/logging purposes by test
engines.
labelElement
("_label") Extensions for label
description
The description would be used by test engines for tracking
and reporting purposes.
descriptionElement
("_description") Extensions for description
accept
The mime-type to use for RESTful operation in the 'Accept'
header.
acceptElement
("_accept") Extensions for accept
contentType
The mime-type to use for RESTful operation in the
'Content-Type' header.
contentTypeElement
("_contentType") Extensions for contentType
destination
The server where the request message is destined for. Must
be one of the server numbers listed in TestScript.destination section.
destinationElement
("_destination") Extensions for destination
encodeRequestUrl
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.
encodeRequestUrlElement
("_encodeRequestUrl") Extensions for
encodeRequestUrl
method
The HTTP method the test engine MUST use for this operation
regardless of any other operation details.
methodElement
("_method") Extensions for method
origin
The server where the request message originates from. Must be
one of the server numbers listed in TestScript.origin section.
originElement
("_origin") Extensions for origin
params
Path plus parameters after type
. Used to set parts of the
request URL explicitly.
paramsElement
("_params") Extensions for params
requestHeader
Header elements would be used to set HTTP headers.
requestId
The fixture id (maybe new) to map to the request.
requestIdElement
("_requestId") Extensions for requestId
responseId
The fixture id (maybe new) to map to the response.
responseIdElement
("_responseId") Extensions for responseId
sourceId
The id of the fixture used as the body of a PUT or POST
request.
sourceIdElement
("_sourceId") Extensions for sourceId
targetId
Id of fixture used for extracting the id, type
, and vid
for GET requests.
targetIdElement
("_targetId") Extensions for targetId
url
Complete request URL.
urlElement
("_url") Extensions for url
Implementation
const factory TestScriptOperation({
/// [id] Unique id for the element within a resource (for internal
/// references). This may be any string value that does not contain spaces.
@JsonKey(name: 'id') String? fhirId,
/// [extension_] ("extension") 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.
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [modifierExtension] 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).
List<FhirExtension>? modifierExtension,
/// [type] Server interaction or operation type.
Coding? type,
/// [resource] The type of the FHIR resource. See the [resource
/// list](resourcelist.html). Data type of uri is needed when non-HL7
/// artifacts are identified.
FhirUri? resource,
/// [resourceElement] ("_resource") Extensions for resource
@JsonKey(name: '_resource') Element? resourceElement,
/// [label] The label would be used for tracking/logging purposes by test
/// engines.
String? label,
/// [labelElement] ("_label") Extensions for label
@JsonKey(name: '_label') Element? labelElement,
/// [description] The description would be used by test engines for
/// tracking and reporting purposes.
String? description,
/// [descriptionElement] ("_description") Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [accept] The mime-type to use for RESTful operation in the 'Accept'
/// header.
FhirCode? accept,
/// [acceptElement] ("_accept") Extensions for accept
@JsonKey(name: '_accept') Element? acceptElement,
/// [contentType] The mime-type to use for RESTful operation in the
/// 'Content-Type' header.
FhirCode? contentType,
/// [contentTypeElement] ("_contentType") Extensions for contentType
@JsonKey(name: '_contentType') Element? contentTypeElement,
/// [destination] The server where the request message is destined for.
/// Must be one of the server numbers listed in TestScript.destination
/// section.
FhirInteger? destination,
/// [destinationElement] ("_destination") Extensions for destination
@JsonKey(name: '_destination') Element? destinationElement,
/// [encodeRequestUrl] 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.
FhirBoolean? encodeRequestUrl,
/// [encodeRequestUrlElement] ("_encodeRequestUrl") Extensions for
/// encodeRequestUrl
@JsonKey(name: '_encodeRequestUrl') Element? encodeRequestUrlElement,
/// [method] The HTTP method the test engine MUST use for this operation
/// regardless of any other operation details.
FhirCode? method,
/// [methodElement] ("_method") Extensions for method
@JsonKey(name: '_method') Element? methodElement,
/// [origin] The server where the request message originates from. Must be
/// one of the server numbers listed in TestScript.origin section.
FhirInteger? origin,
/// [originElement] ("_origin") Extensions for origin
@JsonKey(name: '_origin') Element? originElement,
/// [params] Path plus parameters after [type]. Used to set parts of the
/// request URL explicitly.
String? params,
/// [paramsElement] ("_params") Extensions for params
@JsonKey(name: '_params') Element? paramsElement,
/// [requestHeader] Header elements would be used to set HTTP headers.
List<TestScriptRequestHeader>? requestHeader,
/// [requestId] The fixture id (maybe new) to map to the request.
FhirId? requestId,
/// [requestIdElement] ("_requestId") Extensions for requestId
@JsonKey(name: '_requestId') Element? requestIdElement,
/// [responseId] The fixture id (maybe new) to map to the response.
FhirId? responseId,
/// [responseIdElement] ("_responseId") Extensions for responseId
@JsonKey(name: '_responseId') Element? responseIdElement,
/// [sourceId] The id of the fixture used as the body of a PUT or POST
/// request.
FhirId? sourceId,
/// [sourceIdElement] ("_sourceId") Extensions for sourceId
@JsonKey(name: '_sourceId') Element? sourceIdElement,
/// [targetId] Id of fixture used for extracting the [id], [type], and
/// [vid] for GET requests.
FhirId? targetId,
/// [targetIdElement] ("_targetId") Extensions for targetId
@JsonKey(name: '_targetId') Element? targetIdElement,
/// [url] Complete request URL.
String? url,
/// [urlElement] ("_url") Extensions for url
@JsonKey(name: '_url') Element? urlElement,
}) = _TestScriptOperation;