Skip to main content

HS.FHIR.vSTU3.Model.Resource.TestScript.Variable

deprecated class HS.FHIR.vSTU3.Model.Resource.TestScript.Variable extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = TestScript.Variable;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = TestScript.Variable;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property defaultValue as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "defaultValue", XMLPROJECTION = "ELEMENT");
A default, hard-coded, or user-defined value for this variable.
Property methods: defaultValueGet(), defaultValueGetSwizzled(), defaultValueIsValid(), defaultValueNewObject(), defaultValueSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the variable and its purpose.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property expression as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "expression", XMLPROJECTION = "ELEMENT");
The fluentpath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
Property methods: expressionGet(), expressionGetSwizzled(), expressionIsValid(), expressionNewObject(), expressionSet()
property headerField as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "headerField", XMLPROJECTION = "ELEMENT");
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
Property methods: headerFieldGet(), headerFieldGetSwizzled(), headerFieldIsValid(), headerFieldNewObject(), headerFieldSet()
property hint as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "hint", XMLPROJECTION = "ELEMENT");
Displayable text string with hint help information to the user when entering a default value.
Property methods: hintGet(), hintGetSwizzled(), hintIsValid(), hintNewObject(), hintSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
Descriptive name for this variable.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property path as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "path", XMLPROJECTION = "ELEMENT");
XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
Property methods: pathGet(), pathGetSwizzled(), pathIsValid(), pathNewObject(), pathSet()
property sourceId as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "sourceId", XMLPROJECTION = "ELEMENT");
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
Property methods: sourceIdGet(), sourceIdGetSwizzled(), sourceIdIsValid(), sourceIdNewObject(), sourceIdSet()

Methods

deprecated method SetDefaultValue(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "defaultValue" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetExpression(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "expression" property.
deprecated method SetHeaderField(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "headerField" property.
deprecated method SetHint(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "hint" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPath(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "path" property.
deprecated method SetSourceId(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "sourceId" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab