Skip to main content


serial class HS.Message.IHE.XDSb.QueryItem extends %Library.SerialObject, %XML.Adaptor

Property Inventory

Method Inventory


parameter FOUNDATION = 1;
HealthShare Foundation
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 CodedValues as list of HS.IHE.XDSb.Types.CodedValue;
Property methods: CodedValuesBuildValueArray(), CodedValuesCollectionToDisplay(), CodedValuesCollectionToOdbc(), CodedValuesDisplayToCollection(), CodedValuesGet(), CodedValuesGetObject(), CodedValuesGetObjectId(), CodedValuesGetSwizzled(), CodedValuesIsValid(), CodedValuesOdbcToCollection(), CodedValuesSet(), CodedValuesSetObject(), CodedValuesSetObjectId()
property ItemName as %String;
$XDSDocumentEntryPatientId,$XDSDocumentEntryStatus, etc
Property methods: ItemNameDisplayToLogical(), ItemNameGet(), ItemNameIsValid(), ItemNameLogicalToDisplay(), ItemNameLogicalToOdbc(), ItemNameNormalize(), ItemNameSet()
property SingleValue as %Boolean [ InitialExpression = 0 ];
if this is a single value field then there should be no () surrounding the value
Property methods: SingleValueDisplayToLogical(), SingleValueGet(), SingleValueIsValid(), SingleValueLogicalToDisplay(), SingleValueLogicalToXSD(), SingleValueNormalize(), SingleValueSet(), SingleValueXSDToLogical()
property Values as list of %String);
Property methods: ValuesBuildValueArray(), ValuesCollectionToDisplay(), ValuesCollectionToOdbc(), ValuesDisplayToCollection(), ValuesDisplayToLogical(), ValuesGet(), ValuesGetObject(), ValuesGetObjectId(), ValuesGetSwizzled(), ValuesIsValid(), ValuesLogicalToDisplay(), ValuesLogicalToOdbc(), ValuesNormalize(), ValuesOdbcToCollection(), ValuesSet(), ValuesSetObject(), ValuesSetObjectId()


classmethod CodedValue(pName, pCode, pScheme) as QueryItem
$XDSDocumentEntryEntryUUID $XDSDocumentEntryUniqueId $XDSDocumentEntryPracticeSettingCode $XDSDocumentEntryClassificationNode $XDSDocumentEntryClassCode $XDSDocumentEntryConfidentialityCode $XDSDocumentEntryEventCodeList $XDSDocumentEntryFormatCode $XDSDocumentEntryHealthcareFacilityTypeCode $XDSDocumentEntryTypeCode $XDSDocumentEntryType $XDSDocumentEntryPatientId $XDSDocumentEntryAuthorPerson $XDSDocumentEntryServiceStartTimeFrom $XDSDocumentEntryServiceStartTimeTo $XDSDocumentEntryServiceStopTimeFrom $XDSDocumentEntryServiceStopTimeTo $XDSDocumentEntryStatus
classmethod CreationFrom(pParam) as QueryItem
classmethod CreationTo(pParam) as QueryItem
classmethod DocumentType(pType=1) as QueryItem
pType=1 - Stable, 2 - OnDemand, 3 - both
classmethod PatientId(pPatientId) as QueryItem
classmethod SingleParam(pParam, pName) as QueryItem
Helper methods used to add single value items to the query
classmethod StatusValues(pValues, pItemName="$XDSDocumentEntryStatus") as QueryItem
Ability to add status values either one or comma delimited Approved,Deprecated without full name resolution

Inherited Members

Inherited Methods

FeedbackOpens in a new tab