HS.IHE.XCAI.Common

class HS.IHE.XCAI.Common extends %Library.RegisteredObject, HS.HC.Util.Trace.Helper

Property Inventory

Method Inventory

Parameters

parameter IHEVersion = ##class(HS.Registry.Config).GetKeyValue("\General\IHEVersion",1);
parameter SETTINGS = HomeCommunity:Dev,XCAIRetrieveRequestImportTransform:Transform,XCAIRetrieveRequestExportTransform:Transform,XCAIRetrieveResponseImportTransform:Transform,XCAIRetrieveResponseExportTransform:Transform,XCAIRetrieveRequestImportTransform:Transform,XCAIRetrieveRequestExportTransform:Transform,XCAIRetrieveResponseImportTransform:Transform,XCAIRetrieveResponseExportTransform:Transform,XDSIRetrieveRequestImportTransform:Transform,XDSIRetrieveRequestExportTransform:Transform,XDSIRetrieveResponseImportTransform:Transform,XDSIRetrieveResponseExportTransform:Transform;

Properties

property Errors as HS.Types.IHE.Errors;
Property methods: ErrorsGet(), ErrorsGetObject(), ErrorsGetObjectId(), ErrorsGetSwizzled(), ErrorsIsEmpty(), ErrorsIsValid(), ErrorsNewObject(), ErrorsSet(), ErrorsSetObject(), ErrorsSetObjectId(), ErrorsUnSwizzle()
property HomeCommunity as %String;
Temporary storage of the HomeCommunity system setting, By default this uses the configuration registry setting \IHE\HomeCommunity but can be overridden in the dev and debugging section
Property methods: HomeCommunityDisplayToLogical(), HomeCommunityGet(), HomeCommunityIsValid(), HomeCommunityLogicalToDisplay(), HomeCommunityLogicalToOdbc(), HomeCommunityNormalize(), HomeCommunityOIDDisplayToLogical(), HomeCommunityOIDGet(), HomeCommunityOIDIsValid(), HomeCommunityOIDLogicalToDisplay(), HomeCommunityOIDLogicalToOdbc(), HomeCommunityOIDNormalize(), HomeCommunityOIDSet(), HomeCommunitySet()
property HomeCommunityOID as %String (MAXLEN = 64);
Property methods: HomeCommunityOIDDisplayToLogical(), HomeCommunityOIDGet(), HomeCommunityOIDIsValid(), HomeCommunityOIDLogicalToDisplay(), HomeCommunityOIDLogicalToOdbc(), HomeCommunityOIDNormalize(), HomeCommunityOIDSet()
property Transformer as HS.Util.XSLTTransformer;
Property methods: TransformerGet(), TransformerGetSwizzled(), TransformerIsValid(), TransformerNewObject(), TransformerSet()
property XCAIRetrieveRequestExportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XCAI/Version1/RetrieveRequest-Export.xsl" ];
Property methods: XCAIRetrieveRequestExportTransformDisplayToLogical(), XCAIRetrieveRequestExportTransformGet(), XCAIRetrieveRequestExportTransformIsValid(), XCAIRetrieveRequestExportTransformLogicalToDisplay(), XCAIRetrieveRequestExportTransformLogicalToOdbc(), XCAIRetrieveRequestExportTransformNormalize(), XCAIRetrieveRequestExportTransformSet()
property XCAIRetrieveRequestImportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XCAI/Version1/RetrieveRequest-Import.xsl" ];
Property methods: XCAIRetrieveRequestImportTransformDisplayToLogical(), XCAIRetrieveRequestImportTransformGet(), XCAIRetrieveRequestImportTransformIsValid(), XCAIRetrieveRequestImportTransformLogicalToDisplay(), XCAIRetrieveRequestImportTransformLogicalToOdbc(), XCAIRetrieveRequestImportTransformNormalize(), XCAIRetrieveRequestImportTransformSet()
property XCAIRetrieveResponseExportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XCAI/Version1/RetrieveResponse-Export.xsl" ];
Property methods: XCAIRetrieveResponseExportTransformDisplayToLogical(), XCAIRetrieveResponseExportTransformGet(), XCAIRetrieveResponseExportTransformIsValid(), XCAIRetrieveResponseExportTransformLogicalToDisplay(), XCAIRetrieveResponseExportTransformLogicalToOdbc(), XCAIRetrieveResponseExportTransformNormalize(), XCAIRetrieveResponseExportTransformSet()
property XCAIRetrieveResponseImportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XCAI/Version1/RetrieveResponse-Import.xsl" ];
Property methods: XCAIRetrieveResponseImportTransformDisplayToLogical(), XCAIRetrieveResponseImportTransformGet(), XCAIRetrieveResponseImportTransformIsValid(), XCAIRetrieveResponseImportTransformLogicalToDisplay(), XCAIRetrieveResponseImportTransformLogicalToOdbc(), XCAIRetrieveResponseImportTransformNormalize(), XCAIRetrieveResponseImportTransformSet()
property XDSIRetrieveRequestExportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSI/Version1/RetrieveRequest-Export.xsl" ];
Property methods: XDSIRetrieveRequestExportTransformDisplayToLogical(), XDSIRetrieveRequestExportTransformGet(), XDSIRetrieveRequestExportTransformIsValid(), XDSIRetrieveRequestExportTransformLogicalToDisplay(), XDSIRetrieveRequestExportTransformLogicalToOdbc(), XDSIRetrieveRequestExportTransformNormalize(), XDSIRetrieveRequestExportTransformSet()
property XDSIRetrieveRequestImportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSI/Version1/RetrieveRequest-Import.xsl" ];
Property methods: XDSIRetrieveRequestImportTransformDisplayToLogical(), XDSIRetrieveRequestImportTransformGet(), XDSIRetrieveRequestImportTransformIsValid(), XDSIRetrieveRequestImportTransformLogicalToDisplay(), XDSIRetrieveRequestImportTransformLogicalToOdbc(), XDSIRetrieveRequestImportTransformNormalize(), XDSIRetrieveRequestImportTransformSet()
property XDSIRetrieveResponseExportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSI/Version1/RetrieveResponse-Export.xsl" ];
Property methods: XDSIRetrieveResponseExportTransformDisplayToLogical(), XDSIRetrieveResponseExportTransformGet(), XDSIRetrieveResponseExportTransformIsValid(), XDSIRetrieveResponseExportTransformLogicalToDisplay(), XDSIRetrieveResponseExportTransformLogicalToOdbc(), XDSIRetrieveResponseExportTransformNormalize(), XDSIRetrieveResponseExportTransformSet()
property XDSIRetrieveResponseImportTransform as %String (MAXLEN = 250) [ InitialExpression = "IHE/XDSI/Version1/RetrieveResponse-Import.xsl" ];
Property methods: XDSIRetrieveResponseImportTransformDisplayToLogical(), XDSIRetrieveResponseImportTransformGet(), XDSIRetrieveResponseImportTransformIsValid(), XDSIRetrieveResponseImportTransformLogicalToDisplay(), XDSIRetrieveResponseImportTransformLogicalToOdbc(), XDSIRetrieveResponseImportTransformNormalize(), XDSIRetrieveResponseImportTransformSet()

