Skip to main content


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

Property Inventory

Method 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 Dates as list of DateFilter;
If date filters are specified, then the ECR Fetch will either filter everything by its appropriate date, in a hierarchical fashion. For example, if a date filter is provided for "type.sub" this will apply to all items with "type.sub", but not "type" or "type.othersub" A date filter for "type" will apply to all items with "type", "type.sub" unless overridded by an explicit sub-filter. A date filter for "" ("[ All ]" in the UI) provides a default date range for all items unless overridden. Althouugh the date filter structure allows for a ThruDate, that's not used. The FromDate is inclusive, and is compared to the FilterDate on the streamlet If missing, this is assumed to be "current" - i.e. after any FromDate
Property methods: DatesBuildValueArray(), DatesCollectionToDisplay(), DatesCollectionToOdbc(), DatesDisplayToCollection(), DatesGet(), DatesGetObject(), DatesGetObjectId(), DatesGetSwizzled(), DatesIsValid(), DatesOdbcToCollection(), DatesSet(), DatesSetObject(), DatesSetObjectId()
property DocumentNumbers as list of %String;
If DocumentNumbers are specified, then this will only return documents whose DocumentNumber is in the list (irrespective of DocumentType or Date filters) DocumentNumbers is case-sensitive.
Property methods: DocumentNumbersBuildValueArray(), DocumentNumbersCollectionToDisplay(), DocumentNumbersCollectionToOdbc(), DocumentNumbersDisplayToCollection(), DocumentNumbersDisplayToLogical(), DocumentNumbersGet(), DocumentNumbersGetObject(), DocumentNumbersGetObjectId(), DocumentNumbersGetSwizzled(), DocumentNumbersIsValid(), DocumentNumbersLogicalToDisplay(), DocumentNumbersLogicalToOdbc(), DocumentNumbersNormalize(), DocumentNumbersOdbcToCollection(), DocumentNumbersSet(), DocumentNumbersSetObject(), DocumentNumbersSetObjectId()
property ExcludeFacilities as list of HS.Types.Facility;
If you specify ExcludeFacilities, then MRNs from all facilities except the ones specified will be returned This will be ignored if IncludeFacilities is specified
Property methods: ExcludeFacilitiesBuildValueArray(), ExcludeFacilitiesCollectionToDisplay(), ExcludeFacilitiesCollectionToOdbc(), ExcludeFacilitiesDisplayToCollection(), ExcludeFacilitiesDisplayToLogical(), ExcludeFacilitiesGet(), ExcludeFacilitiesGetObject(), ExcludeFacilitiesGetObjectId(), ExcludeFacilitiesGetSwizzled(), ExcludeFacilitiesIsValid(), ExcludeFacilitiesLogicalToDisplay(), ExcludeFacilitiesLogicalToOdbc(), ExcludeFacilitiesNormalize(), ExcludeFacilitiesOdbcToCollection(), ExcludeFacilitiesSet(), ExcludeFacilitiesSetObject(), ExcludeFacilitiesSetObjectId()
property IncludeFacilities as list of HS.Types.Facility;
You may specified either IncludeFacilities or ExcludeFacilities but not both If you specify IncludeFacilities, then only MRNs from those facilities will be returned
Property methods: IncludeFacilitiesBuildValueArray(), IncludeFacilitiesCollectionToDisplay(), IncludeFacilitiesCollectionToOdbc(), IncludeFacilitiesDisplayToCollection(), IncludeFacilitiesDisplayToLogical(), IncludeFacilitiesGet(), IncludeFacilitiesGetObject(), IncludeFacilitiesGetObjectId(), IncludeFacilitiesGetSwizzled(), IncludeFacilitiesIsValid(), IncludeFacilitiesLogicalToDisplay(), IncludeFacilitiesLogicalToOdbc(), IncludeFacilitiesNormalize(), IncludeFacilitiesOdbcToCollection(), IncludeFacilitiesSet(), IncludeFacilitiesSetObject(), IncludeFacilitiesSetObjectId()
property InfoTypes as list of %String;
If InfoTypes are specified, then the ECR Fetch should only return data for the specified types Each InfoType can be or . or .. Note that type, subtype and subsubtype are all upper-case only. An infotype is supported if there is a class which extends HS.SDA3.Streamlet.Abstract with that infotype and a non-empty MATCHINGS parameter (except ENC, which has no MATCHINGS parameter but is supported anyway).
The full list of supported infotypes can be found using the class query ListAvailableInfoTypes from HS.InfoType.Config
Property methods: InfoTypesBuildValueArray(), InfoTypesCollectionToDisplay(), InfoTypesCollectionToOdbc(), InfoTypesDisplayToCollection(), InfoTypesDisplayToLogical(), InfoTypesGet(), InfoTypesGetObject(), InfoTypesGetObjectId(), InfoTypesGetSwizzled(), InfoTypesIsValid(), InfoTypesLogicalToDisplay(), InfoTypesLogicalToOdbc(), InfoTypesNormalize(), InfoTypesOdbcToCollection(), InfoTypesSet(), InfoTypesSetObject(), InfoTypesSetObjectId()
property VisitNumbers as list of %String;
If EncounterNumbers are specified, then this will only return encounters whose number (visit number, or episode number) is in the list (and match the dates, if specified) VisitNumbers is case-sensitive.
Property methods: VisitNumbersBuildValueArray(), VisitNumbersCollectionToDisplay(), VisitNumbersCollectionToOdbc(), VisitNumbersDisplayToCollection(), VisitNumbersDisplayToLogical(), VisitNumbersGet(), VisitNumbersGetObject(), VisitNumbersGetObjectId(), VisitNumbersGetSwizzled(), VisitNumbersIsValid(), VisitNumbersLogicalToDisplay(), VisitNumbersLogicalToOdbc(), VisitNumbersNormalize(), VisitNumbersOdbcToCollection(), VisitNumbersSet(), VisitNumbersSetObject(), VisitNumbersSetObjectId()


method GetFilters(ByRef pFilters As %String) as %Status
method GetFiltersOld(ByRef pFilters As %String)
old code, no longer used for SDA3/Streamlets. sub-sub not in use anymore

Inherited Members

Inherited Methods

FeedbackOpens in a new tab