Skip to main content

class extends HS.FHIR.DTL.vSTU3.Model.Base.BackboneElement

If the endpoint is a RESTful one.

Property Inventory


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


property compartment as list of %String (MAXLEN = 1000000, XMLNAME = "compartment", XMLPROJECTION = "ELEMENT");

Compartments served/used by system.

Property methods: compartmentBuildValueArray(), compartmentCollectionToDisplay(), compartmentCollectionToOdbc(), compartmentDisplayToCollection(), compartmentDisplayToLogical(), compartmentGet(), compartmentGetObject(), compartmentGetObjectId(), compartmentGetSwizzled(), compartmentIsValid(), compartmentLogicalToDisplay(), compartmentLogicalToOdbc(), compartmentNormalize(), compartmentOdbcToCollection(), compartmentSet(), compartmentSetObject(), compartmentSetObjectId()
property documentation as %String (MAXLEN = 1000000, XMLNAME = "documentation", XMLPROJECTION = "ATTRIBUTE");

General description of implementation.

Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property interaction as list of (XMLNAME = "interaction", XMLPROJECTION = "ELEMENT");

What operations are supported?

Property methods: interactionBuildValueArray(), interactionCollectionToDisplay(), interactionCollectionToOdbc(), interactionDisplayToCollection(), interactionGet(), interactionGetObject(), interactionGetObjectId(), interactionGetSwizzled(), interactionIsValid(), interactionOdbcToCollection(), interactionSet(), interactionSetObject(), interactionSetObjectId()
property mode as %String (MAXLEN = 1000000, XMLNAME = "mode", XMLPROJECTION = "ATTRIBUTE") [ Required ];

client | server

restful-capability-mode is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend restful-capability-mode and you may NOT use codes from other ValueSets.

Property methods: modeDisplayToLogical(), modeGet(), modeIsValid(), modeLogicalToDisplay(), modeLogicalToOdbc(), modeNormalize(), modeSet()
property operation as list of (XMLNAME = "operation", XMLPROJECTION = "ELEMENT");

Definition of an operation or a custom query.

Property methods: operationBuildValueArray(), operationCollectionToDisplay(), operationCollectionToOdbc(), operationDisplayToCollection(), operationGet(), operationGetObject(), operationGetObjectId(), operationGetSwizzled(), operationIsValid(), operationOdbcToCollection(), operationSet(), operationSetObject(), operationSetObjectId()
property resource as list of (XMLNAME = "resource", XMLPROJECTION = "ELEMENT");

Resource served on the REST interface.

Property methods: resourceBuildValueArray(), resourceCollectionToDisplay(), resourceCollectionToOdbc(), resourceDisplayToCollection(), resourceGet(), resourceGetObject(), resourceGetObjectId(), resourceGetSwizzled(), resourceIsValid(), resourceOdbcToCollection(), resourceSet(), resourceSetObject(), resourceSetObjectId()
property searchParam as list of (XMLNAME = "searchParam", XMLPROJECTION = "ELEMENT");

Search parameters for searching all resources.

Property methods: searchParamBuildValueArray(), searchParamCollectionToDisplay(), searchParamCollectionToOdbc(), searchParamDisplayToCollection(), searchParamGet(), searchParamGetObject(), searchParamGetObjectId(), searchParamGetSwizzled(), searchParamIsValid(), searchParamOdbcToCollection(), searchParamSet(), searchParamSetObject(), searchParamSetObjectId()
property security as (XMLNAME = "security", XMLPROJECTION = "ELEMENT");

Information about security of implementation.

Property methods: securityGet(), securityGetSwizzled(), securityIsValid(), securityNewObject(), securitySet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab