Skip to main content

HS.HC.IHE.XDSb.Consumer.Operations

class HS.HC.IHE.XDSb.Consumer.Operations extends HS.Util.SOAPClient.Operations, HS.Util.XSLTTransformer

Property Inventory

Method Inventory

Parameters

parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter SETTINGS = XDSbRegistryServiceName:Basic:selector?Select=1&context={HS.Util.ContextSearch/ServiceNameItems},XDSbRepositoryServiceName:Basic:selector?Select=1&context={HS.Util.ContextSearch/ServiceNameItems},TransformToMetadata,TransformToMessage,MaximumDocumentsToProcess,BPPCEvaluator,TransformToMetadata,TransformRetrieveToMetadata,TransformToMessage,TransformResponseCleanup,TransformRetrieveToXDSb,TransformQueryToXDSb,TransformConsolidateRetrieve,TransformDocumentToSDA,TransformObjectToRetrieveDocumentSetRequest,TransformDocumentSetResponseToDocumentCache,TransformGetDocumentsRequest,TransformObjectToDocumentCache,TransformPatientFetchToFindDocumentsQuery,TransformFindDocumentResultToSDA,-TargetName,-SOAPVersion,-SSLConfiguration,-SOAPCredentials,-ServiceName;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names
parameter TRANSFORMRETRIEVEWITHINLINETORETRIEVERESPONSE = IHE/XDSb/Version1/RetrieveWithInlineToRetrieveResponse.xsl;

Properties

