Home > Class Reference > %SYS namespace > %ZHSLIB.HealthShareMgr

%ZHSLIB.HealthShareMgr

class %ZHSLIB.HealthShareMgr extends %Library.EnsembleMgr

Method Inventory (Including Private)

Parameters

parameter HSAALIB = HSAALIB;
parameter HSAALIC = Active Analytics;
parameter HSAAMODULE = HSAA;
parameter HSAANAME = Active Analytics;
parameter HSCMLIB = HSCMLIB;
parameter HSCMLIC = Care Community;
parameter HSCMMODULE = HSCM;
parameter HSCMNAME = Care Community;
parameter HSCOMMLIB = HSCOMMLIB;
parameter HSCOMMLIC = Personal Community;
parameter HSCOMMMODULE = HSPersonalCommunity;
parameter HSCOMMNAME = Community Portal;
parameter HSLIB = HSLIB;
Inherited description: Default HSLIB
parameter HSMODULE = HSBASE;
parameter HSNAME = Core;
parameter HSPDLIB = HSPDLIB;
parameter HSPDLIC = Provider Directory;
parameter HSPDMODULE = HSProviderDirectory;
parameter HSPDNAME = Provider Directory;
parameter HSPILIB = HSPILIB;
parameter HSPILIC = Patient Index;
parameter HSPIMODULE = HSPI;
parameter HSPINAME = Patient Index;
parameter MPRLLIB = MPRLLIB;
This DATABASE NO LONGER EXISTS. Needed only for backwards compatability.
parameter MPRLNAME = Linkage Engine;
This COMPONENT NO LONGER EXISTS. Needed only for backwards compatability.
parameter VIEWERLIB = VIEWERLIB;
Inherited description: where the viewer will get installed
parameter VIEWERLIC = Clinician Viewer;
parameter VIEWERMODULE = HSViewer;
parameter VIEWERNAME = Clinical Viewer;

Methods (Including Private)

