Skip to main content

HS.IHE.XDSb.Administrator.Operations

class HS.IHE.XDSb.Administrator.Operations extends HS.IHE.XDSb.DocumentSource.Abstract, HS.Util.SOAPClient.Operations, HS.Util.BaseHost

IHE XDSb Document Administrator Actor Used for metadata update and RMD transactions RMD is limited to usage with the ISC XDSb Registry, as it's using the registry to determine what to delete and not calculating itself

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},XDSbRegistryTarget,XDSbConsumerOperations,-SOAPVersion,-SSLConfiguration,-SOAPCredentials,-SendSAMLAssertion,-SAMLCreator,-ServiceName,RegistryResponseTransform:Transforms,MetadataTransform:Transforms;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property DocumentTransform as %String (MAXLEN = 255) [ InitialExpression = "IHE/XDSb/Version1/DocumentToProvideAndRegister.xsl" ];
See %HSHOME%/csp/xslt/IHE/XDSb/Version1/DocumentToProvideAndRegister.xsl for an example
Property methods: DocumentTransformDisplayToLogical(), DocumentTransformGet(), DocumentTransformIsValid(), DocumentTransformLogicalToDisplay(), DocumentTransformLogicalToOdbc(), DocumentTransformNormalize(), DocumentTransformSet()
property MetadataTransform as %String (MAXLEN = 255) [ InitialExpression = "IHE/XDSb/Version1/Message-to-MetadataObject.xsl" ];
Transform to determine errors from repository
Property methods: MetadataTransformDisplayToLogical(), MetadataTransformGet(), MetadataTransformIsValid(), MetadataTransformLogicalToDisplay(), MetadataTransformLogicalToOdbc(), MetadataTransformNormalize(), MetadataTransformSet()
property RegistryResponseTransform as %String (MAXLEN = 255) [ InitialExpression = "IHE/XDSb/Version1/RegisterResponse.xsl" ];
Transform to produce response
Property methods: RegistryResponseTransformDisplayToLogical(), RegistryResponseTransformGet(), RegistryResponseTransformIsValid(), RegistryResponseTransformLogicalToDisplay(), RegistryResponseTransformLogicalToOdbc(), RegistryResponseTransformNormalize(), RegistryResponseTransformSet()
property Transformer as HS.Util.XSLTTransformer;
Property methods: TransformerGet(), TransformerGetSwizzled(), TransformerIsValid(), TransformerNewObject(), TransformerSet()
property XDSbConsumerOperations as Ens.DataType.ConfigName [ InitialExpression = "HS.IHE.XDSb.Consumer.Operations" ];
The XDSb Consumer operation - used for sending query requests (as HealthShare messages versus having the administrator create them
Property methods: XDSbConsumerOperationsDisplayToLogical(), XDSbConsumerOperationsGet(), XDSbConsumerOperationsIsValid(), XDSbConsumerOperationsLogicalToDisplay(), XDSbConsumerOperationsLogicalToOdbc(), XDSbConsumerOperationsNormalize(), XDSbConsumerOperationsParseConfigNameSpec(), XDSbConsumerOperationsSet()
property XDSbRegistryServiceName as %String [ InitialExpression = "XDSb.Registry" ];
The XDS.b Registry actor from the HealthShare Service Registry.
Property methods: XDSbRegistryServiceNameDisplayToLogical(), XDSbRegistryServiceNameGet(), XDSbRegistryServiceNameIsValid(), XDSbRegistryServiceNameLogicalToDisplay(), XDSbRegistryServiceNameLogicalToOdbc(), XDSbRegistryServiceNameNormalize(), XDSbRegistryServiceNameSet()
property XDSbRegistryTarget as Ens.DataType.ConfigName [ InitialExpression = "HS.IHE.XDSb.Registry.Operations" ];
Property methods: XDSbRegistryTargetDisplayToLogical(), XDSbRegistryTargetGet(), XDSbRegistryTargetIsValid(), XDSbRegistryTargetLogicalToDisplay(), XDSbRegistryTargetLogicalToOdbc(), XDSbRegistryTargetNormalize(), XDSbRegistryTargetParseConfigNameSpec(), XDSbRegistryTargetSet()

Methods

method OnInit() as %Status
Inherited description: Ensure that SAMLCreator exists SendSAMLAssertion is not 0
method OnMessage(pRequest As HS.Message.XMLMessage, Output pResponse As HS.Message.XMLMessage) as %Status
If doing any security related signing the request comes and generated (with a security document as a placeholder), the caller then adds the security document and calls the source again, this time it will be audited and sent to the repository
method UpdateDocumentSetRequest(pRequest As HS.Message.IHE.XDSb.UpdateDocumentSetRequest, Output pResponse As HS.Message.XMLMessage) as %Status
method XDSbDeleteDocumentSetRequest(pRequest As HS.Message.IHE.XDSb.DeleteDocumentSetRequest, Output pResponse As HS.Message.IHE.XDSb.DeleteDocumentSetResponse) as %Status
RMD ITI-62 and ITI-86 Accept pRequest as HS.Message.IHE.XDSb.DeleteDocumentSetRequest which will contain a list of ObjectRefs and/or an array of UniqueIdentifiers where the UniqueIdentifiers node is the document id (an array so that the administrator inserts the repository id as the value when sending to the repository) Optionally define customization class by setting CustomProcessor to class name and define either method
Tracing in the methods with HSTRACECALLED, HSTRACECALLEDMIN, HSTRACECALLEDERROR
Overriding the document delete for a particular document can be done by defining the OnPreXDSbDeleteDocumentSetRequest method ClassMethod OnPreXDSbDeleteDocumentSetRequest(pHost As Ens.Host , Output pStopProcessing as %Boolean, pRequest As HS.Message.IHE.XDSb.DeleteDocumentSetRequest,Output pResponse As HS.Message.IHE.XDSb.DeleteDocumentSetResponse) as %Status()
  • if pStopProcessing is true processing this document (returned from the method).
  • Updates can be done to the pDocument object prior to any additional processing
    • ClassMethod OnPostXDSbDeleteDocumentSetRequest(pHost As Ens.Host, pRequest As HS.Message.IHE.XDSb.DeleteDocumentSetRequest,Output pResponse As HS.Message.IHE.XDSb.DeleteDocumentSetResponse) as %Status()

    Inherited Members

    Inherited Properties

    Inherited Methods

    FeedbackOpens in a new tab