HS.FHIRServer.ServiceAdmin

abstract class HS.FHIRServer.ServiceAdmin

Method Inventory

Methods

classmethod CanDeleteMetadataPackage(packageId As %String) as %Status [ Language = objectscript ]
@API Returns whether a FHIRMeta package can safely be deleted. It performs the following operations:
  1. Checks whether FHIRMeta can safely delete the package (isn't depended upon by another package).
  2. 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) [ Language = objectscript ]
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) [ Language = objectscript ]
classmethod DeleteMetadataPackage(packageId As %String) [ Language = objectscript ]
@API Deletes a FHIRMeta package. It performs the following operations:
  1. Checks whether the package can be safely deleted per FHIRMeta and FHIRServer requirements.
  2. 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) [ Language = objectscript ]
classmethod EndpointExists(cspPath As %String) as %Boolean [ Language = objectscript ]
classmethod GetEndpointList(serviceId As %String = "") as %List [ Language = objectscript ]
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 [ Language = objectscript ]
Return the Service Configuration data for the specified instance id
classmethod GetInstanceForEndpoint(cspPath As %String) as HS.FHIRServer.ServiceInstance [ Language = objectscript ]
classmethod GetInstanceIdForEndpoint(cspPath As %String) as %String [ Language = objectscript ]
classmethod GetInstanceStrategyConfigData(instanceId As %String) as %DynamicObject [ Language = objectscript ]
@API Return the strategy configuration for the specified instance id
classmethod GetServiceIdList(strategyKey As %String = "", repoId As %String = "") as %List [ Language = objectscript ]
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 [ Language = objectscript ]
classmethod IsEndpointEnabled(cspPath As %String) as %Boolean [ Language = objectscript ]
classmethod IsInstanceDecommissioned(instanceId As %String) as %Boolean [ Language = objectscript ]
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 [ Language = objectscript ]
classmethod SetEndpointEnabled(cspPath As %String, isEnabled As %Boolean) [ Language = objectscript ]
classmethod SetInstanceConfigData(instanceId As %String, configData As HS.FHIRServer.API.ConfigData) [ Language = objectscript ]
classmethod SetInstanceEnabled(instanceId As %String, isEnabled As %Boolean) [ Language = objectscript ]
classmethod SetInstanceIdForEndpoint(cspPath As %String, instanceId As %String) [ Language = objectscript ]
classmethod SetInstanceStrategyConfigData(instanceId As %String, configData As %DynamicObject) [ Language = objectscript ]
@API Set the strategy configuration for the specified instance id
classmethod Show() [ Language = objectscript ]
classmethod requireWritePermission() [ Language = objectscript ]
Feedback