Skip to main content

HS.BulkFHIR.UI.REST.v2

class HS.BulkFHIR.UI.REST.v2 extends HS.BulkFHIR.UI.REST.v1

Method Inventory

Parameters

parameter DOMAIN = HSBFCMsg;
Inherited description: Login page localization domain
parameter configVersion = 1;
denote version of config API should be bumped whenever config API has breaking changes to support json import of older config, etc.

Methods

classmethod AutoConfigureOAuthClient() as %DynamicObject
REST API handler method for auto-configuring a new oauth client. @Input: Expects %request.Content to adhere to this schema: name: string; the name of the client, must be unique issuer: string; the OAuth server issuer url grant_type: string; the client grant type @Output: dynamic object presentation of HS.HC.Security.ClientAPI.OAuthClient.V1.Client
classmethod CreateCredential() as %DynamicObject
REST API handler method for auto-configuring a new oauth client. @Input: Expects %request.Content to adhere to this schema (JSON projection of HS.HC.Security.ClientAPI.Credential.V1.RequestCredential): SystemName: string; the id of credential, must be unique Username: the username of the credential Password: password of the credential @Output: dynamic object presentation of HS.HC.Security.ClientAPI.Credential.V1.Credential
classmethod GetAdapterProperties(pAdapterName As %String = "", pConfigClass As %String = "") as %Library.DynamicObject
Returns information about properties of a particular configured Bulk FHIR adapters @Input pAdapterName, if provided, will be used to derive name of config class @Input pConfigClass, if provided, will disregard pAdapterName and use that class to evaluate config properties At least one of pAdapterName or pConfigClass must be specified
classmethod GetAdapters(pAdapterClassName) as %Library.DynamicObject
Returns information about configured Bulk FHIR adapters in the current namespace
classmethod GetJSONMetadata() as %Library.DynamicObject
Returns information about current namespace and system version
classmethod GetLocalFHIREndpoints()
Return a list of FHIR Server endpoints specifically in this namespace
classmethod GetOAuthClients() as %DynamicArray
Returns %DynamicArray of %DynamicObjects representations of HS.HC.Security.ClientAPI.OAuthClient.V1.Client
classmethod GetScheduledItems(pResponse As %DynamicObject, pResponseSC As %Status)
classmethod GetSessionData() as %Status
Handler for GET /sessiondata Returns information about current user
classmethod GetSessions() as %Status
Handler for GET /sessions Returns a list of Bulk FHIR sessions in the namespace
classmethod GetSessionsList(pResponse As %DynamicObject, pResponseSC As %Status)
classmethod GetTLSConfigurations() as %DynamicArray
Returns %DynamicArray of %DynamicObjects each a DynamicObject with property "Name" representing a TLS Configuration
classmethod GeturlInfo(pAdapter As %String) as %Status
Return information about resource server endpoint, if the endpoint is invalid, or if there is an error parsing the response, the "error" node will be set, otherwise a response will include an arrays of export types and resources {"export_type":["System","Patient","Group"],"resource":["Account",...]
classmethod PostConfig() as %Status
Handler for POST /configs Creates a new Bulk FHIR configuration
classmethod PostSession() as %Status
Handler for POST /sessions Creates a new Bulk FHIR session
classmethod ScheduledAction(pSessionId, pAction) as %Status
Handler for GET /scheduled/:sessionId/:action Perform specific action for Bulk FHIR scheduled session

Inherited Members

Inherited Methods

FeedbackOpens in a new tab