Skip to main content

HS.FHIR.vSTU3.Model.Resource.TestScript.Assert

deprecated class HS.FHIR.vSTU3.Model.Resource.TestScript.Assert 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.Assert;
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.Assert;
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 compareToSourceExpression as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "compareToSourceExpression", XMLPROJECTION = "ELEMENT");
The fluentpath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
Property methods: compareToSourceExpressionGet(), compareToSourceExpressionGetSwizzled(), compareToSourceExpressionIsValid(), compareToSourceExpressionNewObject(), compareToSourceExpressionSet()
property compareToSourceId as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "compareToSourceId", XMLPROJECTION = "ELEMENT");
Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
Property methods: compareToSourceIdGet(), compareToSourceIdGetSwizzled(), compareToSourceIdIsValid(), compareToSourceIdNewObject(), compareToSourceIdSet()
property compareToSourcePath as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "compareToSourcePath", XMLPROJECTION = "ELEMENT");
XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
Property methods: compareToSourcePathGet(), compareToSourcePathGetSwizzled(), compareToSourcePathIsValid(), compareToSourcePathNewObject(), compareToSourcePathSet()
property contentType as HS.FHIR.vSTU3.Model.Base.ContentType (XMLNAME = "contentType", XMLPROJECTION = "ELEMENT");
The content-type or mime-type to use for RESTful operation in the 'Content-Type' header.
Property methods: contentTypeGet(), contentTypeGetSwizzled(), contentTypeIsValid(), contentTypeNewObject(), contentTypeSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
The description would be used by test engines for tracking and reporting purposes.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property direction as HS.FHIR.vSTU3.Model.Base.AssertionDirectionType (XMLNAME = "direction", XMLPROJECTION = "ELEMENT");
The direction to use for the assertion.
Property methods: directionGet(), directionGetSwizzled(), directionIsValid(), directionNewObject(), directionSet()
property expression as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "expression", XMLPROJECTION = "ELEMENT");
The fluentpath expression to be evaluated against the request or response message contents - HTTP headers and payload.
Property methods: expressionGet(), expressionGetSwizzled(), expressionIsValid(), expressionNewObject(), expressionSet()
property headerField as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "headerField", XMLPROJECTION = "ELEMENT");
The HTTP header field name e.g. 'Location'.
Property methods: headerFieldGet(), headerFieldGetSwizzled(), headerFieldIsValid(), headerFieldNewObject(), headerFieldSet()
property label as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "label", XMLPROJECTION = "ELEMENT");
The label would be used for tracking/logging purposes by test engines.
Property methods: labelGet(), labelGetSwizzled(), labelIsValid(), labelNewObject(), labelSet()
property minimumId as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "minimumId", XMLPROJECTION = "ELEMENT");
The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
Property methods: minimumIdGet(), minimumIdGetSwizzled(), minimumIdIsValid(), minimumIdNewObject(), minimumIdSet()
Whether or not the test execution performs validation on the bundle navigation links.
Property methods: navigationLinksGet(), navigationLinksGetSwizzled(), navigationLinksIsValid(), navigationLinksNewObject(), navigationLinksSet()
property operator as HS.FHIR.vSTU3.Model.Base.AssertionOperatorType (XMLNAME = "operator", XMLPROJECTION = "ELEMENT");
The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
Property methods: operatorGet(), operatorGetSwizzled(), operatorIsValid(), operatorNewObject(), operatorSet()
property path as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "path", XMLPROJECTION = "ELEMENT");
The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
Property methods: pathGet(), pathGetSwizzled(), pathIsValid(), pathNewObject(), pathSet()
property requestMethod as HS.FHIR.vSTU3.Model.Base.TestScriptRequestMethodCode (XMLNAME = "requestMethod", XMLPROJECTION = "ELEMENT");
The request method or HTTP operation code to compare against that used by the client system under test.
Property methods: requestMethodGet(), requestMethodGetSwizzled(), requestMethodIsValid(), requestMethodNewObject(), requestMethodSet()
property requestURL as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "requestURL", XMLPROJECTION = "ELEMENT");
The value to use in a comparison against the request URL path string.
Property methods: requestURLGet(), requestURLGetSwizzled(), requestURLIsValid(), requestURLNewObject(), requestURLSet()
property resource as HS.FHIR.vSTU3.Model.Base.FHIRDefinedType (XMLNAME = "resource", XMLPROJECTION = "ELEMENT");
The type of the resource. See http://build.fhir.org/resourcelist.html.
Property methods: resourceGet(), resourceGetSwizzled(), resourceIsValid(), resourceNewObject(), resourceSet()
property response as HS.FHIR.vSTU3.Model.Base.AssertionResponseTypes (XMLNAME = "response", XMLPROJECTION = "ELEMENT");
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
Property methods: responseGet(), responseGetSwizzled(), responseIsValid(), responseNewObject(), responseSet()
property responseCode as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "responseCode", XMLPROJECTION = "ELEMENT");
The value of the HTTP response code to be tested.
Property methods: responseCodeGet(), responseCodeGetSwizzled(), responseCodeIsValid(), responseCodeNewObject(), responseCodeSet()
property rule as HS.FHIR.vSTU3.Model.Resource.TestScript.Rule2 (XMLNAME = "rule", XMLPROJECTION = "ELEMENT");
The TestScript.rule this assert will evaluate.
Property methods: ruleGet(), ruleGetSwizzled(), ruleIsValid(), ruleNewObject(), ruleSet()
property ruleset as HS.FHIR.vSTU3.Model.Resource.TestScript.Ruleset1 (XMLNAME = "ruleset", XMLPROJECTION = "ELEMENT");
The TestScript.ruleset this assert will evaluate.
Property methods: rulesetGet(), rulesetGetSwizzled(), rulesetIsValid(), rulesetNewObject(), rulesetSet()
property sourceId as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "sourceId", XMLPROJECTION = "ELEMENT");
Fixture to evaluate the XPath/JSONPath expression or the headerField against.
Property methods: sourceIdGet(), sourceIdGetSwizzled(), sourceIdIsValid(), sourceIdNewObject(), sourceIdSet()
property validateProfileId as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "validateProfileId", XMLPROJECTION = "ELEMENT");
The ID of the Profile to validate against.
Property methods: validateProfileIdGet(), validateProfileIdGetSwizzled(), validateProfileIdIsValid(), validateProfileIdNewObject(), validateProfileIdSet()
property value as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "value", XMLPROJECTION = "ELEMENT");
The value to compare to.
Property methods: valueGet(), valueGetSwizzled(), valueIsValid(), valueNewObject(), valueSet()
property warningOnly as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "warningOnly", XMLPROJECTION = "ELEMENT");
Whether or not the test execution will produce a warning only on error for this assert.
Property methods: warningOnlyGet(), warningOnlyGetSwizzled(), warningOnlyIsValid(), warningOnlyNewObject(), warningOnlySet()

Methods

deprecated method SetCompareToSourceExpression(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 "compareToSourceExpression" property.
deprecated method SetCompareToSourceId(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 "compareToSourceId" property.
deprecated method SetCompareToSourcePath(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 "compareToSourcePath" property.
deprecated method SetContentType(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 "contentType" 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 SetDirection(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 "direction" 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 SetLabel(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 "label" property.
deprecated method SetMinimumId(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 "minimumId" property.
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "navigationLinks" property.
deprecated method SetOperator(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 "operator" 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 SetRequestMethod(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 "requestMethod" property.
deprecated method SetRequestURL(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 "requestURL" property.
deprecated method SetResource(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 "resource" property.
deprecated method SetResponse(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 "response" property.
deprecated method SetResponseCode(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 "responseCode" 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.
deprecated method SetValidateProfileId(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 "validateProfileId" property.
deprecated method SetValue(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 "value" property.
deprecated method SetWarningOnly(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 "warningOnly" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab