HS.BulkFHIR.Service
class HS.BulkFHIR.Service extends HS.BulkFHIR.Util, HS.BulkFHIR.Util.Security
Method Inventory
- Cancel()
- CancelJob()
- Pause()
- ProcessFHIRRequest()
- Resume()
- Status()
- TaskStatus()
- ValidateAndAddParam()
Methods
classmethod Cancel(pSessionId As %String)
@API
Cancels a $export operation that's currently in progress. This operation may not be
resumed after being canceled.
@Throws if the session is already complete & purged or terminated already
classmethod Pause(pSessionId As %String)
@API
Pauses a $export operation that's currently in progress. This operation may be resumed
by calling the Resume method.
@Throws if the session is already complete
classmethod ProcessFHIRRequest(request As HS.FHIRServer.API.Data.Request, ByRef response As HS.FHIRServer.API.Data.Response)
@API
Processes a FHIR interaction request ($export, group search, metadata). In the event the request is an
$export kickoff, will start a background job to process it.
classmethod Resume(sessionId As %String)
@API
Resumes a $export operation that was paused (will spawn background task).
@Throws if the session is already complete or if it's already been resumed, or the job fails to start
classmethod Status(pSessionId As %String, pBaseUrl As %String, Output pStatus As %String, Output pRetryAfter As %Integer, Output pExpires As %TimeStamp, Output pJson As %DynamicObject, Output pHttpStatus As %Integer)
@API
Processes a request for status on an export operation. If the operation is complete, will
show the result. Otherwise, delegates to the fetch adapter for displaying the current status.
@Input pSessionId BFC Session id to fetch status for
@Input pBaseUrl URL to be included in session json output
@Output pStatus a short (<100 char) string to display in the X-Progress header
@Output pRetryAfter how long to wait before polling again.
@Output pExpires when the session expires and available for cleanup
@Output pJson a json object to be returned in the response body. not required per the spec for a progress request
classmethod TaskStatus(pSessionId As %String, Output pRetryAfter As %Integer, Output pHttpStatus As %Integer)
Called by Scheduled task (session) to get the status of the session
classmethod ValidateAndAddParam(pConfig As HS.BulkFHIR.API.Data.Config, pNameAndModifier As %String, pValue, pSupportedParams As %List = "", pQueryParameters As HS.FHIRServer.API.Data.QueryParameters)
Common logic for validating the supported Bulk FHIR input parameters.