HS.FHIRServer.API.Data.QueryParameters
serial class HS.FHIRServer.API.Data.QueryParameters extends %Library.ListOfObjects
Property Inventory
Method Inventory
- AddParameter()
- AsString()
- CreateFromCSPRequest()
- CreateFromQueryString()
- ExtractSearchParameters()
- FindEntryIndex()
- GetOneParameterValue()
- GetParameterCount()
- GetParameterValue()
- GetParameters()
- RemoveParameter()
- ValidateIncludeParam()
- createRevChainedParam()
Properties
property baseURL as %String;
Base URL of the request
This can be used to determine the full URL of relative references
Property methods: baseURLDisplayToLogical(), baseURLGet(), baseURLIsValid(), baseURLLogicalToDisplay(), baseURLLogicalToOdbc(), baseURLNormalize(), baseURLSet()
property status as %Status [ InitialExpression = 1 ];
Status from converting a query string indicating any invalid parameters.
This can be used to build an OperationOutcome depending on handling
Property methods: statusGet(), statusIsValid(), statusLogicalToOdbc(), statusSet()
Methods
method AddParameter(entry As HS.FHIRServer.API.SearchQueryParameter, setORConditions As %Boolean = 0) as %Status
Return this object instance as a string. URI-encode the value
part of each parameter, if indicated by encodeValue. encodeValues
default is 1 (true) for backward compatibility.
classmethod CreateFromCSPRequest(pRequest As %CSP.Request) as HS.FHIRServer.API.Data.QueryParameters
classmethod CreateFromQueryString(pParametersString As %String, pSchema As HS.FHIRServer.Schema = "", pResourceType As %String = "", pKeepSearchOnly As %Boolean = 0) as HS.FHIRServer.API.Data.QueryParameters
@Param pKeepSearchOnly If true, do not include non-search parameters
method ExtractSearchParameters() as HS.FHIRServer.API.Data.QueryParameters
This method builds QueryParameters object that contains only known search parameters
If there are no FHIR SearchParams named, then it returns null ("")
method FindEntryIndex(entry As HS.FHIRServer.API.SearchQueryParameter) as %Integer
GetParameter returns the value of a specified parameter instance,
plus any parameter modifier. Parameter modifier in FHIR is expressed
as a colon-delimited suffix on the parameter name (not value), for
example family:exact=jones.
An exception is thrown if more than one value is present.
GetParameterCount returns the number of instances of a given parameter.
Each instance may have a modifier or not
method GetParameterValue(pParamName As %String, pPosition As %Integer = 1, Output pModifier As %String) as %String
GetParameter returns the value of a specified parameter instance,
plus any parameter modifier. Parameter modifier in FHIR is expressed
as a colon-delimited suffix on the parameter name (not value), for
example family:exact=jones.
method GetParameters(name As %String, Output params)
method RemoveParameter(entry As HS.FHIRServer.API.SearchQueryParameter)
classmethod ValidateIncludeParam(pResourceType As %String, pSchema As HS.FHIRServer.Schema, pName As %String, pModifier As %String, pValue As %String, ByRef pErrStatus As %Status) as %Boolean
Validate _include and _revinclude search params
Both _include and _revinclude share the same syntax - up to three components, separated by colon characters (:). The details of the syntax are:
[_include|_revinclude]=*: the wildcard literal * (asterisk) is requesting all resources and references supported by the server (will typically only be supported references that are indexed).
[_include|_revinclude]=[resource]:*: where [resource] is the name of the source resource from which the join comes and the wildcard literal * (asterisk) is requesting all supported reference type search parameters for that resource. Note that the list of search parameters supported for _include or _revinclude is not the same as the list of supported search parameters.
[_include|_revinclude]=[resource]:[parameter]: where [resource] is the name of the source resource from which the join comes and [parameter] is the name of a search parameter which must be of type reference.
[_include|_revinclude]=[resource]:[parameter]:[targetType]: where [resource] is the name of the source resource from which the join comes, [parameter] is the name of a search parameter which must be of type reference, and [targetType] is a specific resource type (for when a search parameter refers to references of multiple types).
classmethod createRevChainedParam(nameAndMod As %String, value As %String, pSchema As HS.FHIRServer.Schema, pResourceType As %String, ByRef pErrStatus) as HS.FHIRServer.API.SearchQueryParameter
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SyncObjectIn()
- %SyncTransport()
- %UnSwizzleAt()
- %ValidateObject()
- BuildValueArray()
- Clear()
- Count()
- Find()
- FindObjectId()
- FindOref()
- GetAt()
- GetNext()
- GetObjectAt()
- GetObjectIdAt()
- GetObjectIdNext()
- GetObjectIdPrevious()
- GetObjectNext()
- GetObjectPrevious()
- GetPrevious()
- Insert()
- InsertAt()
- InsertList()
- InsertObject()
- InsertObjectAt()
- InsertObjectId()
- InsertObjectIdAt()
- InsertOrdered()
- LogicalToOdbc()
- Next()
- OdbcToLogical()
- Previous()
- RemoveAt()
- SetAt()
- SetObjectAt()
- SetObjectIdAt()