Skip to main content


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

Property Inventory


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.


property AddUpdateHubRequest as HS.Message.AddUpdateHubRequest;
For subscriptions processed on the hub, the AddUpdateHubRequest Used instead of the SDA to include patient information in the metadata
Property methods: AddUpdateHubRequestGet(), AddUpdateHubRequestGetObject(), AddUpdateHubRequestGetObjectId(), AddUpdateHubRequestGetSwizzled(), AddUpdateHubRequestIsValid(), AddUpdateHubRequestNewObject(), AddUpdateHubRequestSet(), AddUpdateHubRequestSetObject(), AddUpdateHubRequestSetObjectId(), AddUpdateHubRequestUnSwizzle()
property DocumentId as %String (MAXLEN = 73) [ Transient ];
The UUID to use for this document.
Property methods: DocumentIdDisplayToLogical(), DocumentIdGet(), DocumentIdIsValid(), DocumentIdLogicalToDisplay(), DocumentIdLogicalToOdbc(), DocumentIdNormalize(), DocumentIdSet()
property DocumentUniqueId as %String (MAXLEN = 128) [ Transient ];
The OID to use for this document. Defaults to the OID representation of the UUID
Property methods: DocumentUniqueIdDisplayToLogical(), DocumentUniqueIdGet(), DocumentUniqueIdIsValid(), DocumentUniqueIdLogicalToDisplay(), DocumentUniqueIdLogicalToOdbc(), DocumentUniqueIdNormalize(), DocumentUniqueIdSet()
property PushDocumentId as %String;
Pointer to the document in the push repository. This will be purged by the push repository manager
Property methods: PushDocumentIdDisplayToLogical(), PushDocumentIdGet(), PushDocumentIdIsValid(), PushDocumentIdLogicalToDisplay(), PushDocumentIdLogicalToOdbc(), PushDocumentIdNormalize(), PushDocumentIdSet()
property SDA as %Stream.GlobalCharacter (CONTENT = "MIXED") [ Transient ];
The SDA container stream, used only during metadata transform
Property methods: SDADelete(), SDAGet(), SDAGetObject(), SDAGetObjectId(), SDAGetSwizzled(), SDAIsValid(), SDANewObject(), SDAOid(), SDAOpen(), SDASet(), SDASetObject(), SDASetObjectId(), SDAUnSwizzle()
property SDAStreamId as %String;
Pointer to the SDA container used to generate this document. This will be purged by the push repository manager
Property methods: SDAStreamIdDisplayToLogical(), SDAStreamIdGet(), SDAStreamIdIsValid(), SDAStreamIdLogicalToDisplay(), SDAStreamIdLogicalToOdbc(), SDAStreamIdNormalize(), SDAStreamIdSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab