TestScriptVariable constructor

const TestScriptVariable({ @JsonKey(name: 'id') FhirId? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, String? name, @JsonKey(name: '_name') Element? nameElement, String? defaultValue, @JsonKey(name: '_defaultValue') Element? defaultValueElement, String? description, @JsonKey(name: '_description') Element? descriptionElement, String? expression, @JsonKey(name: '_expression') Element? expressionElement, String? headerField, @JsonKey(name: '_headerField') Element? headerFieldElement, String? hint, @JsonKey(name: '_hint') Element? hintElement, String? path, @JsonKey(name: '_path') Element? pathElement, FhirId? sourceId, @JsonKey(name: '_sourceId') Element? sourceIdElement, })

TestScriptVariable 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).

name Descriptive name for this variable.

nameElement Extensions for name

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

defaultValueElement Extensions for defaultValue

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

descriptionElement Extensions for description

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

expressionElement Extensions for expression

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

headerFieldElement Extensions for headerField

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

hintElement Extensions for hint

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

pathElement Extensions for path

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

sourceIdElement Extensions for sourceId

Implementation

const factory TestScriptVariable({
  /// [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,

  /// [name] Descriptive name for this variable.
  String? name,

  /// [nameElement] Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [defaultValue] A default, hard-coded, or user-defined value for this
  ///  variable.
  String? defaultValue,

  /// [defaultValueElement] Extensions for defaultValue
  @JsonKey(name: '_defaultValue') Element? defaultValueElement,

  /// [description] A free text natural language description of the variable
  ///  and its purpose.
  String? description,

  /// [descriptionElement] Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [expression] The FHIRPath expression to evaluate against the fixture
  /// body. When variables are defined, only one of either expression,
  ///  headerField or path must be specified.
  String? expression,

  /// [expressionElement] Extensions for expression
  @JsonKey(name: '_expression') Element? expressionElement,

  /// [headerField] Will be used to grab the HTTP header field value from the
  ///  headers that sourceId is pointing to.
  String? headerField,

  /// [headerFieldElement] Extensions for headerField
  @JsonKey(name: '_headerField') Element? headerFieldElement,

  /// [hint] Displayable text string with hint help information to the user
  ///  when entering a default value.
  String? hint,

  /// [hintElement] Extensions for hint
  @JsonKey(name: '_hint') Element? hintElement,

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

  /// [pathElement] Extensions for path
  @JsonKey(name: '_path') Element? pathElement,

  /// [sourceId] Fixture to evaluate the XPath/JSONPath expression or the
  ///  headerField  against within this variable.
  FhirId? sourceId,

  /// [sourceIdElement] Extensions for sourceId
  @JsonKey(name: '_sourceId') Element? sourceIdElement,
}) = _TestScriptVariable;