HS.FHIR.vSTU3.Model.Resource.Subscription.Channel
deprecated class HS.FHIR.vSTU3.Model.Resource.Subscription.Channel extends HS.FHIR.vSTU3.Model.Base.BackboneElement
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system is able to take an appropriate action.
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 = Subscription.Channel;
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 = Subscription.Channel;
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 endpoint as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
The uri that describes the actual end-point to send messages to.
Property methods: endpointGet(), endpointGetSwizzled(), endpointIsValid(), endpointNewObject(), endpointSet()
property header as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "header", XMLPROJECTION = "ELEMENT");
Additional headers / information to send as part of the notification.
Property methods: headerBuildValueArray(), headerCollectionToDisplay(), headerCollectionToOdbc(), headerDisplayToCollection(), headerGet(), headerGetObject(), headerGetObjectId(), headerGetSwizzled(), headerIsValid(), headerOdbcToCollection(), headerSet(), headerSetObject(), headerSetObjectId()
property payload as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "payload", XMLPROJECTION = "ELEMENT");
The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification.
Property methods: payloadGet(), payloadGetSwizzled(), payloadIsValid(), payloadNewObject(), payloadSet()
property type as HS.FHIR.vSTU3.Model.Base.SubscriptionChannelType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type of channel to send notifications on.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
Methods
deprecated method SetEndpoint(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 "endpoint" property.
Set method for the "endpoint" property.
deprecated method SetHeader(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "header" property.
Insert method for the "header" property.
deprecated method SetPayload(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 "payload" property.
Set method for the "payload" property.
deprecated method SetType(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 "type" property.
Set method for the "type" property.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %CreateProxy()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %FHIRObjectHasValue()
- %FromFHIRJSON()
- %FromFHIRXML()
- %GetClassName()
- %GetJSONType()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ToFHIRJSON()
- %ToFHIRXML()
- %ValidateObject()
- GetReferenceMap()
- UpdateReferences()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()