HS.Push.WebServicesClient

class HS.Push.WebServicesClient extends %SOAP.WebClient

Method Inventory

• AddEditDeliveryOption()
• AddEditDeliveryPolicy()
• AddEditFilter()
• AddEditMembershipPolicy()
• AddEditPatClinRelationship()
• AddEditPatClinRelationshipByAnalyticsId()
• AddEditPolicyAnalyticsFilter()
• AddEditPolicyDetailFilter()
• AddEditPolicyTopicFilter()
• AddEditReceivingSystem()
• AddEditRelationship()
• AddEditRelationshipPolicy()
• AddEditSearchTerms()
• AddEditSubscriptionPolicy()
• AddEditTransformation()
• AddPatClinRelationship()
• AddRemoveClinSubscription()
• AddSnapshot()
• AddUpdateSubmission()
• CheckCreateCMCRequest()
• CreateCustomFolder()
• DeleteCustomFolder()
• DeleteId()
• DeletePatClinRelationship()
• DeleteSubmission()
• EditSubDeliveryPolicy()
• ExistsIndGroupRelationship()
• FolderDocumentCount()
• GetDocumentInfo()
• GetMessageCount()
• GetPatient()
• GetPrimaryPolicy()
• GetRelationshipID()
• GetRelationshipName()
• GetSnapshot()
• GetSubmission()
• GetSysFolder()
• IdentifyClinician()
• ListAllClinRelationships()
• ListAllClinicianPolicies()
• ListAllPatientRelationships()
• ListAllPendingRelationshipIDs()
• ListAvailablePolicies()
• ListClinRelationships()
• ListDeliveryOptions()
• ListDeliveryPolicies()
• ListDeliveryPoliciesT()
• ListEncounterRelationships()
• ListFilters()
• ListFolderDocumentEventTypes()
• ListFolderDocuments()
• ListFolders()
• ListIndividualPolicies()
• ListInfoSubTypes()
• ListMRNsForClinRelationship()
• ListMembershipPolicies()
• ListPCPRelationships()
• ListPatClinRelationships()
• ListPatRelationships()
• ListPendingRelationships()
• ListPolicyAnalyticsFilters()
• ListPolicyDetailFilters()
• ListPolicyTopicFilters()
• ListPotentialPolicies()
• ListReceivingSystems()
• ListRelationshipPolicies()
• ListRelationships()
• ListSelectedSearchTerms()
• ListSystemPolicies()
• ListTransformations()
• LoadClinSubDelivPolicy()
• LoadClinicianPolicy()
• LoadDeliveryOption()
• LoadFilter()
• LoadMembershipPolicy()
• LoadPatClinRelationship()
• LoadPolicyFilter()
• LoadReceivingSystem()
• LoadRelationship()
• LoadRelationshipPolicy()
• LoadSystemDeliveryPolicy()
• LoadSystemPolicy()
• LoadTransformation()
• LoadUserDeliveryPolicy()
• MovePendingRelationships()
• MoveRelationships()
• MoveToFolder()
• Opt()
• ReadFlag()
• RemovePatClinRelationship()
• RenameCustomFolder()
• UpdateRecentRecipients()

Parameters

parameter LOCATION;

This is the URL used to access the web service.

parameter NAMESPACE = http://www.intersystems.com/hs/hub/push;

This is the namespace used by the Service

parameter OUTPUTTYPEATTRIBUTE = 1;

Use xsi:type attribute for literal types.

parameter SERVICENAME = HS.Hub.Push.WebServices;

This is the name of the Service

Methods

method AddEditDeliveryOption(pOption As HS.Push.WebServices.Containers.DeliveryOption = "") as HS.Push.WebServices.Containers.DeliveryOption [ WebMethod ]

method AddEditDeliveryPolicy(pPolicy As HS.Push.WebServices.Containers.DeliveryPolicy = "") as HS.Push.WebServices.Containers.DeliveryPolicy [ WebMethod ]

method AddEditFilter(pFilter As HS.Push.WebServices.Containers.Filter = "") as HS.Push.WebServices.Containers.Filter [ WebMethod ]

