TestScriptAssert constructor
- @JsonKey(name: 'id') FhirId? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - String? label,
- @JsonKey(name: '_label') Element? labelElement,
- String? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- FhirCode? direction,
- @JsonKey(name: '_direction') Element? directionElement,
- String? compareToSourceId,
- @JsonKey(name: '_compareToSourceId') Element? compareToSourceIdElement,
- String? compareToSourceExpression,
- @JsonKey(name: '_compareToSourceExpression') Element? compareToSourceExpressionElement,
- String? compareToSourcePath,
- @JsonKey(name: '_compareToSourcePath') Element? compareToSourcePathElement,
- FhirCode? contentType,
- @JsonKey(name: '_contentType') Element? contentTypeElement,
- String? expression,
- @JsonKey(name: '_expression') Element? expressionElement,
- String? headerField,
- @JsonKey(name: '_headerField') Element? headerFieldElement,
- String? minimumId,
- @JsonKey(name: '_minimumId') Element? minimumIdElement,
- @JsonKey(name: 'operator') FhirCode? operator_,
- @JsonKey(name: '_operator') Element? operatorElement,
- String? path,
- @JsonKey(name: '_path') Element? pathElement,
- FhirCode? requestMethod,
- @JsonKey(name: '_requestMethod') Element? requestMethodElement,
- String? requestURL,
- @JsonKey(name: '_requestURL') Element? requestURLElement,
- FhirCode? resource,
- @JsonKey(name: '_resource') Element? resourceElement,
- FhirCode? response,
- @JsonKey(name: '_response') Element? responseElement,
- String? responseCode,
- @JsonKey(name: '_responseCode') Element? responseCodeElement,
- FhirId? sourceId,
- @JsonKey(name: '_sourceId') Element? sourceIdElement,
- FhirId? validateProfileId,
- @JsonKey(name: '_validateProfileId') Element? validateProfileIdElement,
- String? value,
- @JsonKey(name: '_value') Element? valueElement,
- FhirBoolean? warningOnly,
- @JsonKey(name: '_warningOnly') Element? warningOnlyElement,
TestScriptAssert 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_
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 manageable, 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 manageable, 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).
label
The label would be used for tracking/logging purposes by test
engines.
labelElement
Extensions for label
description
The description would be used by test engines for tracking
and reporting purposes.
descriptionElement
Extensions for description
direction
The direction to use for the assertion.
directionElement
Extensions for direction
compareToSourceId
Id of the source fixture used as the contents to be
evaluated by either the "source/expression" or "sourceId/path"
definition.
compareToSourceIdElement
Extensions for compareToSourceId
compareToSourceExpression
The FHIRPath expression to evaluate against
the source fixture. When compareToSourceId is defined, either
compareToSourceExpression or compareToSourcePath must be defined, but not
both.
compareToSourceExpressionElement
Extensions for compareToSourceExpression
compareToSourcePath
XPath or JSONPath expression to evaluate against
the source fixture. When compareToSourceId is defined, either
compareToSourceExpression or compareToSourcePath must be defined, but not
both.
compareToSourcePathElement
Extensions for compareToSourcePath
contentType
The mime-type contents to compare against the request or
response message 'Content-Type' header.
contentTypeElement
Extensions for contentType
expression
The FHIRPath expression to be evaluated against the request
or response message contents - HTTP headers and payload.
expressionElement
Extensions for expression
headerField
The HTTP header field name e.g. 'Location'.
headerFieldElement
Extensions for headerField
minimumId
The ID of a fixture. Asserts that the response contains at a
minimum the fixture specified by minimumId.
minimumIdElement
Extensions for minimumId
navigationLinks
Whether or not the test execution performs validation
on the bundle navigation links.
navigationLinksElement
Extensions for navigationLinks
operator
The operator type defines the conditional behavior of the
assert. If not defined, the default is equals.
operatorElement
Extensions for operator
path
The XPath or JSONPath expression to be evaluated against the
fixture representing the response received from server.
pathElement
Extensions for path
requestMethod
The request method or HTTP operation code to compare
against that used by the client system under test.
requestMethodElement
Extensions for requestMethod
requestURL
The value to use in a comparison against the request URL
path string.
requestURLElement
Extensions for requestURL
resource
The type of the resource. See
http://build.fhir.org/resourcelist.html.
resourceElement
Extensions for resource
response
okay | created | noContent | notModified | bad | forbidden |
notFound | methodNotAllowed | conflict | gone | preconditionFailed |
unprocessable.
responseElement
Extensions for response
responseCode
The value of the HTTP response code to be tested.
responseCodeElement
Extensions for responseCode
sourceId
Fixture to evaluate the XPath/JSONPath expression or the
headerField against.
sourceIdElement
Extensions for sourceId
validateProfileId
The ID of the Profile to validate against.
validateProfileIdElement
Extensions for validateProfileId
value
The value to compare to.
valueElement
Extensions for value
warningOnly
Whether or not the test execution will produce a warning
only on error for this assert.
warningOnlyElement
Extensions for warningOnly
Implementation
const factory TestScriptAssert({
/// [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') FhirId? fhirId,
/// [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 manageable, 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 manageable, 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,
/// [label] The label would be used for tracking/logging purposes by test
/// engines.
String? label,
/// [labelElement] 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] Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [direction] The direction to use for the assertion.
FhirCode? direction,
/// [directionElement] Extensions for direction
@JsonKey(name: '_direction') Element? directionElement,
/// [compareToSourceId] Id of the source fixture used as the contents to be
/// evaluated by either the "source/expression" or "sourceId/path"
/// definition.
String? compareToSourceId,
/// [compareToSourceIdElement] Extensions for compareToSourceId
@JsonKey(name: '_compareToSourceId') Element? compareToSourceIdElement,
/// [compareToSourceExpression] The FHIRPath expression to evaluate against
/// the source fixture. When compareToSourceId is defined, either
/// compareToSourceExpression or compareToSourcePath must be defined, but not
/// both.
String? compareToSourceExpression,
@JsonKey(name: '_compareToSourceExpression')
/// [compareToSourceExpressionElement] Extensions for compareToSourceExpression
Element? compareToSourceExpressionElement,
/// [compareToSourcePath] XPath or JSONPath expression to evaluate against
/// the source fixture. When compareToSourceId is defined, either
/// compareToSourceExpression or compareToSourcePath must be defined, but not
/// both.
String? compareToSourcePath,
/// [compareToSourcePathElement] Extensions for compareToSourcePath
@JsonKey(name: '_compareToSourcePath') Element? compareToSourcePathElement,
/// [contentType] The mime-type contents to compare against the request or
/// response message 'Content-Type' header.
FhirCode? contentType,
/// [contentTypeElement] Extensions for contentType
@JsonKey(name: '_contentType') Element? contentTypeElement,
/// [expression] The FHIRPath expression to be evaluated against the request
/// or response message contents - HTTP headers and payload.
String? expression,
/// [expressionElement] Extensions for expression
@JsonKey(name: '_expression') Element? expressionElement,
/// [headerField] The HTTP header field name e.g. 'Location'.
String? headerField,
/// [headerFieldElement] Extensions for headerField
@JsonKey(name: '_headerField') Element? headerFieldElement,
/// [minimumId] The ID of a fixture. Asserts that the response contains at a
/// minimum the fixture specified by minimumId.
String? minimumId,
/// [minimumIdElement] Extensions for minimumId
@JsonKey(name: '_minimumId') Element? minimumIdElement,
/// [navigationLinks] Whether or not the test execution performs validation
/// on the bundle navigation links.
FhirBoolean? navigationLinks,
/// [navigationLinksElement] Extensions for navigationLinks
@JsonKey(name: '_navigationLinks') Element? navigationLinksElement,
/// [operator] The operator type defines the conditional behavior of the
/// assert. If not defined, the default is equals.
@JsonKey(name: 'operator') FhirCode? operator_,
/// [operatorElement] Extensions for operator
@JsonKey(name: '_operator') Element? operatorElement,
/// [path] The XPath or JSONPath expression to be evaluated against the
/// fixture representing the response received from server.
String? path,
/// [pathElement] Extensions for path
@JsonKey(name: '_path') Element? pathElement,
/// [requestMethod] The request method or HTTP operation code to compare
/// against that used by the client system under test.
FhirCode? requestMethod,
/// [requestMethodElement] Extensions for requestMethod
@JsonKey(name: '_requestMethod') Element? requestMethodElement,
/// [requestURL] The value to use in a comparison against the request URL
/// path string.
String? requestURL,
/// [requestURLElement] Extensions for requestURL
@JsonKey(name: '_requestURL') Element? requestURLElement,
/// [resource] The type of the resource. See
/// http://build.fhir.org/resourcelist.html.
FhirCode? resource,
/// [resourceElement] Extensions for resource
@JsonKey(name: '_resource') Element? resourceElement,
/// [response] okay | created | noContent | notModified | bad | forbidden |
/// notFound | methodNotAllowed | conflict | gone | preconditionFailed |
/// unprocessable.
FhirCode? response,
/// [responseElement] Extensions for response
@JsonKey(name: '_response') Element? responseElement,
/// [responseCode] The value of the HTTP response code to be tested.
String? responseCode,
/// [responseCodeElement] Extensions for responseCode
@JsonKey(name: '_responseCode') Element? responseCodeElement,
/// [sourceId] Fixture to evaluate the XPath/JSONPath expression or the
/// headerField against.
FhirId? sourceId,
/// [sourceIdElement] Extensions for sourceId
@JsonKey(name: '_sourceId') Element? sourceIdElement,
/// [validateProfileId] The ID of the Profile to validate against.
FhirId? validateProfileId,
/// [validateProfileIdElement] Extensions for validateProfileId
@JsonKey(name: '_validateProfileId') Element? validateProfileIdElement,
/// [value] The value to compare to.
String? value,
/// [valueElement] Extensions for value
@JsonKey(name: '_value') Element? valueElement,
/// [warningOnly] Whether or not the test execution will produce a warning
/// only on error for this assert.
FhirBoolean? warningOnly,
/// [warningOnlyElement] Extensions for warningOnly
@JsonKey(name: '_warningOnly') Element? warningOnlyElement,
}) = _TestScriptAssert;