Skip to main content

HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Messaging

deprecated class HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Messaging extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

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 = CapabilityStatement.Messaging;
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 = CapabilityStatement.Messaging;
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 documentation as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
Property methods: documentationGet(), documentationGetSwizzled(), documentationIsValid(), documentationNewObject(), documentationSet()
property endpoint as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Endpoint (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
An endpoint (network accessible address) to which messages and/or replies are to be sent.
Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property event as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Event (XMLNAME = "event", XMLPROJECTION = "ELEMENT");
A description of the solution's support for an event at this end-point.
Property methods: eventBuildValueArray(), eventCollectionToDisplay(), eventCollectionToOdbc(), eventDisplayToCollection(), eventGet(), eventGetObject(), eventGetObjectId(), eventGetSwizzled(), eventIsValid(), eventOdbcToCollection(), eventSet(), eventSetObject(), eventSetObjectId()
property reliableCache as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "reliableCache", XMLPROJECTION = "ELEMENT");
Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
Property methods: reliableCacheGet(), reliableCacheGetSwizzled(), reliableCacheIsValid(), reliableCacheNewObject(), reliableCacheSet()
property supportedMessage as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.SupportedMessage (XMLNAME = "supportedMessage", XMLPROJECTION = "ELEMENT");
References to message definitions for messages this system can send or receive.
Property methods: supportedMessageBuildValueArray(), supportedMessageCollectionToDisplay(), supportedMessageCollectionToOdbc(), supportedMessageDisplayToCollection(), supportedMessageGet(), supportedMessageGetObject(), supportedMessageGetObjectId(), supportedMessageGetSwizzled(), supportedMessageIsValid(), supportedMessageOdbcToCollection(), supportedMessageSet(), supportedMessageSetObject(), supportedMessageSetObjectId()

Methods

deprecated method SetDocumentation(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 "documentation" property.
deprecated method SetReliableCache(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 "reliableCache" property.

Inherited Members

Inherited Properties

Inherited Methods