Skip to main content

HS.FHIR.vSTU3.Model.Resource.Subscription

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

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.
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 = Subscription;
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 channel as HS.FHIR.vSTU3.Model.Resource.Subscription.Channel (XMLNAME = "channel", XMLPROJECTION = "ELEMENT") [ Required ];
Details where to send notifications when resources are received that meet the criteria.
Property methods: channelGet(), channelGetSwizzled(), channelIsValid(), channelNewObject(), channelSet()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property criteria as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "criteria", XMLPROJECTION = "ELEMENT") [ Required ];
The rules that the server should use to determine when to generate notifications for this subscription.
Property methods: criteriaGet(), criteriaGetSwizzled(), criteriaIsValid(), criteriaNewObject(), criteriaSet()
property end as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "end", XMLPROJECTION = "ELEMENT");
The time for the server to turn the subscription off.
Property methods: endGet(), endGetSwizzled(), endIsValid(), endNewObject(), endSet()
property error as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "error", XMLPROJECTION = "ELEMENT");
A record of the last error that occurred when the server processed a notification.
Property methods: errorGet(), errorGetSwizzled(), errorIsValid(), errorNewObject(), errorSet()
property reason as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "reason", XMLPROJECTION = "ELEMENT") [ Required ];
A description of why this subscription is defined.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property status as HS.FHIR.vSTU3.Model.Base.SubscriptionStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of the subscription, which marks the server state for managing the subscription.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property tag as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "tag", XMLPROJECTION = "ELEMENT");
A tag to add to any resource that matches the criteria, after the subscription is processed.
Property methods: tagBuildValueArray(), tagCollectionToDisplay(), tagCollectionToOdbc(), tagDisplayToCollection(), tagGet(), tagGetObject(), tagGetObjectId(), tagGetSwizzled(), tagIsValid(), tagOdbcToCollection(), tagSet(), tagSetObject(), tagSetObjectId()

Methods

deprecated method SetContact(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pRank As %String = "", pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "contact" property.
deprecated method SetCriteria(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 "criteria" property.
deprecated method SetEnd(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 "end" property.
deprecated method SetError(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 "error" property.
deprecated method SetReason(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 "reason" 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 SetTag(pCode As %String = "", pDisplay As %String = "", pSystem 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 "tag" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab