HS.FHIRServer.Management.REST.v1.impl

If ExposeServerExceptions is true, then details of internal errors will be exposed.

Creates a new FHIRServer endpoint. The endpoint creation can take several minutes, so it will be done async and return a job reference that the client can poll for status.
The method arguments hold values for:
namespace, The IRIS Namespace to perform the operation in.
payloadBody, Request body contents

Add a file to the DataLoader jobId.
The method arguments hold values for:
jobId, DataLoader JobId
file, JSON or NDJSON format file

Cancel or Cleanup a DataLoader Job.
The method arguments hold values for:
jobId, DataLoader JobId
action, If 'action=cancel' flags the DataLoader job to exit gracefully. Cancelling a job may take several seconds for the dataloader job to exit. Poll Job status to confirm Job is not running before using the 'action=cleanup'.

If 'action=cleanup' deletes status info for the job.

If 'action=all' then the dataloader job be flagged to exit and will automatically clean up status info after exiting.

Create a new DataLoader Job. The returned jobId can be used to add files to the Job's directory and then start the job.

Delete, Decommission or Reset an endpoint.
The method arguments hold values for:
serviceId, Server assigned ID for the Endpoint.
namespace, The IRIS Namespace to perform the operation in.
action, Required: can delete, decommission or reset an Endpoint

Deletes FHIR Metadata for the specified Package.
The method arguments hold values for:
id, Package ID ( name@version)
namespace, The IRIS Namespace to perform the operation in.

Returns an array of all DataLoader Jobs and their status information.

Gets an array of all async Jobs for FHIR Endpoints in all Namespaces.
The method arguments hold values for:
clear, Will clean up jobs that have finished (competed or errored). Errored jobs will be cleaned up, but will still be returned for this one invocation.

Returns an array of all Endpoint objects for the namespace.
The method arguments hold values for:
namespace, The IRIS Namespace to perform the operation in.
jobs, Include Jobs associated with the Endpoint(s).
metrics, Include additional Endpoint metrics.

Returns an array of FHIR enabled Namespaces and their Endpoint and EndpointSetup info.
The method arguments hold values for:
endpoints, Include Endpoints info with each Namespace.
jobs, Include Jobs associated with the Endpoint(s).
metrics, Include additional Endpoint metrics.
endpoint-setup, Include the EndpointSetup info with each Namespace.

Returns all the info needed to display our FHIR Server Management UI. Instance and Version info plus all the Namespaces.

Returns an Endpoint by serviceId.
The method arguments hold values for:
serviceId, Server assigned ID for the Endpoint.
namespace, The IRIS Namespace to perform the operation in.
jobs, Include Jobs associated with the Endpoint(s).
metrics, Include additional Endpoint metrics.

Returns status of one async Endpoint Job by job_key.
The method arguments hold values for:
jobKey

Gets FHIR Metadata Package info by id.
The method arguments hold values for:
id, Package ID ( name@version)
namespace, The IRIS Namespace to perform the operation in.

Gets an array of all FHIR Metadata Packages installed in a specified Namespace.
The method arguments hold values for:
namespace, The IRIS Namespace to perform the operation in.

Start a DataLoader job by jobId.

The files created for this jobId will be cleaned up at the end of processing.

Any errors outside of a malformed request indicate that a cleanup for this jobId should be called and then start over with a new jobId.
The method arguments hold values for:
jobId, DataLoader JobId
namespace, The IRIS Namespace to perform the operation in.
serviceId, FHIR Server ServiceId. This selects which Endpoint data will be loaded into.

Returns the status of the DataLoader Job.

Status data is persisted in IRISTEMP and will be available for a given jobId until it is cleaned up or the instance is restarted.

The method arguments hold values for:
jobId, DataLoader JobId

Update an existing Endpoint. ServiceId in request URL must match serviceId in request body. When a new package is added this becomes an async request and returns a job object. Otherwise it will synchronously update the endpoint and return the Endpoint object after being updated.
The method arguments hold values for:
serviceId, Server assigned ID for the Endpoint.
namespace, The IRIS Namespace to perform the operation in.
payloadBody, Request body contents

Upload a FHIR Metadata package. Must convert all files into the JSON body
The method arguments hold values for:
namespace, The IRIS Namespace to perform the operation in.
body, Each file in the FHIR Metadata package needs to be converted to an object in the array where the filename is the 'name' and the file contents are the 'data'.