classmethod AddDelegated() as %Boolean [ Language = objectscript ]
For HealthShare, this is called to enable system wide delegated authentication. Returns 0 if no changes were made.
classmethod CheckDBInstalled(pDB="") as %Boolean [ Language = objectscript ]
classmethod ComponentUpgrade(pDB="", pPreviousVersion="", pVerbose=0) as %Status [ Language = objectscript ]
classmethod ComponentVersion(pDB As %String = "", Output pVersion As %String = "", pConfigItem As %Persistent = "", pIncludeBuild As %Boolean = 1) as %Status [ Language = objectscript ]
Version of the installed Component version
classmethod ConfigureComponent(pDB="", pNamespace="", pVerbose=0, ByRef pVars) as %Status [ Language = objectscript ]
Add mappings for a Namespace and additional configuration items ##class(%ZHSLIB.HealthShareMgr).ConfigureComponent("HSPILIB","HSREGISTRY",$g(pVerbose),.pVars)
classmethod CopyLocalClass(pClass, pFromNS) as %Status [ Language = objectscript ]
called from Installer.Install subclasses to copy localized classes from the library to HSCUSTOM, if they aren't already there
classmethod DefineLibraryDBs(pVerbose) as %Status [ Language = objectscript ]
Define HSLIB / VIEWERLIB / HSPI/ HSPD / HSAA
classmethod EnableFoundationNamespace(pTargetNS As %String, pVerbose As %Boolean = 0, ByRef pIsPrimary As %Boolean = 1, pFromEnableEnsemble As %Boolean = 0) as %Status [ Language = objectscript ]
Deprecated call, replaced with EnableHealthShareNamespace
classmethod EnableHealthShareNamespace(pTargetNS As %String, pVerbose As %Boolean = 0, ByRef pIsPrimary As %Boolean = 1, pFromEnableEnsemble As %Boolean = 0) as %Status [ Language = objectscript ]
Create Foundation namespace pFromEnableEnsemble is for when this gets called by %Library.EnsembleMgr. In that case, a database has already been created, and we're enabling the namespace for Ensemble
classmethod GetAuthNS() as %String [ Language = objectscript ]
Namespace to use for executing calls to Hub / Registry
classmethod GetCSPAppPath(pApplication="") as %String [ Language = objectscript ]
classmethod GetHealthShareNamespaceIsAllInOnePatientIndex(pNamespace=$namespace) as %Boolean [ Language = objectscript ]
Returns true if the namespace contains an All-In-One Patient Index configuration
classmethod GetHealthShareNamespaceType(pNamespace=$namespace) as %String [ Language = objectscript ]
Returns Hub, EdgeGateway, etc., or null if the namespace is not a HealthShare component namespace
private classmethod GetInstallerClass(ByRef pVars, pProduct As %String = "") as %Dictionary.Classname [ Language = objectscript ]
Helper method to retrieve installer class name from pVars("Component").
classmethod GetSupportedLibraryDatabases() as %Library.DynamicArray [ Language = objectscript ]
Helper method to return the set of *LIB database names that are supported via this code.
classmethod InitializeHealthShare(pVerbose As %Boolean = 0, pHSLib As %String = ..#HSLIB, ByRef pIsPrimary As %Boolean = 1) as %Status [ Language = objectscript ]
Initialize HealthShare
classmethod InstallComponent(pDB="", pVerbose=0, pDev=0) as %Status [ Language = objectscript ]
classmethod InstanceType() as %Integer [ Language = objectscript ]
0 - HealthShare $$$HSisHealthShare 1 - Connect $$$HSisHealthConnect 2 - IRISforHealth $$$HSisIRISforHealth
classmethod IsAuditInstance(Output pAuditDB As %String) as %Boolean [ Language = objectscript ]
This is used as we are configuring audit database connections
classmethod IsFoundationInstalled() as %Boolean [ Language = objectscript ]
Deprecated - should no longer be used
classmethod IsHealthConnectInstance() as %Boolean [ Language = objectscript ]
classmethod IsHealthShareInstalled() as %Boolean [ Language = objectscript ]
Checks for HealthShare installation
classmethod IsHealthShareInstance() as %Boolean [ Language = objectscript ]
classmethod IsHealthShareNamespace(pNamespace=$namespace) as %Boolean [ Language = objectscript ]
Checks if current namespace is HealthShare-enabled Called by %Library.EnsembleMgr
classmethod IsIRISHealthInstance() as %Boolean [ Language = objectscript ]
classmethod IsRunningAuditInstance(Output pAuditDB As %String) as %Boolean [ Language = objectscript ]
This is used at runtime to decide how we are going to audit - locally in the current namespace (for Foundation), locally in the registry namespace for old configurations, locally in the HSAUDIT database if either the registry instance is configured for audit or if we have an AuditRepository configured, or otherwise remotely. A non primary mirror member can't be the audit instance
classmethod LoadLocalizedMessages(pDB, pVerbose) as %Status [ Language = objectscript ]
classmethod MapComponent(pDB="", pNamespace="", pVerbose=0) as %Status [ Language = objectscript ]
Add mappings for a Namespace (to a component) ##class(%ZHSLIB.HealthShareMgr).MapComponent("HSPILIB","HSREGISTRY",$g(pVerbose))
classmethod MapZAUTHENTICATE(pHSLib, pVerbose) as %Status [ Language = objectscript ]
map zauthenticate into HSLIB, but only on new Installs
classmethod MapZHSLIB(pTargetNamespace=$namespace) as %Status [ Language = objectscript ]
classmethod MapZHSLIBForAll() as %Status [ Language = objectscript ]
classmethod OnStartHealthShare(pIsStartup As %Boolean = 0) [ Language = objectscript ]
Will happen on startup as well as when we become primary
classmethod PreInstallSetup() as %Status [ Language = objectscript ]
Called during installation %Library.EnsembleMgr (Install)
classmethod RemoveENSDEMO() [ Language = objectscript ]
classmethod RemoveMPRLLIB() as %Status [ Language = objectscript ]
Upgrades for HealthConnect / IRIS for Health
classmethod ReportPackageHash(pStream As %Stream.GlobalCharacter = $$$NULLOREF, pPackage As %String = "HS") as %Status [ Language = objectscript ]
Report class hash information and summarize with a SHA1 hash
classmethod ResetComponent(pDB="", pNamespace="", pVerbose=0) as %Status [ Language = objectscript ]
Method called when user is trying to clear out patient data, but leave configuration information
private classmethod SecureCheckDBInstalled(pDB="") as %Boolean [ Language = objectscript ]
private classmethod SecureComponentVersion(pDB As %String = "", Output pVersion As %String = "", pConfigItem As %Persistent = "", pIncludeBuild As %Boolean = 1) as %Status [ Language = objectscript ]
private classmethod SecureIsHealthShareNamespace(pNamespace=$namespace) as %Boolean [ Language = objectscript ]
classmethod TypeFoundationNamespaces() as %Status [ Language = objectscript ]
classmethod UnInstallComponent(pDB="", pVerbose=0) as %Status [ Language = objectscript ]
classmethod UnconfigureComponent(pDB="", pNamespace="", pVerbose=0, pPurgeFiles=0, ByRef pVars) as %Status [ Language = objectscript ]
Remove mappings for a Namespace (to a component) ##class(%ZHSLIB.HealthShareMgr).UnconfigureComponent("HSPILIB","HSREGISTRY",$g(pVerbose))
classmethod UpdateComponentsVersion() [ Language = objectscript ]
for HealthConnect and IRISforHealth update the Version information
classmethod UpdateDelegatedApps() as %Status [ Language = objectscript ]
For HealthShare, this is called to enable system wide delegated authentication and for all CSP apps
classmethod UpdateEnsembleCSPApplicationForNamespace(pNamespace As %String) as %Boolean [ Language = objectscript ]
Helper method to update the CSP application under /csp/ that may be created automatically for some Ensemble-enabled namespaces. The method returns a boolean to indicate whether an update was performed. This method throws exceptions.
classmethod UpdateXSLTFiles() [ Language = objectscript ]
classmethod UpgradeFoundationNS() as %Status [ Language = objectscript ]
Upgrade Foundation type namespaces
classmethod ValidateComponent(pDB="", pVerbose=0) as %Status [ Language = objectscript ]
classmethod VersionInfo(pMultiLine=0) as %String [ Language = objectscript ]
Return the version information for the core technology and all components installed pMultiLine = 1 is used/parsed by %SYSTEM.Version, so we can't change its format
classmethod createCSPApp(pIsUserPortal As %Boolean = 1, pPortal As %String, pNS As %String, pPortalDir As %String, pDescription As %String, pGrant As %String = "", pCookiePath As %String = "", pSuperclass As %String = "", pSessionEventsClass As %String = "") as %Status [ Language = objectscript ]
Create a new HealthShare management portal CSP app for users, or a CSP app for web services If not pIsUserPortal, that's for web services This won't update an existing app pPortal dir must start with $system.Util.InstallDirectory() (case insensitive) Deprecated - use the createCSPAppNew method instead
classmethod createCSPAppNew(pIsUserPortal As %Boolean = 1, pPortal As %String, pNS As %String, pPortalDir As %String, pDescription As %String, pGrant As %String = "", pCookiePath As %String = "", pSuperclass As %String = "", pSessionEventsClass As %String = "") as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)