Methods

method BatchRequests(pRequests As %ListOfObjects, pTarget As Ens.DataType.ConfigName, ByRef pBatch) as %Status
Move list of requests into an Ensemble call-structure array
method BatchResponses(ByRef pBatch, Output pResponses As %ListOfObjects) as %Status
Move results from call structure array into a responses list; logs any errors found
method CombineResponses(pResponses As %ListOfObjects, ByRef pResponse As HS.Message.IHE.XDSI.RetrieveResponse, ByRef pExpectedDocuments) as %Status
Validate, normalize and combine all results of the batch
method ConvertMessage(pInput As %XML.Adaptor, pOutput As %XML.Adaptor) as %Status
Convert between XMLMessage and internal message objects using XSLT and XML correlation
method ErrorResponse(pName As %String, pSC As %Status, Output pResponse As HS.Message.XMLMessage) as %Status
Create generic error response for a fatal error
method FinalizeResponse(pResponse As HS.Message.IHE.XDSI.RetrieveResponse)
Ensure the response has errors, documents or both and a valid status
method Initialize() as %Status
Setup state; should be called before processing most requests
method Log(pError As HS.Types.IHE.Error)
method LogError(pCode, pDescription, pLocation=..HomeCommunityOID)
method LogEvents()
method LogStatus(pSC As %Status)
method LogWarning(pCode, pDescription, pLocation=..HomeCommunityOID)
method SplitRequests(pRequest As HS.Message.IHE.XDSI.RetrieveRequest, Output pRequests As %ListOfObjects, Output pDocuments) as %Status
Normalize, validate and split a request by community/repository ##; pDocuments = count, pDocuments(docUniqId) = $LB(homeId,repoId)

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

Feedback