property BPPCEvaluator as Ens.DataType.ConfigName;
Business host for evaluating BPPC
Property methods: BPPCEvaluatorDisplayToLogical(), BPPCEvaluatorGet(), BPPCEvaluatorIsValid(), BPPCEvaluatorLogicalToDisplay(), BPPCEvaluatorLogicalToOdbc(), BPPCEvaluatorNormalize(), BPPCEvaluatorParseConfigNameSpec(), BPPCEvaluatorSet()
property MaximumDocumentsToProcess as %Integer [ InitialExpression = 100 ];
A store error will be thrown at some point, the content is available in the response, just not parsed.
Property methods: MaximumDocumentsToProcessDisplayToLogical(), MaximumDocumentsToProcessGet(), MaximumDocumentsToProcessIsValid(), MaximumDocumentsToProcessLogicalToDisplay(), MaximumDocumentsToProcessNormalize(), MaximumDocumentsToProcessSet()
property TransformConsolidateRetrieve as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/ConsolidateRetrieveResponses.xsl" ];
Property methods: TransformConsolidateRetrieveDisplayToLogical(), TransformConsolidateRetrieveGet(), TransformConsolidateRetrieveIsValid(), TransformConsolidateRetrieveLogicalToDisplay(), TransformConsolidateRetrieveLogicalToOdbc(), TransformConsolidateRetrieveNormalize(), TransformConsolidateRetrieveSet()
property TransformDocumentSetResponseToDocumentCache as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/RetrieveDocumentSetResponse-to-DocumentCache.xsl" ];
Property methods: TransformDocumentSetResponseToDocumentCacheDisplayToLogical(), TransformDocumentSetResponseToDocumentCacheGet(), TransformDocumentSetResponseToDocumentCacheIsValid(), TransformDocumentSetResponseToDocumentCacheLogicalToDisplay(), TransformDocumentSetResponseToDocumentCacheLogicalToOdbc(), TransformDocumentSetResponseToDocumentCacheNormalize(), TransformDocumentSetResponseToDocumentCacheSet()
property TransformDocumentToSDA as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/GetDocumentAsSDA.xsl" ];
Property methods: TransformDocumentToSDADisplayToLogical(), TransformDocumentToSDAGet(), TransformDocumentToSDAIsValid(), TransformDocumentToSDALogicalToDisplay(), TransformDocumentToSDALogicalToOdbc(), TransformDocumentToSDANormalize(), TransformDocumentToSDASet()
property TransformFindDocumentResultToSDA as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/FindDocumentsResult-to-SDA.xsl" ];
Property methods: TransformFindDocumentResultToSDADisplayToLogical(), TransformFindDocumentResultToSDAGet(), TransformFindDocumentResultToSDAIsValid(), TransformFindDocumentResultToSDALogicalToDisplay(), TransformFindDocumentResultToSDALogicalToOdbc(), TransformFindDocumentResultToSDANormalize(), TransformFindDocumentResultToSDASet()
property TransformGetDocumentsRequest as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/GetDocumentsRequest.xsl" ];
Property methods: TransformGetDocumentsRequestDisplayToLogical(), TransformGetDocumentsRequestGet(), TransformGetDocumentsRequestIsValid(), TransformGetDocumentsRequestLogicalToDisplay(), TransformGetDocumentsRequestLogicalToOdbc(), TransformGetDocumentsRequestNormalize(), TransformGetDocumentsRequestSet()
property TransformObjectToDocumentCache as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/ExtrinsicObject-to-DocumentCache.xsl" ];
Property methods: TransformObjectToDocumentCacheDisplayToLogical(), TransformObjectToDocumentCacheGet(), TransformObjectToDocumentCacheIsValid(), TransformObjectToDocumentCacheLogicalToDisplay(), TransformObjectToDocumentCacheLogicalToOdbc(), TransformObjectToDocumentCacheNormalize(), TransformObjectToDocumentCacheSet()
property TransformObjectToRetrieveDocumentSetRequest as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/ExtrinsicObject-to-RetrieveDocumentSetRequest.xsl" ];
Property methods: TransformObjectToRetrieveDocumentSetRequestDisplayToLogical(), TransformObjectToRetrieveDocumentSetRequestGet(), TransformObjectToRetrieveDocumentSetRequestIsValid(), TransformObjectToRetrieveDocumentSetRequestLogicalToDisplay(), TransformObjectToRetrieveDocumentSetRequestLogicalToOdbc(), TransformObjectToRetrieveDocumentSetRequestNormalize(), TransformObjectToRetrieveDocumentSetRequestSet()
property TransformPatientFetchToFindDocumentsQuery as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/PatientFetch-to-FindDocumentsQuery.xsl" ];
Property methods: TransformPatientFetchToFindDocumentsQueryDisplayToLogical(), TransformPatientFetchToFindDocumentsQueryGet(), TransformPatientFetchToFindDocumentsQueryIsValid(), TransformPatientFetchToFindDocumentsQueryLogicalToDisplay(), TransformPatientFetchToFindDocumentsQueryLogicalToOdbc(), TransformPatientFetchToFindDocumentsQueryNormalize(), TransformPatientFetchToFindDocumentsQuerySet()
property TransformQueryToXDSb as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/QueryRequestToXDSbQuery.xsl" ];
Property methods: TransformQueryToXDSbDisplayToLogical(), TransformQueryToXDSbGet(), TransformQueryToXDSbIsValid(), TransformQueryToXDSbLogicalToDisplay(), TransformQueryToXDSbLogicalToOdbc(), TransformQueryToXDSbNormalize(), TransformQueryToXDSbSet()
property TransformResponseCleanup as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/QueryResponseCleanup.xsl" ];
Property methods: TransformResponseCleanupDisplayToLogical(), TransformResponseCleanupGet(), TransformResponseCleanupIsValid(), TransformResponseCleanupLogicalToDisplay(), TransformResponseCleanupLogicalToOdbc(), TransformResponseCleanupNormalize(), TransformResponseCleanupSet()
property TransformRetrieveToMetadata as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/RetrieveMessage-to-Metadata.xsl" ];
Property methods: TransformRetrieveToMetadataDisplayToLogical(), TransformRetrieveToMetadataGet(), TransformRetrieveToMetadataIsValid(), TransformRetrieveToMetadataLogicalToDisplay(), TransformRetrieveToMetadataLogicalToOdbc(), TransformRetrieveToMetadataNormalize(), TransformRetrieveToMetadataSet()
property TransformRetrieveToXDSb as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/RetrieveRequestToXDSbRetrieve.xsl" ];
Property methods: TransformRetrieveToXDSbDisplayToLogical(), TransformRetrieveToXDSbGet(), TransformRetrieveToXDSbIsValid(), TransformRetrieveToXDSbLogicalToDisplay(), TransformRetrieveToXDSbLogicalToOdbc(), TransformRetrieveToXDSbNormalize(), TransformRetrieveToXDSbSet()
property TransformToMessage as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/Metadata-to-Message.xsl" ];
The transform that produces XDSb messages from metadata
Property methods: TransformToMessageDisplayToLogical(), TransformToMessageGet(), TransformToMessageIsValid(), TransformToMessageLogicalToDisplay(), TransformToMessageLogicalToOdbc(), TransformToMessageNormalize(), TransformToMessageSet()
property TransformToMetadata as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSb/Version1/Message-to-Metadata.xsl" ];
Property methods: TransformToMetadataDisplayToLogical(), TransformToMetadataGet(), TransformToMetadataIsValid(), TransformToMetadataLogicalToDisplay(), TransformToMetadataLogicalToOdbc(), TransformToMetadataNormalize(), TransformToMetadataSet()
property XDSbRegistryServiceName as %String (MAXLEN = 256);
Document Registry name in service registry
Property methods: XDSbRegistryServiceNameDisplayToLogical(), XDSbRegistryServiceNameGet(), XDSbRegistryServiceNameIsValid(), XDSbRegistryServiceNameLogicalToDisplay(), XDSbRegistryServiceNameLogicalToOdbc(), XDSbRegistryServiceNameNormalize(), XDSbRegistryServiceNameSet()
property XDSbRepositoryServiceName as %String (MAXLEN = 256);
Document Repository name in service registry If this is set, all repository requests are routed to this repository (i.e. the HealthShare BUS) Otherwise, the repository endpoint is determed from the repositoryUniqueId value in the message
Property methods: XDSbRepositoryServiceNameDisplayToLogical(), XDSbRepositoryServiceNameGet(), XDSbRepositoryServiceNameIsValid(), XDSbRepositoryServiceNameLogicalToDisplay(), XDSbRepositoryServiceNameLogicalToOdbc(), XDSbRepositoryServiceNameNormalize(), XDSbRepositoryServiceNameSet()