method AddEditMembershipPolicy(pPolicy As HS.Push.WebServices.Containers.SubscriptionPolicy = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method AddEditPatClinRelationship(pMessage As HS.Message.PatClinRelationship) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method AddEditPatClinRelationshipByAnalyticsId(pMessage As HS.Message.AnalyticsPatClinRelationship) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method AddEditPolicyAnalyticsFilter(pPolicyFilter As HS.Push.WebServices.Containers.PolicyFilter = "") as HS.Push.WebServices.Containers.PolicyFilter [ WebMethod ]

method AddEditPolicyDetailFilter(pPolicyFilter As HS.Push.WebServices.Containers.PolicyFilter = "") as HS.Push.WebServices.Containers.PolicyFilter [ WebMethod ]

method AddEditPolicyTopicFilter(pPolicyFilter As HS.Push.WebServices.Containers.PolicyFilter = "") as HS.Push.WebServices.Containers.PolicyFilter [ WebMethod ]

method AddEditReceivingSystem(pSystem As HS.Push.WebServices.Containers.Recipient = "") as HS.Push.WebServices.Containers.Recipient [ WebMethod ]

method AddEditRelationship(pRelation As HS.Push.WebServices.Containers.Relationship = "") as HS.Push.WebServices.Containers.Relationship [ WebMethod ]

method AddEditRelationshipPolicy(pPolicy As HS.Push.WebServices.Containers.RelationshipPolicy = "") as HS.Push.WebServices.Containers.RelationshipPolicy [ WebMethod ]

method AddEditSearchTerms(pSearchTerms As HS.Util.WebServices.ListItems = "") as %Status [ WebMethod ]

method AddEditSubscriptionPolicy(pPolicy As HS.Push.WebServices.Containers.SubscriptionPolicy = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method AddEditTransformation(pTransform As HS.Push.WebServices.Containers.Transformation) as HS.Push.WebServices.Containers.Transformation [ WebMethod ]

method AddPatClinRelationship(pRelationshipId As %String = "", pMPIID As %String = "", pPolicyId As %String = "", pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pRequestingUserRoles As %String = "", pExpirationDate As %Date = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method AddRemoveClinSubscription(pPolicyId As %String = "", pClinicianId As %String = "", pInOrOut As %String) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method AddSnapshot(pSnapshot As HS.Push.WebServices.Containers.Snapshot) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method AddUpdateSubmission(pSubmission As HS.Push.WebServices.Containers.Submission) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method CheckCreateCMCRequest(pRequest As HS.Message.Push.CreateClinicalMessageRequest) as HS.Message.Push.CreateClinicalMessageCheck [ WebMethod ]

method CreateCustomFolder(pClinicianId, pName) as %String [ WebMethod ]

method DeleteCustomFolder(pClinicianId, pFolderId) as %String [ WebMethod ]

method DeleteId(pClass As %String = "", pPolicyId As %String = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

Delete an object instance

method DeletePatClinRelationship(pPatClinRelationshipId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pRequestingUserRoles As %String = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method DeleteSubmission(pSubmission As HS.Push.WebServices.Containers.Submission) as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method EditSubDeliveryPolicy(pSubscriptionId As %String, pClinicianId As %String, pDelivPolicyId As %String) as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method ExistsIndGroupRelationship(pMPIID As %String = "", pAA As %String = "", pMRN As %String = "", pClinicianId As %String = "", pUserName As %String = "", pRelationshipId As %String) as %Boolean [ WebMethod ]

method FolderDocumentCount(pClinicianId As %String, pType As %String, pIncludeRead As %Integer = 0) as %Integer [ WebMethod ]

method GetDocumentInfo(pRegistryId As %String) as HS.Push.MessageCenter.Document [ WebMethod ]

method GetMessageCount(pFolderId As %String, pRecipientId As %String) as %Integer [ WebMethod ]

method GetPatient(pMPIID As %String = "", pRequestingUser As %String = "", pRequestingGateway As %String = "", pSearchMode As %String = "clinician") as HS.Push.WebServices.Containers.Patient [ WebMethod ]

method GetPrimaryPolicy(pRecipientId, pRecipientType) as %String [ WebMethod ]

method GetRelationshipID(pName As %String) as %String [ WebMethod ]

method GetRelationshipName(pID As %String) as %String [ WebMethod ]

method GetSnapshot(pUUID As %String, pSize As %Integer, pHash As %Binary) as HS.Push.WebServices.Containers.Snapshot [ WebMethod ]

method GetSubmission(pSubmission As HS.Push.WebServices.Containers.Submission) as HS.Push.WebServices.Containers.Submission [ WebMethod ]

method GetSysFolder(pClinicianId, pType) as %String [ WebMethod ]

method IdentifyClinician(pRequestingGateway As %String = "", pRequestingUser As %String = "") as %String [ WebMethod ]

method ListAllClinRelationships(pClinicianId As %String = "", pRegistryID As %String = "", pRequestingUser As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListAllClinicianPolicies() as HS.Util.WebServices.ListItems [ WebMethod ]

method ListAllPatientRelationships(pMPIID As %String = "", pIncludePending As %Boolean = 1) as HS.Util.WebServices.ListItems [ WebMethod ]

method ListAllPendingRelationshipIDs() as HS.Util.WebServices.ListItems [ WebMethod ]

method ListAvailablePolicies(pClinicianId As %String) as HS.Util.WebServices.ListItems [ WebMethod ]

method ListClinRelationships(pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListDeliveryOptions(pRegistryId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListDeliveryPolicies(pRegistryId As %String = "", pType As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListDeliveryPoliciesT(pRegistryId As %String = "", pType As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListEncounterRelationships(pEncounterNumber As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListFilters(pType As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListFolderDocumentEventTypes(pFolderId, pClinicianId As %String, pRegDocId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListFolderDocuments(pFolderId As %String, pClinicianId As %String, pRegDocId As %String = "", pageAndFilterInfo As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListFolders(pClinicianId As %String, pSysFoldersOnly=0, pHideVirtualFolders=1) as HS.Util.WebServices.ListItems [ WebMethod ]

method ListIndividualPolicies(pRegistryId As %String = "", pRecipientType As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListInfoSubTypes() as HS.Util.WebServices.ListItems [ WebMethod ]

method ListMRNsForClinRelationship(pRelationshipId As %String = "", pMPIID As %String = "", pClinicianId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListMembershipPolicies(pRegistryId As %String = "", pRecipientType As %String = "", pProgramId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPCPRelationships(pMPIID As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPatClinRelationships(pMPIID As %String = "", pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPatRelationships(pMPIID As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPendingRelationships(pIdentifier As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPolicyAnalyticsFilters(pPolicyId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPolicyDetailFilters(pPolicyId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPolicyTopicFilters(pPolicyId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListPotentialPolicies(pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListReceivingSystems(pActiveOnly As %Boolean = 1, pName As %String = "", pDelivery As %Boolean) as HS.Util.WebServices.ListItems [ WebMethod ]

method ListRelationshipPolicies(pRegistryId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListRelationships() as HS.Util.WebServices.ListItems [ WebMethod ]

method ListSelectedSearchTerms(pPolicyId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListSystemPolicies(pRegistryId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method ListTransformations(pRegistryId As %String = "") as HS.Util.WebServices.ListItems [ WebMethod ]

method LoadClinSubDelivPolicy(pSubscriptionId As %String = "", pClinicianId As %String = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method LoadClinicianPolicy(pPolicyId As %String = "", pRegistryId As %String = "", pRecipientType As %String = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method LoadDeliveryOption(pOptionId As %String = "") as HS.Push.WebServices.Containers.DeliveryOption [ WebMethod ]

method LoadFilter(pFilterId As %String = "") as HS.Push.WebServices.Containers.Filter [ WebMethod ]

method LoadMembershipPolicy(pPolicyId As %String = "", pRegistryId As %String = "", pRecipientType As %String = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method LoadPatClinRelationship(pRelationshipId As %String = "") as HS.Message.PatClinRelationship [ WebMethod ]

method LoadPolicyFilter(pPolicyFilterId As %String = "", pFilterId As %String = "", pFilterType As %String = "") as HS.Push.WebServices.Containers.PolicyFilter [ WebMethod ]

method LoadReceivingSystem(pRecipientId As %String = "") as HS.Push.WebServices.Containers.Recipient [ WebMethod ]

method LoadRelationship(pRelationId As %String = "") as HS.Push.WebServices.Containers.Relationship [ WebMethod ]

method LoadRelationshipPolicy(pPolicyId As %String = "", pRelationshipId As %String = "") as HS.Push.WebServices.Containers.RelationshipPolicy [ WebMethod ]

method LoadSystemDeliveryPolicy(pPolicyId As %String = "", pDefaultPolicy=0) as HS.Push.WebServices.Containers.DeliveryPolicy [ WebMethod ]

method LoadSystemPolicy(pPolicyId As %String = "", pRegistryId As %String = "") as HS.Push.WebServices.Containers.SubscriptionPolicy [ WebMethod ]

method LoadTransformation(pTransformId As %String = "") as HS.Push.WebServices.Containers.Transformation [ WebMethod ]

method LoadUserDeliveryPolicy(pPolicyId As %String = "", pDefaultPolicy=0) as HS.Push.WebServices.Containers.DeliveryPolicy [ WebMethod ]

method MovePendingRelationships(pFromIdent As %String = "", pToClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pRequestingUserRoles As %String = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method MoveRelationships(pFromClinicianId As %String = "", pToClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pRequestingUserRoles As %String = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method MoveToFolder(pRegDocId, pFolderId) as %String [ WebMethod ]

method Opt(pPolicyId As %String, pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pInOrOut As %String) as %Status [ WebMethod ]

method ReadFlag(pRegDocId, pUnRead) as %String [ WebMethod ]

method RemovePatClinRelationship(pRelationshipId As %String = "", pMPIID As %String = "", pClinicianId As %String = "", pRequestingGateway As %String = "", pRequestingUser As %String = "", pRequestingUserRoles As %String = "") as HS.Util.WebServices.ServiceStatus [ WebMethod ]

method RenameCustomFolder(pFolderId, pNewName) as %String [ WebMethod ]

method UpdateRecentRecipients(pRequest As HS.Message.RecentRecipientUpdateRequest) as HS.Util.WebServices.ListItems [ WebMethod ]