Home > Class Reference > HSLIB namespace > HS.Message.IHE.XDSb.QueryRequest

HS.Message.IHE.XDSb.QueryRequest

persistent class HS.Message.IHE.XDSb.QueryRequest extends HS.Util.EnsRequest, HS.Types.RequestInfo

SQL Table Name: HS_Message_IHE_XDSb.QueryRequest

Request object which will be used with a transformation to produce a valid query for the XDSb.Registry

Property Inventory

Method Inventory

Parameters

parameter FOUNDATION = 1;
HealthShare Foundation
parameter RESPONSECLASSNAME = HS.Message.XMLMessage;
Default response class

Properties

property HomeCommunity as %String;
Coded entry for HomeCommunityOID
Property methods: HomeCommunityDisplayToLogical(), HomeCommunityGet(), HomeCommunityGetStored(), HomeCommunityIsValid(), HomeCommunityLogicalToDisplay(), HomeCommunityLogicalToOdbc(), HomeCommunityNormalize(), HomeCommunityOIDDisplayToLogical(), HomeCommunityOIDGet(), HomeCommunityOIDGetStored(), HomeCommunityOIDIsValid(), HomeCommunityOIDLogicalToDisplay(), HomeCommunityOIDLogicalToOdbc(), HomeCommunityOIDNormalize(), HomeCommunityOIDSet(), HomeCommunitySet()
property HomeCommunityOID as %String;
The OID value for the Home Community
Property methods: HomeCommunityOIDDisplayToLogical(), HomeCommunityOIDGet(), HomeCommunityOIDGetStored(), HomeCommunityOIDIsValid(), HomeCommunityOIDLogicalToDisplay(), HomeCommunityOIDLogicalToOdbc(), HomeCommunityOIDNormalize(), HomeCommunityOIDSet()
property Parameters as list of HS.Message.IHE.XDSb.QueryItem;
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetStored(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property QueryType as %String (DISPLAYLIST = ",14d4debf-8f97-4251-9a74-a90016b0af0d,3d1bdb10-39a2-11de-89c2-2f44d94eaa9f,f26abbcb-ac74-4422-8a30-edb644bbc1a9,958f3006-baad-4929-a4de-ff1114824431,10b545ea-725c-446d-9b95-8aeb444eddf3,5c4f972b-d56b-40ac-a5fc-c8ca9b40b9d4,5737b14c-8a1a-4539-b659-e03a34a5e1e4,a7ae438b-4bc2-4642-93e9-be891f7bb155,bab9529a-4a10-40b3-a01f-f68a615d247a,51224314-5390-4169-9b91-b1980040715a,e8e3cb2c-e39c-46b9-99e4-c12f57260b83,b909a503-523d-4517-8acf-8e5834dfc4c7,10cae35a-c7f9-4cf5-b61e-fc3278ffb578,d90e5407-b356-4d91-a89f-873917b4b0e6,50d3f5ac-39a2-11de-a1ca-b366239e58df,12941a89-e02e-4be5-967c-ce4bfc8fe492", VALUELIST = ",FindDocuments,FindDocumentsMultiPatients,FindSubmissionSets,FindFolders,GetAll,GetDocuments,GetFolders,GetAssociations,GetDocsAndAssociations,GetSubmissionSets,GetSubSetsAndContents,GetFolderAndContents,GetFoldersForDocument,GetRelatedDocuments,FindFoldersMultiPatients,FindDocumentsByReferenceId", XMLLISTPARAMETER = "DISPLAYLIST") [ InitialExpression = "FindDocuments" ];
Query Type FindDocuments,FindDocumentsMultiPatients,FindSubmissionSets,FindFolders,GetAll,GetDocuments,GetFolders,GetAssociations,GetDocsAndAssociations,GetSubmissionSets,GetSubSetsAndContents,GetFolderAndContents,GetFoldersForDocument,GetRelatedDocuments,FindFoldersMultiPatients,FindDocumentsByReferenceId
Property methods: QueryTypeDisplayToLogical(), QueryTypeGet(), QueryTypeGetStored(), QueryTypeIsValid(), QueryTypeLogicalToDisplay(), QueryTypeLogicalToOdbc(), QueryTypeLogicalToXSD(), QueryTypeNormalize(), QueryTypeSet(), QueryTypeXSDToLogical()
property ReturnType as %String (DISPLAYLIST = ",LeafClass,ObjectRef", VALUELIST = ",LC,OR", XMLLISTPARAMETER = "DISPLAYLIST") [ InitialExpression = "LC" ];
Property methods: ReturnTypeDisplayToLogical(), ReturnTypeGet(), ReturnTypeGetStored(), ReturnTypeIsValid(), ReturnTypeLogicalToDisplay(), ReturnTypeLogicalToOdbc(), ReturnTypeLogicalToXSD(), ReturnTypeNormalize(), ReturnTypeSet(), ReturnTypeXSDToLogical()

Methods

method AddCreationFrom(pParam) as %Status [ Language = objectscript ]
method AddCreationTo(pParam) as %Status [ Language = objectscript ]
method AddDocumentType(pType=1) as %Status [ Language = objectscript ]
pType=1 - Stable, 2 - OnDemand, 3 - both
method AddParam(pParam, pName) as %Status [ Language = objectscript ]
Helper methods used to add value items to the query (where the item is a multi-value parameter
method AddPatientId(pPatientId, pItemName="$XDSDocumentEntryPatientId") as %Status [ Language = objectscript ]
method AddSingleParam(pParam, pName) as %Status [ Language = objectscript ]
Helper methods used to add single value items to the query
method AddStatusValues(pValues, pItemName="$XDSDocumentEntryStatus") as %Status [ Language = objectscript ]
Ability to add status values either one or comma delimited Approved,Deprecated without full name resolution
method QueryByEntryUUID(pEntryUUID) as %Status [ Language = objectscript ]
A method to configure a query by UUID setting the QueryType and inserting the UUID parameter

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (HS.Util.EnsRequest)

^Ens.MessageBodyD(ID,"EnsRequest")
=
HSCoreVersion
HSMinVersion
%ClearFields

Storage Model: Storage (HS.Message.IHE.XDSb.QueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSb.QueryRequest.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSb.QueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSb.QueryRequest.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSb.QueryRequest)

^Ens.MessageBodyD(ID,"QueryRequest")
=
AuthBy
AuthType
BTGReason
QueryType
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
Parameters
RequestingUser
ReturnComposedObjects
ReturnType
MultiPatientQuery
HomeCommunity
SAMLData
HomeCommunityOID

Subclasses

Feedback