Methods

method DocumentQuery(pRequest As HS.Message.XMLMessage, pResponse As HS.Message.XMLMessage, pIgnoreSecondaryMPI As %Boolean, pWebRequest As %SOAP.WebRequest = ##class(%SOAP.WebRequest).%New()) as %Status
method DocumentRetrieve(pRequest As HS.Message.XMLMessage, pResponse As HS.Message.XMLMessage, pWebRequest As %SOAP.WebRequest = ##Class(%SOAP.WebRequest).%New()) as %Status
method GetRepositoryTarget(pMessage As HS.Message.XMLMessage, Output pSC As %Status) as %String
classmethod MoveInline(pResponse As HS.Message.XMLMessage) as %Status
check to see if there are inline documents (versus mtom attachments) if so move them to be attachments
method OnMessage(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here
classmethod TraceXMLMessage(pHost As HS.HC.Util.Trace.Helper, pClass As %String, pMethod As %String, pCaption As %String, pVarName As %String, pMessage As HS.Message.XMLMessage)
Dump XMLMessage attachments as character streams rather than binary
method XDSbQueryRequest(pRequest As HS.Message.IHE.XDSb.QueryRequest, Output pResponse As HS.Message.IHE.XDSb.QueryResponse) as %Status
method XDSbRetrieveRequest(pRequest As HS.Message.IHE.XDSb.RetrieveRequest, Output pResponse As HS.Message.XMLMessage) as %Status

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab