Skip to main content

HS.Types.SubscriptionSerialInfo

serial class HS.Types.SubscriptionSerialInfo extends %Library.SerialObject, %XML.Adaptor

Embedded in the AddUpdateHubResponse, this contains everything needed to process the message using a subscription

Property Inventory

Method Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property AccessGWEndPoint as %String (MAXLEN = 500) [ Calculated ];
Calculation will contain the endpoint URL to get to the access gateway to contact the delivery manager
Property methods: AccessGWEndPointCompute(), AccessGWEndPointDisplayToLogical(), AccessGWEndPointGet(), AccessGWEndPointIsValid(), AccessGWEndPointLogicalToDisplay(), AccessGWEndPointLogicalToOdbc(), AccessGWEndPointNormalize(), AccessGWEndPointSQLCompute()
property AccessGWID as %String;
the ID of the access gateway in the HS.Gateway.Config table
Property methods: AccessGWIDDisplayToLogical(), AccessGWIDGet(), AccessGWIDIsValid(), AccessGWIDLogicalToDisplay(), AccessGWIDLogicalToOdbc(), AccessGWIDNormalize(), AccessGWIDSet()
property AccessGateway as %String (MAXLEN = 500);
Deprecated - newer use will use AccessGWID and EndPoint
Property methods: AccessGatewayDisplayToLogical(), AccessGatewayGet(), AccessGatewayIsValid(), AccessGatewayLogicalToDisplay(), AccessGatewayLogicalToOdbc(), AccessGatewayNormalize(), AccessGatewaySet()
property AnalyticsFilters as list of HS.Push.Types.FilterSerialInfo;
Property methods: AnalyticsFiltersBuildValueArray(), AnalyticsFiltersCollectionToDisplay(), AnalyticsFiltersCollectionToOdbc(), AnalyticsFiltersDisplayToCollection(), AnalyticsFiltersGet(), AnalyticsFiltersGetObject(), AnalyticsFiltersGetObjectId(), AnalyticsFiltersGetSwizzled(), AnalyticsFiltersIsValid(), AnalyticsFiltersOdbcToCollection(), AnalyticsFiltersSet(), AnalyticsFiltersSetObject(), AnalyticsFiltersSetObjectId()
property BatchNotification as %Boolean;
Whether to schedule notification
Property methods: BatchNotificationDisplayToLogical(), BatchNotificationGet(), BatchNotificationIsValid(), BatchNotificationLogicalToDisplay(), BatchNotificationLogicalToXSD(), BatchNotificationNormalize(), BatchNotificationSet(), BatchNotificationXSDToLogical()
property ContentScope as %String (VALUELIST = ",Msg,Enc,MRN,MPI");
Determines the SDA container sent to the transform
Property methods: ContentScopeDisplayToLogical(), ContentScopeGet(), ContentScopeIsValid(), ContentScopeLogicalToDisplay(), ContentScopeLogicalToOdbc(), ContentScopeNormalize(), ContentScopeSet()
property DeliveryOperation as Ens.DataType.ConfigName;
Property methods: DeliveryOperationDisplayToLogical(), DeliveryOperationGet(), DeliveryOperationIsValid(), DeliveryOperationLogicalToDisplay(), DeliveryOperationLogicalToOdbc(), DeliveryOperationNormalize(), DeliveryOperationParseConfigNameSpec(), DeliveryOperationSet()
property DeliveryPolicyID as %String;
Included here so we can eliminate duplicate transmissions using the same delivery
Property methods: DeliveryPolicyIDDisplayToLogical(), DeliveryPolicyIDGet(), DeliveryPolicyIDIsValid(), DeliveryPolicyIDLogicalToDisplay(), DeliveryPolicyIDLogicalToOdbc(), DeliveryPolicyIDNormalize(), DeliveryPolicyIDSet()
property DeliveryType as %String (VALUELIST = ",EMAIL,FAX,EDI,XDR,XDSb.Stable,XDSb.OnDemand");
EMAIL or OTHER (future - FAX)
Property methods: DeliveryTypeDisplayToLogical(), DeliveryTypeGet(), DeliveryTypeIsValid(), DeliveryTypeLogicalToDisplay(), DeliveryTypeLogicalToOdbc(), DeliveryTypeNormalize(), DeliveryTypeSet()
property DetailFilters as list of HS.Push.Types.FilterSerialInfo;
Property methods: DetailFiltersBuildValueArray(), DetailFiltersCollectionToDisplay(), DetailFiltersCollectionToOdbc(), DetailFiltersDisplayToCollection(), DetailFiltersGet(), DetailFiltersGetObject(), DetailFiltersGetObjectId(), DetailFiltersGetSwizzled(), DetailFiltersIsValid(), DetailFiltersOdbcToCollection(), DetailFiltersSet(), DetailFiltersSetObject(), DetailFiltersSetObjectId()
property EmailAddress as %String (MAXLEN = 500);
Property methods: EmailAddressDisplayToLogical(), EmailAddressGet(), EmailAddressIsValid(), EmailAddressLogicalToDisplay(), EmailAddressLogicalToOdbc(), EmailAddressNormalize(), EmailAddressSet()
property EmailOperation as Ens.DataType.ConfigName;
Property methods: EmailOperationDisplayToLogical(), EmailOperationGet(), EmailOperationIsValid(), EmailOperationLogicalToDisplay(), EmailOperationLogicalToOdbc(), EmailOperationNormalize(), EmailOperationParseConfigNameSpec(), EmailOperationSet()
property EndPoint as %String (MAXLEN = 500);
This will contain the endpoint ID from the delivery policy (ID in the service registry) For EDI policies, it gets passed into the custom delivery operation For Email policies, it gets passed into the custom email construction operation, where it's available for constructing a link to some external system
Property methods: EndPointDisplayToLogical(), EndPointGet(), EndPointIsValid(), EndPointLogicalToDisplay(), EndPointLogicalToOdbc(), EndPointNormalize(), EndPointSet()
property FaxNumber as %String (MAXLEN = 80);
Property methods: FaxNumberDisplayToLogical(), FaxNumberGet(), FaxNumberIsValid(), FaxNumberLogicalToDisplay(), FaxNumberLogicalToOdbc(), FaxNumberNormalize(), FaxNumberSet()
property PatientReportId as %String;
Property methods: PatientReportIdDisplayToLogical(), PatientReportIdGet(), PatientReportIdIsValid(), PatientReportIdLogicalToDisplay(), PatientReportIdLogicalToOdbc(), PatientReportIdNormalize(), PatientReportIdSet()
property RecipientConsent as %String);
The consent for this recipient applied on the SDA container before transformation. If null, consent evaluation is skipped
Property methods: RecipientConsentDisplayToLogical(), RecipientConsentGet(), RecipientConsentIsValid(), RecipientConsentLogicalToDisplay(), RecipientConsentLogicalToOdbc(), RecipientConsentNormalize(), RecipientConsentSet()
property RecipientID as %String;
for the clinician or the system
Property methods: RecipientIDDisplayToLogical(), RecipientIDGet(), RecipientIDIsValid(), RecipientIDLogicalToDisplay(), RecipientIDLogicalToOdbc(), RecipientIDNormalize(), RecipientIDSet()
property RecipientRoles as %String);
The roles for this recipient used to determine the RecipientConsent If null, consent evaluation is skipped
Property methods: RecipientRolesDisplayToLogical(), RecipientRolesGet(), RecipientRolesIsValid(), RecipientRolesLogicalToDisplay(), RecipientRolesLogicalToOdbc(), RecipientRolesNormalize(), RecipientRolesSet()
property RecipientType as %String;
C - Clinician, S - System
Property methods: RecipientTypeDisplayToLogical(), RecipientTypeGet(), RecipientTypeIsValid(), RecipientTypeLogicalToDisplay(), RecipientTypeLogicalToOdbc(), RecipientTypeNormalize(), RecipientTypeSet()
property Subject as %String (MAXLEN = 256);
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()
property SubscriptionId as %String;
Property methods: SubscriptionIdDisplayToLogical(), SubscriptionIdGet(), SubscriptionIdIsValid(), SubscriptionIdLogicalToDisplay(), SubscriptionIdLogicalToOdbc(), SubscriptionIdNormalize(), SubscriptionIdSet()
property TransProfile as %String (MAXLEN = 256);
Terminology Translation Profile
Property methods: TransProfileDisplayToLogical(), TransProfileGet(), TransProfileIsValid(), TransProfileLogicalToDisplay(), TransProfileLogicalToOdbc(), TransProfileNormalize(), TransProfileSet()
property TransformCustomOperation as Ens.DataType.ConfigName;
Property methods: TransformCustomOperationDisplayToLogical(), TransformCustomOperationGet(), TransformCustomOperationIsValid(), TransformCustomOperationLogicalToDisplay(), TransformCustomOperationLogicalToOdbc(), TransformCustomOperationNormalize(), TransformCustomOperationParseConfigNameSpec(), TransformCustomOperationSet()
property TransformationType as %String;
XSLT, PDF, HTML, or CUSTOM, or nil (for plain SDA)
Property methods: TransformationTypeDisplayToLogical(), TransformationTypeGet(), TransformationTypeIsValid(), TransformationTypeLogicalToDisplay(), TransformationTypeLogicalToOdbc(), TransformationTypeNormalize(), TransformationTypeSet()
property UserId as %String;
Property methods: UserIdDisplayToLogical(), UserIdGet(), UserIdIsValid(), UserIdLogicalToDisplay(), UserIdLogicalToOdbc(), UserIdNormalize(), UserIdSet()
property XSLTFileSpec as %String;
Property methods: XSLTFileSpecDisplayToLogical(), XSLTFileSpecGet(), XSLTFileSpecIsValid(), XSLTFileSpecLogicalToDisplay(), XSLTFileSpecLogicalToOdbc(), XSLTFileSpecNormalize(), XSLTFileSpecSet()

Methods

classmethod GetAccessGWEndPoint(pGWID)

Inherited Members

Inherited Methods

FeedbackOpens in a new tab