HS.FHIRModel.R4.SubscriptionX.Channel
class HS.FHIRModel.R4.SubscriptionX.Channel extends HS.FHIRModel.FHIRClassSuper
******************************************* SubscriptionX.Channel generated class schema
*****************************************
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 can take an appropriate action.
Property Inventory
Method Inventory
Parameters
parameter XMLTYPE = R4_SUBSCRIPTIONX_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.FHIRModel.R4.Element;
Extensions for endpoint
Property methods: _endpointGet(), _endpointGetSwizzled(), _endpointIsValid(), _endpointNewObject(), _endpointSet()
property _header as HS.FHIRModel.R4.SeqOfElement;
Extensions for header
Property methods: _headerGet(), _headerGetSwizzled(), _headerIsValid(), _headerNewObject(), _headerSet()
property _payload as HS.FHIRModel.R4.Element;
Extensions for payload
Property methods: _payloadGet(), _payloadGetSwizzled(), _payloadIsValid(), _payloadNewObject(), _payloadSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property endpoint as %String;
The url that describes the actual end-point to send messages to.
Property methods: endpointDisplayToLogical(), endpointGet(), endpointIsValid(), endpointLogicalToDisplay(), endpointLogicalToOdbc(), endpointNormalize(), endpointSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property header as HS.FHIRModel.R4.SeqOfString;
Additional headers / information to send as part of the notification.
Property methods: headerGet(), headerGetSwizzled(), headerIsValid(), headerNewObject(), headerSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element and that modifies the understanding
of the element in which it is contained and/or the understanding
of the containing element's descendants. Usually modifier elements
provide negation or qualification. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension. Applications
processing a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property payload as %String;
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. The mime
type "text/plain" may also be used for Email and SMS subscriptions.
Property methods: payloadDisplayToLogical(), payloadGet(), payloadIsValid(), payloadLogicalToDisplay(), payloadLogicalToOdbc(), payloadNormalize(), payloadSet()
property type as %String (VALUELIST = ",rest-hook,websocket,email,sms,message");
The type of channel to send notifications on.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
Methods
method IncludeExtension()
method IncludeHeader()
method IncludeModifierExtension()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.SubscriptionX.Channel
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()