Package com.ibm.fhir.server.spi.operation

Interface FHIRResourceHelpers

  • All Known Implementing Classes:
    FHIRRestHelper
    public interface FHIRResourceHelpers
    This interface describes the set of helper methods from the FHIR REST layer that are used by custom operation implementations.

    • Method Detail

      • doCreate

        FHIRRestOperationResponse doCreate​(String type,
                                   Resource resource,
                                   String ifNoneExist,
                                   boolean doValidation)
                            throws Exception
        Performs the heavy lifting associated with a 'create' interaction.
        Parameters:
        type - the resource type specified as part of the request URL
        resource - the Resource to be stored.
        ifNoneExist - whether to create the resource if none exists
        doValidation - if true, validate the resource; if false, assume the resource has already been validated
        Returns:
        a FHIRRestOperationResponse object containing the results of the operation
        Throws:
        Exception

      • doCreate

        default FHIRRestOperationResponse doCreate​(String type,
                                           Resource resource,
                                           String ifNoneExist)
                                    throws Exception
        Performs the heavy lifting associated with a 'create' interaction. Validates the resource.
        Parameters:
        type - the resource type specified as part of the request URL
        resource - the Resource to be stored.
        ifNoneExist - whether to create the resource if none exists
        Returns:
        a FHIRRestOperationResponse object containing the results of the operation
        Throws:
        Exception

      • buildPersistenceEventProperties

        Map<String,​Object> buildPersistenceEventProperties​(String type,
                                                         String id,
                                                         String version,
                                                         FHIRSearchContext searchContext)
                                                  throws FHIRPersistenceException
        Builds a collection of properties that will be passed to the persistence interceptors.
        Parameters:
        type - the resource type
        id - the resource logical ID
        version - the resource version
        searchContext - the request search context
        Returns:
        a map of persistence event properties
        Throws:
        FHIRPersistenceException

      • doUpdate

        default FHIRRestOperationResponse doUpdate​(String type,
                                           String id,
                                           Resource newResource,
                                           String ifMatchValue,
                                           String searchQueryString,
                                           boolean skippableUpdate,
                                           Integer ifNoneMatch)
                                    throws Exception
        Performs an update operation (a new version of the Resource will be stored). Validates the resource.
        Parameters:
        type - the type of the resource to be updated
        id - the id of the Resource being updated
        newResource - the new resource to be stored
        ifMatchValue - an optional "If-Match" header value to request a version-aware update
        searchQueryString - an optional search query string to request a conditional update
        skippableUpdate - if true, and the resource content in the update matches the existing resource on the server, then skip the update; if false, then always attempt the update
        ifNoneMatch - conditional create-on-update
        Returns:
        a FHIRRestOperationResponse that contains the results of the operation
        Throws:
        Exception

      • doUpdate

        FHIRRestOperationResponse doUpdate​(String type,
                                   String id,
                                   Resource newResource,
                                   String ifMatchValue,
                                   String searchQueryString,
                                   boolean skippableUpdate,
                                   boolean doValidation,
                                   Integer ifNoneMatch)
                            throws Exception
        Performs an update operation (a new version of the Resource will be stored).
        Parameters:
        type - the type of the resource to be updated
        id - the id of the Resource being updated
        newResource - the new resource to be stored
        ifMatchValue - an optional "If-Match" header value to request a version-aware update
        searchQueryString - an optional search query string to request a conditional update
        skippableUpdate - if true, and the resource content in the update matches the existing resource on the server, then skip the update; if false, then always attempt the update
        doValidation - if true, validate the resource; if false, assume the resource has already been validated
        ifNoneMatch - conditional create-on-update
        Returns:
        a FHIRRestOperationResponse that contains the results of the operation
        Throws:
        Exception

      • doPatch

        FHIRRestOperationResponse doPatch​(String type,
                                  String id,
                                  FHIRPatch patch,
                                  String ifMatchValue,
                                  String searchQueryString,
                                  boolean skippableUpdate)
                           throws Exception
        Performs a patch operation (a new version of the Resource will be stored).
        Parameters:
        type - the type of the resource to be updated
        id - the id of the Resource being updated
        patch - the patch to apply
        ifMatchValue - an optional "If-Match" header value to request a version-aware update
        searchQueryString - an optional search query string to request a conditional update
        skippableUpdate - if true, and the result of the patch matches the existing resource on the server, then skip the update; if false, then always attempt the update
        Returns:
        a FHIRRestOperationResponse that contains the results of the operation
        Throws:
        Exception

      • doDelete

        FHIRRestOperationResponse doDelete​(String type,
                                   String id,
                                   String searchQueryString)
                            throws Exception
        Performs a 'delete' operation on the specified resource.
        Parameters:
        type - the resource type associated with the Resource to be deleted
        id - the id of the Resource to be deleted
        Returns:
        a FHIRRestOperationResponse that contains the results of the operation
        Throws:
        Exception

      • doRead

        default SingleResourceResult<? extends Resource> doRead​(String type,
                                                        String id,
                                                        boolean throwExcOnNull,
                                                        boolean includeDeleted,
                                                        Resource contextResource)
                                                 throws Exception
        Performs a 'read' operation to retrieve a Resource.
        Parameters:
        type - the resource type associated with the Resource to be retrieved
        id - the id of the Resource to be retrieved
        throwExcOnNull - whether to throw an exception on null
        includeDeleted - allow the read, even if the resource has been deleted
        contextResource - the resource
        queryParameters - for supporting _elements and _summary for resource read
        Returns:
        a SingleResourceResult wrapping the resource and including its deletion status
        Throws:
        Exception

      • doRead

        SingleResourceResult<? extends Resource> doRead​(String type,
                                                String id,
                                                boolean throwExcOnNull,
                                                boolean includeDeleted,
                                                Resource contextResource,
                                                javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters)
                                         throws Exception
        Performs a 'read' operation to retrieve a Resource with select query parameters.
        Parameters:
        type - the resource type associated with the Resource to be retrieved
        id - the id of the Resource to be retrieved
        throwExcOnNull - whether to throw an exception on null
        includeDeleted - allow the read, even if the resource has been deleted
        contextResource - the resource
        queryParameters - for supporting _elements and _summary for resource read
        Returns:
        a SingleResourceResult wrapping the resource and including its deletion status
        Throws:
        Exception

      • doVRead

        default Resource doVRead​(String type,
                         String id,
                         String versionId)
                  throws Exception
        Performs a 'vread' operation by retrieving the specified version of a Resource with no query parameters
        Parameters:
        type - the resource type associated with the Resource to be retrieved
        id - the id of the Resource to be retrieved
        versionId - the version id of the Resource to be retrieved
        Returns:
        the Resource
        Throws:
        Exception

      • doVRead

        Resource doVRead​(String type,
                 String id,
                 String versionId,
                 javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters)
          throws Exception
        Performs a 'vread' operation by retrieving the specified version of a Resource.
        Parameters:
        type - the resource type associated with the Resource to be retrieved
        id - the id of the Resource to be retrieved
        versionId - the version id of the Resource to be retrieved
        queryParameters - for supporting _elements and _summary for resource vread
        Returns:
        the Resource
        Throws:
        Exception

      • doHistory

        Bundle doHistory​(String type,
                 String id,
                 javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters,
                 String requestUri)
          throws Exception
        Performs the work of retrieving versions of a Resource.
        Parameters:
        type - the resource type associated with the Resource to be retrieved
        id - the id of the Resource to be retrieved
        queryParameters - a Map containing the query parameters from the request URL
        requestUri -
        Returns:
        a Bundle containing the history of the specified Resource
        Throws:
        Exception

      • doHistory

        Bundle doHistory​(javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters,
                 String requestUri)
          throws Exception
        Implement the system level history operation to obtain a list of changes to resources
        Parameters:
        queryParameters - a Map containing the query parameters from the request URL
        requestUri - the request URI
        Returns:
        a Bundle containing the history of the specified Resource
        Throws:
        Exception

      • doSearch

        Bundle doSearch​(String type,
                String compartment,
                String compartmentId,
                javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters,
                String requestUri,
                Resource contextResource)
         throws Exception
        Performs heavy lifting associated with a 'search' operation.
        Parameters:
        type - the resource type associated with the search
        compartment - the compartment type to search in, or null if not a compartment search
        compartmentId - the specific compartment to search in, or null if not a compartment search
        queryParameters - a Map containing the query parameters from the request URL
        requestUri - the request URI
        contextResource - the resource context
        Returns:
        a Bundle containing the search result set
        Throws:
        Exception

      • doSearch

        Bundle doSearch​(String type,
                String compartment,
                String compartmentId,
                javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters,
                String requestUri,
                Resource contextResource,
                boolean checkIfInteractionAllowed)
         throws Exception
        Performs heavy lifting associated with a 'search' operation.
        Parameters:
        type - the resource type associated with the search
        compartment - the compartment type to search in, or null if not a compartment search
        compartmentId - the specific compartment to search in, or null if not a compartment search
        queryParameters - a Map containing the query parameters from the request URL
        requestUri - the request URI
        contextResource - the resource context
        checkIfInteractionAllowed - if true, check that the search interaction is permitted
        Returns:
        a Bundle containing the search result set
        Throws:
        Exception

      • doInvoke

        Resource doInvoke​(FHIROperationContext operationContext,
                  String resourceTypeName,
                  String logicalId,
                  String versionId,
                  Resource resource,
                  javax.ws.rs.core.MultivaluedMap<String,​String> queryParameters)
           throws Exception
        Helper method which invokes a custom operation.
        Parameters:
        operationContext - the FHIROperationContext associated with the request
        resourceTypeName - the resource type associated with the request
        logicalId - the resource logical id associated with the request
        versionId - the resource version id associated with the request
        resource - the input resource associated with the custom operation to be invoked
        queryParameters - query parameters may be passed instead of a Parameters resource for certain custom operations invoked via GET
        Returns:
        a Resource that represents the response to the custom operation
        Throws:
        Exception

      • doBundle

        Bundle doBundle​(Bundle bundle,
                boolean skippableUpdates)
         throws Exception
        Processes a bundled request (batch or transaction type).
        Parameters:
        bundle - the request Bundle
        skippableUpdates - if true, and the bundle contains an update for which the resource content in the update matches the existing resource on the server, then skip the update; if false, then always attempt the updates specified in the bundle
        Returns:
        the response Bundle
        Throws:
        Exception

      • doReindex

        int doReindex​(FHIROperationContext operationContext,
              OperationOutcome.Builder operationOutcomeResult,
              Instant tstamp,
              List<Long> indexIds,
              String resourceLogicalId)
       throws Exception
        Invoke the FHIR persistence reindex operation for either a specified list of indexIds, or a randomly chosen resource, last reindexed before the given timestamp.
        Parameters:
        operationContext - the operation context
        operationOutcomeResult - accumulate issues in this OperationOutcome.Builder
        tstamp - only reindex resources with a reindex_tstamp less than this
        indexIds - list of index IDs of resources to reindex, or null
        resourceLogicalId - resourceType (e.g. "Patient"), or resourceType/logicalId a specific resource (e.g. "Patient/abc123"), to reindex, or null; this parameter is ignored if the indexIds parameter value is non-null
        Returns:
        count of the number of resources reindexed by this call
        Throws:
        Exception

      • doRetrieveIndex

        List<Long> doRetrieveIndex​(FHIROperationContext operationContext,
                           String resourceTypeName,
                           int count,
                           Instant notModifiedAfter,
                           Long afterIndexId)
                    throws Exception
        Invoke the FHIR persistence retrieve index operation to retrieve a list of indexIds available for reindexing.
        Parameters:
        operationContext - the operation context
        resourceTypeName - the resource type of index IDs to return, or null
        count - the maximum nuber of index IDs to retrieve
        notModifiedAfter - only retrieve index IDs for resources not last updated after the specified timestamp
        afterIndexId - retrieve index IDs starting after this specified ID, or null to start with first ID
        Returns:
        list of index IDs available for reindexing
        Throws:
        Exception

      • generateResourceId

        String generateResourceId()
        Generate a new resource id. This is typically delegated to the persistence layer, which may want to create FHIR-compliant ids optimized for a certain type of storage.
        Returns:

      • storePayload

        Future<PayloadKey> storePayload​(Resource resource,
                                String logicalId,
                                int newVersionNumber)
                         throws Exception
        If the underlying persistence layer supports offloading payload storage, initiate the request here.
        Parameters:
        resource - the resource to store (with correct Meta fields)
        logicalId - the logical id of the resource
        newVersionNumber - the version number to use
        Returns:
        a Future response to the payload store operation, or null if it is not supported
        Throws:
        Exception