HS.FHIRServer.ServiceAdmin

abstract class HS.FHIRServer.ServiceAdmin

Method Inventory

Methods

classmethod CanDeleteMetadataPackage(packageId As %String) as %Status

@API Returns whether a FHIRMeta package can safely be deleted. It performs the following operations:

Checks whether FHIRMeta can safely delete the package (isn't depended upon by another package).
Checks if the package is in use by any endpoints.

@Input key Unique key for the package. @Returns A %Status of why the package can't be deleted, or $$$OK if it can.

classmethod DecommissionInstance(instanceId As %String)

Decommissions the Service. Any endpoints accessing the specified service are detached from the service. A strategy may delete or preserve data as appropriate for the retention policies it implements. @Param instanceId - The Id of the instance to decommission. Throws if no such instance exists.

classmethod DeleteInstance(instanceId As %String)

classmethod DeleteMetadataPackage(packageId As %String)

@API Deletes a FHIRMeta package. It performs the following operations:

Checks whether the package can be safely deleted per FHIRMeta and FHIRServer requirements.
Calls the FHIRMeta uninstaller.

@Input key Unique key for the package. @Throws %Exception why the package couldn't be uninstalled.

classmethod DetachEndpointFromInstance(cspPath As %String)

classmethod EndpointExists(cspPath As %String) as %Boolean

classmethod GetEndpointList(serviceId As %String = "") as %List

Return a list of all endpoints, or endpoints accessing a specific service @Input serviceId If omitted, return all endpoints, otherwise just the endpoints that provide access to the specified service. @Return a %List of REST endpoint URLs

classmethod GetInstanceConfigData(instanceId As %String) as HS.FHIRServer.API.ConfigData

Return the Service Configuration data for the specified instance id

classmethod GetInstanceCspUrl(instanceId) as %String

@API Returns the cspUrl of the given RepoInstance. @Param instanceId - id of the RepoInstance to get cspUrl.

classmethod GetInstanceDisplayName(instanceId) as %String

@API Returns the Display Name for a given RepoInstance. @Param instanceId - id of the RepoInstance to get the display name for.

classmethod GetInstanceForEndpoint(cspPath As %String) as HS.FHIRServer.ServiceInstance

classmethod GetInstanceIdForEndpoint(cspPath As %String) as %String

classmethod GetInstanceStrategyConfigData(instanceId As %String) as %DynamicObject

@API Return the strategy configuration for the specified instance id

classmethod GetServiceIdList(strategyKey As %String = "", repoId As %String = "") as %List

Return a list of all ServiceInstance Ids. The list may be filtered by strategyKey or repoId. Note that because each repo has a single Strategy, use of both filters is redundant the repoId will be used if both are present.
@Input strategyKey If omitted, return all endpoints, otherwise just the ids that honor the specified Strategy
@Input repoId If present, limit to just the ids that for the specified Repo
@Return a %List of ServiceInstance Ids

classmethod GetStrategyKeyFromClass(pStrategyClass As %String) as %String

classmethod IsEndpointEnabled(cspPath As %String) as %Boolean

classmethod IsInstanceDecommissioned(instanceId As %String) as %Boolean

Returns whether the instance has been decommissioned. @Param instanceId - The Id of the instance to decommission. Throws if no such instance exists

classmethod IsInstanceEnabled(instanceId As %String) as %Boolean

classmethod SetEndpointEnabled(cspPath As %String, isEnabled As %Boolean)

classmethod SetInstanceConfigData(instanceId As %String, configData As HS.FHIRServer.API.ConfigData)

classmethod SetInstanceDisplayName(instanceId, pDisplayName As %String)

@API Set the Display Name for a given RepoInstance. @Param instanceId - id of the RepoInstance to set the display name. @Param pDisplayName - will set the RepoInstance "name" param equal to this value.

classmethod SetInstanceEnabled(instanceId As %String, isEnabled As %Boolean)

classmethod SetInstanceIdForEndpoint(cspPath As %String, instanceId As %String)

classmethod SetInstanceStrategyConfigData(instanceId As %String, configData As %DynamicObject)

@API Set the strategy configuration for the specified instance id

classmethod Show()

classmethod requireWritePermission()