Skip to main content

HS.FHIR.DTL.vR4.Model.Element.TestScript.setup.action.operation

class HS.FHIR.DTL.vR4.Model.Element.TestScript.setup.action.operation extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

The setup operation to perform.

Property 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.setup.action.operation;
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 XMLPROJECTION = ELEMENT;
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.setup.action.operation;
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 accept as %String (MAXLEN = 1000000, XMLNAME = "accept", XMLPROJECTION = "ATTRIBUTE");
code

Mime type to accept in the payload of the response, with charset etc.

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: acceptDisplayToLogical(), acceptGet(), acceptIsValid(), acceptLogicalToDisplay(), acceptLogicalToOdbc(), acceptNormalize(), acceptSet()
property contentType as %String (MAXLEN = 1000000, XMLNAME = "contentType", XMLPROJECTION = "ATTRIBUTE");
code

Mime type of the request payload contents, with charset etc.

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: contentTypeDisplayToLogical(), contentTypeGet(), contentTypeIsValid(), contentTypeLogicalToDisplay(), contentTypeLogicalToOdbc(), contentTypeNormalize(), contentTypeSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Tracking/reporting operation description.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property destination as %Integer (XMLNAME = "destination", XMLPROJECTION = "ATTRIBUTE");
integer

Server responding to the request.

Property methods: destinationDisplayToLogical(), destinationGet(), destinationIsValid(), destinationLogicalToDisplay(), destinationNormalize(), destinationSet(), destinationXSDToLogical()
property encodeRequestUrl as %Boolean (XMLNAME = "encodeRequestUrl", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Whether or not to send the request url in encoded format.

Property methods: encodeRequestUrlDisplayToLogical(), encodeRequestUrlGet(), encodeRequestUrlIsValid(), encodeRequestUrlLogicalToDisplay(), encodeRequestUrlLogicalToXSD(), encodeRequestUrlNormalize(), encodeRequestUrlSet(), encodeRequestUrlXSDToLogical()
property label as %String (MAXLEN = 1000000, XMLNAME = "label", XMLPROJECTION = "ATTRIBUTE");
string

Tracking/logging operation label.

Property methods: labelDisplayToLogical(), labelGet(), labelIsValid(), labelLogicalToDisplay(), labelLogicalToOdbc(), labelNormalize(), labelSet()
property method as %String (MAXLEN = 1000000, XMLNAME = "method", XMLPROJECTION = "ATTRIBUTE");
code

delete | get | options | patch | post | put | head

http-operations|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend http-operations|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: methodDisplayToLogical(), methodGet(), methodIsValid(), methodLogicalToDisplay(), methodLogicalToOdbc(), methodNormalize(), methodSet()
property origin as %Integer (XMLNAME = "origin", XMLPROJECTION = "ATTRIBUTE");
integer

Server initiating the request.

Property methods: originDisplayToLogical(), originGet(), originIsValid(), originLogicalToDisplay(), originNormalize(), originSet(), originXSDToLogical()
property params as %String (MAXLEN = 1000000, XMLNAME = "params", XMLPROJECTION = "ATTRIBUTE");
string

Explicitly defined path parameters.

Property methods: paramsDisplayToLogical(), paramsGet(), paramsIsValid(), paramsLogicalToDisplay(), paramsLogicalToOdbc(), paramsNormalize(), paramsSet()
property requestHeader as list of HS.FHIR.DTL.vR4.Model.Element.TestScript.setup.action.operation.requestHeader (XMLNAME = "requestHeader", XMLPROJECTION = "ELEMENT");
BackboneElement

Each operation can have one or more header elements.

Property methods: requestHeaderBuildValueArray(), requestHeaderCollectionToDisplay(), requestHeaderCollectionToOdbc(), requestHeaderDisplayToCollection(), requestHeaderGet(), requestHeaderGetObject(), requestHeaderGetObjectId(), requestHeaderGetSwizzled(), requestHeaderIsValid(), requestHeaderOdbcToCollection(), requestHeaderSet(), requestHeaderSetObject(), requestHeaderSetObjectId()
property requestId as %String (MAXLEN = 1000000, XMLNAME = "requestId", XMLPROJECTION = "ATTRIBUTE");
id

Fixture Id of mapped request.

Property methods: requestIdDisplayToLogical(), requestIdGet(), requestIdIsValid(), requestIdLogicalToDisplay(), requestIdLogicalToOdbc(), requestIdNormalize(), requestIdSet()
property resource as %String (MAXLEN = 1000000, XMLNAME = "resource", XMLPROJECTION = "ATTRIBUTE");
code

Resource type.

defined-types|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend defined-types|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: resourceDisplayToLogical(), resourceGet(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
property responseId as %String (MAXLEN = 1000000, XMLNAME = "responseId", XMLPROJECTION = "ATTRIBUTE");
id

Fixture Id of mapped response.

Property methods: responseIdDisplayToLogical(), responseIdGet(), responseIdIsValid(), responseIdLogicalToDisplay(), responseIdLogicalToOdbc(), responseIdNormalize(), responseIdSet()
property sourceId as %String (MAXLEN = 1000000, XMLNAME = "sourceId", XMLPROJECTION = "ATTRIBUTE");
id

Fixture Id of body for PUT and POST requests.

Property methods: sourceIdDisplayToLogical(), sourceIdGet(), sourceIdIsValid(), sourceIdLogicalToDisplay(), sourceIdLogicalToOdbc(), sourceIdNormalize(), sourceIdSet()
property targetId as %String (MAXLEN = 1000000, XMLNAME = "targetId", XMLPROJECTION = "ATTRIBUTE");
id

Id of fixture used for extracting the [id], [type], and [vid] for GET requests.

Property methods: targetIdDisplayToLogical(), targetIdGet(), targetIdIsValid(), targetIdLogicalToDisplay(), targetIdLogicalToOdbc(), targetIdNormalize(), targetIdSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
Coding

The operation code type that will be executed.

testscript-operation-codes is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in testscript-operation-codes, you may formally EXTEND testscript-operation-codes to add codes to it.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
string

Request URL.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab