Skip to main content


class HS.FHIRServer.API.SearchQueryParameter extends %Library.RegisteredObject

Property Inventory

Method Inventory


property isComposite as %Boolean [ Calculated ];
Parameter type is composite (0/1).
Property methods: isCompositeDisplayToLogical(), isCompositeIsValid(), isCompositeLogicalToDisplay(), isCompositeNormalize()
property modifier as %String;
Property methods: modifierDisplayToLogical(), modifierGet(), modifierIsValid(), modifierLogicalToDisplay(), modifierLogicalToOdbc(), modifierNormalize(), modifierSet()
property name as %String;
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property nextInChain as HS.FHIRServer.API.SearchQueryParameter;
Property methods: nextInChainGet(), nextInChainGetSwizzled(), nextInChainIsValid(), nextInChainNewObject(), nextInChainSet()
property nextInRevChain as %List;
Property methods: nextInRevChainGet(), nextInRevChainIsValid(), nextInRevChainLogicalToOdbc(), nextInRevChainOdbcToLogical(), nextInRevChainSet()
property searchParam;
Property methods: searchParamDisplayToLogical(), searchParamGet(), searchParamIsValid(), searchParamLogicalToDisplay(), searchParamLogicalToOdbc(), searchParamNormalize(), searchParamSet()
property value as %String;
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()


method %OnNew(name As %String, value As %String, modifier As %String = "", searchParam As HS.FHIRServer.SearchParam = "") as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method AsString(encodeValue As %Boolean = 1) as %String
Return this object instance as a string. URI-encode the value part, if indicated by encodeValue. encodeValue default is 1 (true) for backward compatibility.
method CompositeORConditionAsList(pORPosition As %Integer) as %List
Returns the specified composite OR condition value as a $List whose elements are the two sides of the $-delimited composite value, each element being a $List of the unescaped vertical bar pieces of the composite side. Example:
- $lb( $lb("", "2823-3"), $lb("gt5.4", "", "mmol/L") )
method NonCompositeORConditionAsList(pORPosition As %Integer) as %List
Returns the specified non-composite OR condition value as a $List whose elements are the unescaped vertical bar pieces of the value. Examples:
- $lb("smith")
- $lb("", "8302-2")
- $lb("56.03", "", "cm")
method ORConditionAsEscapedString(pORPosition As %Integer) as %String
Return the specified OR condition as a string, with escaping backslashes removed. The returned value reflects the application of escaping of the reserved characters, and reflects what should actually be applied as the search value.
method ORConditionAsParamObj(pORPosition As %Integer) as HS.FHIRServer.API.SearchQueryParameter
Return a SearchQueryParameter object that represents only a single specified OR condition of this object.
method ORConditionAsUnEscapedString(pORPosition As %Integer) as %String
Return the specified OR condition as a string, with escaping backslashes retained. The returned value reflects what the FHIR request URL included for the specified OR condition.
method ORCount() as %Integer
Return the number of OR conditions on this parameter value.
method SetORConditions() as %Status
Set the %orConditions property of the current SearchQueryParameter instance.
method isCompositeGet() as %Boolean

Inherited Members

Inherited Methods

FeedbackOpens in a new tab