HS.BulkFHIR.Fetch.PureFHIR.Adapter
class HS.BulkFHIR.Fetch.PureFHIR.Adapter extends HS.BulkFHIR.API.FetchAdapter
Method Inventory
- Finish()
- GetApplicableQueryParams()
- GroupSearchParameters()
- OnStart()
- OperationDocumentation()
- Purge()
- Read()
- Search()
- Start()
- SystemExportItem()
Parameters
parameter configClass = HS.BulkFHIR.Fetch.PureFHIR.Config;
parameter supportsGroupExport = 1;
Inherited description: Flag which indicates whether the implementation of this
adapter supports group export. If false, and a configuration
tries using this adapter with that operation requested,
will throw an error
parameter supportsPatientExport = 1;
Inherited description: Flag which indicates whether the implementation of this
adapter supports patient export. If false, and a configuration
tries using this adapter with that operation requested,
will throw an error
parameter supportsSystemExport = 1;
Inherited description: Flag which indicates whether the implementation of this
adapter supports system export. If false, and a configuration
tries using this adapter with that operation requested,
will throw an error
parameter waitForChildJobs = 45;
Number of seconds to wait for child jobs to stop
Methods
classmethod Finish(pSession As HS.BulkFHIR.Session)
Inherited description: Optional - When export finishes any additional steps the fetch adapter may need to complete
classmethod GetApplicableQueryParams(pSession As HS.BulkFHIR.Session) as %String
Get query params string for resource requests in patient, group, or system export
e.g. derive resource request query params from initial $export kick-off params
If pSession.request.Parameters is empty, will attempt to re-construct it from original request.
classmethod GroupSearchParameters(pConfig As HS.BulkFHIR.API.Data.Config) as %DynamicArray
Return an array of the FHIR Group search parameters that are supported by the resource server.
classmethod OnStart(pSession As HS.BulkFHIR.Session, pRestart As %Boolean)
Optional - When export is starting any additional steps storage may need to complete
@Input pSession session object being started
pRestart will be 0 on first start or 1 during resume
classmethod OperationDocumentation() as %String
Inherited description: (Optional overrideable)
Returns a string in markdown syntax which will be displayed next to all supported operations
in the CapabilityStatement.
classmethod Purge(pSession As HS.BulkFHIR.Session)
Inherited description: Optional - purge any existing storage for pSession.%Id(), which is called when a session expires,
and from a session cancellation
classmethod Read(pConfig As HS.BulkFHIR.API.Data.Config, request As HS.FHIRServer.API.Data.Request, ByRef response As HS.FHIRServer.API.Data.Response)
Inherited description: Executes a FHIR read request (currently only Group resources). This overrideable is expected
to be able to process a FHIR read request against the underlying clinical data store,
and return a resource, if one exists
@Input pConfig BulkFHIR configuration object
@Input request FHIR request object representing a read
@Output response FHIR response object containing the results of the read
classmethod Search(pConfig As HS.BulkFHIR.API.Data.Config, request As HS.FHIRServer.API.Data.Request, ByRef response As HS.FHIRServer.API.Data.Response)
Inherited description: Executes a FHIR search request (currently only Group resources). This overrideable is expected
to be able to process a FHIR search request against the underlying clinical data store,
and return a searchset Bundle of all matching resources.
@Input pConfig BulkFHIR configuration object
@Input request FHIR request object representing a search
@Output response FHIR response object containing the results of the search
classmethod Start(pRequest As HS.FHIRServer.API.Data.Request, pSession As HS.BulkFHIR.Session) as %Boolean
Inherited description: Starts or resumes a $export operation. This overrrideable is expected to fetch resources
out of a clinical data repository in accordance with the provided $export operation, and
add resources to a result set as FHIR using APIs in HS.BulkFHIR.ExportManager. The
implementation of this method should be able to handle receiving pause/cancel signals
from another process, and quiesce as soon as possible.
@Input pRequest FHIR request object representing an export operation to be started
@Input pSession HS.BulkFHIR.Session for the export operation
@Returns a boolean flag indicating whether the operation was completed. This should only
be used to indicate whether the job was paused/cancelled. Any other reason to
stop processing should be thrown as a fatal error.
@Throws any *fatal* error which prevents processing of the export operation. Non-fatal
errors should be included in the result set using the API in HS.BulkFHIR.ExportManager
classmethod SystemExportItem(pSession As HS.BulkFHIR.Session, pResource As %DynamicObject, pQueryPath As %String, pLinkPatientRequired As %Boolean, pMetaAPI As HS.FHIRMeta.API)
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- Cancel()
- GetSourceSystem()
- GetSourceSystemGUID()
- GetSupportedParams()
- Initialize()
- SaveCapabilityStatement()
- Status()
- UpdateExportTypes()