Skip to main content


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

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


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.
parameter XMLTYPE = Subscription;
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 channel as (XMLNAME = "channel", XMLPROJECTION = "ELEMENT") [ Required ];

The channel on which to report matches to the criteria.

Property methods: channelGet(), channelGetSwizzled(), channelIsValid(), channelNewObject(), channelSet()
property contact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactPoint (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact details for source (e.g. troubleshooting)

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property criteria as %String (MAXLEN = 1000000, XMLNAME = "criteria", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Rule for server push criteria.

Property methods: criteriaDisplayToLogical(), criteriaGet(), criteriaIsValid(), criteriaLogicalToDisplay(), criteriaLogicalToOdbc(), criteriaNormalize(), criteriaSet()
property end as %String (MAXLEN = 1000000, XMLNAME = "end", XMLPROJECTION = "ATTRIBUTE");

When to automatically delete the subscription.

Property methods: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property error as %String (MAXLEN = 1000000, XMLNAME = "error", XMLPROJECTION = "ATTRIBUTE");

Latest error note.

Property methods: errorDisplayToLogical(), errorGet(), errorIsValid(), errorLogicalToDisplay(), errorLogicalToOdbc(), errorNormalize(), errorSet()
property reason as %String (MAXLEN = 1000000, XMLNAME = "reason", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Description of why this subscription was created.

Property methods: reasonDisplayToLogical(), reasonGet(), reasonIsValid(), reasonLogicalToDisplay(), reasonLogicalToOdbc(), reasonNormalize(), reasonSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

requested | active | error | off

subscription-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend subscription-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property tag as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "tag", XMLPROJECTION = "ELEMENT");

A tag to add to matching resources.

any FHIR3 code may be used; subscription-tag shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: tagBuildValueArray(), tagCollectionToDisplay(), tagCollectionToOdbc(), tagDisplayToCollection(), tagGet(), tagGetObject(), tagGetObjectId(), tagGetSwizzled(), tagIsValid(), tagOdbcToCollection(), tagSet(), tagSetObject(), tagSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab