Skip to main content

HS.FHIR.vSTU3.Model.Resource.TestScript

deprecated class HS.FHIR.vSTU3.Model.Resource.TestScript extends HS.FHIR.vSTU3.Model.Base.DomainResource

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.
If the element is present, it must have either a @value, an @id, or extensions

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 XMLNAME = TestScript;
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.

Properties

property contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the test script was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the test script from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property destination as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Destination (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");
An abstract server used in operations within this test script in the destination element.
Property methods: destinationBuildValueArray(), destinationCollectionToDisplay(), destinationCollectionToOdbc(), destinationDisplayToCollection(), destinationGet(), destinationGetObject(), destinationGetObjectId(), destinationGetSwizzled(), destinationIsValid(), destinationOdbcToCollection(), destinationSet(), destinationSetObject(), destinationSetObjectId()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property fixture as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Fixture (XMLNAME = "fixture", XMLPROJECTION = "ELEMENT");
Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
Property methods: fixtureBuildValueArray(), fixtureCollectionToDisplay(), fixtureCollectionToOdbc(), fixtureDisplayToCollection(), fixtureGet(), fixtureGetObject(), fixtureGetObjectId(), fixtureGetSwizzled(), fixtureIsValid(), fixtureOdbcToCollection(), fixtureSet(), fixtureSetObject(), fixtureSetObjectId()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the test script is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property metadata as HS.FHIR.vSTU3.Model.Resource.TestScript.Metadata (XMLNAME = "metadata", XMLPROJECTION = "ELEMENT");
The required capability must exist and are assumed to function correctly on the FHIR server being tested.
Property methods: metadataGet(), metadataGetSwizzled(), metadataIsValid(), metadataNewObject(), metadataSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property origin as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Origin (XMLNAME = "origin", XMLPROJECTION = "ELEMENT");
An abstract server used in operations within this test script in the origin element.
Property methods: originBuildValueArray(), originCollectionToDisplay(), originCollectionToOdbc(), originDisplayToCollection(), originGet(), originGetObject(), originGetObjectId(), originGetSwizzled(), originIsValid(), originOdbcToCollection(), originSet(), originSetObject(), originSetObjectId()
property profile as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "profile", XMLPROJECTION = "ELEMENT");
Reference to the profile to be used for validation.
Property methods: profileBuildValueArray(), profileCollectionToDisplay(), profileCollectionToOdbc(), profileDisplayToCollection(), profileGet(), profileGetObject(), profileGetObjectId(), profileGetSwizzled(), profileIsValid(), profileOdbcToCollection(), profileSet(), profileSetObject(), profileSetObjectId()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the test script.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this test script is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property rule as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Rule (XMLNAME = "rule", XMLPROJECTION = "ELEMENT");
Assert rule to be used in one or more asserts within the test script.
Property methods: ruleBuildValueArray(), ruleCollectionToDisplay(), ruleCollectionToOdbc(), ruleDisplayToCollection(), ruleGet(), ruleGetObject(), ruleGetObjectId(), ruleGetSwizzled(), ruleIsValid(), ruleOdbcToCollection(), ruleSet(), ruleSetObject(), ruleSetObjectId(), rulesetBuildValueArray(), rulesetCollectionToDisplay(), rulesetCollectionToOdbc(), rulesetDisplayToCollection(), rulesetGet(), rulesetGetObject(), rulesetGetObjectId(), rulesetGetSwizzled(), rulesetIsValid(), rulesetOdbcToCollection(), rulesetSet(), rulesetSetObject(), rulesetSetObjectId()
property ruleset as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Ruleset (XMLNAME = "ruleset", XMLPROJECTION = "ELEMENT");
Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied.
Property methods: rulesetBuildValueArray(), rulesetCollectionToDisplay(), rulesetCollectionToOdbc(), rulesetDisplayToCollection(), rulesetGet(), rulesetGetObject(), rulesetGetObjectId(), rulesetGetSwizzled(), rulesetIsValid(), rulesetOdbcToCollection(), rulesetSet(), rulesetSetObject(), rulesetSetObjectId()
property setup as HS.FHIR.vSTU3.Model.Resource.TestScript.Setup (XMLNAME = "setup", XMLPROJECTION = "ELEMENT");
A series of required setup operations before tests are executed.
Property methods: setupGet(), setupGetSwizzled(), setupIsValid(), setupNewObject(), setupSet()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this test script. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property teardown as HS.FHIR.vSTU3.Model.Resource.TestScript.Teardown (XMLNAME = "teardown", XMLPROJECTION = "ELEMENT");
A series of operations required to clean up after the all the tests are executed (successfully or otherwise).
Property methods: teardownGet(), teardownGetSwizzled(), teardownIsValid(), teardownNewObject(), teardownSet()
property test as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Test (XMLNAME = "test", XMLPROJECTION = "ELEMENT");
A test in this script.
Property methods: testBuildValueArray(), testCollectionToDisplay(), testCollectionToOdbc(), testDisplayToCollection(), testGet(), testGetObject(), testGetObjectId(), testGetSwizzled(), testIsValid(), testOdbcToCollection(), testSet(), testSetObject(), testSetObjectId()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
A short, descriptive, user-friendly title for the test script.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT") [ Required ];
An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property variable as list of HS.FHIR.vSTU3.Model.Resource.TestScript.Variable (XMLNAME = "variable", XMLPROJECTION = "ELEMENT");
Variable is set based either on element value in response body or on header field value in the response headers.
Property methods: variableBuildValueArray(), variableCollectionToDisplay(), variableCollectionToOdbc(), variableDisplayToCollection(), variableGet(), variableGetObject(), variableGetObjectId(), variableGetSwizzled(), variableIsValid(), variableOdbcToCollection(), variableSet(), variableSetObject(), variableSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetCopyright(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 "copyright" property.
deprecated method SetDate(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 "date" 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 SetExperimental(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 "experimental" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetJurisdiction(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "jurisdiction" 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 SetProfile(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "profile" property.
deprecated method SetPublisher(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 "publisher" property.
deprecated method SetPurpose(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 "purpose" property.
deprecated method SetStatus(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 "status" property.
deprecated method SetTitle(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 "title" property.
deprecated method SetUrl(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 "url" property.
deprecated method SetVersion(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 "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab