Package de.gematik.bbriccs.rest.fd

Interface FdRequest<T extends org.hl7.fhir.r4.model.Resource,R extends org.hl7.fhir.r4.model.Resource>

All Known Implementing Classes:
FdBaseRequest
public interface FdRequest<T extends org.hl7.fhir.r4.model.Resource,R extends org.hl7.fhir.r4.model.Resource>

  • Method Details

    • getFhirResource

      String getFhirResource()
      This is required (mostly for VAU) to define on which resource the request shall be executed. E.g. [baseUrl]/[resourcePath]
      Returns:
      the FHIR Resource

    • getRequestLocator

      String getRequestLocator()
      This method returns the last (tailing) part of the URL of the inner-HTTP Request e.g. /Task/[id] or /Communication?[queryParameter]
      Returns:
      the tailing part of the URL which combines to full URL like [baseUrl][tailing Part]

    • getMethod

      HttpRequestMethod getMethod()
      Defines which HTTP-Method (for the underlying HTTP Request) shall be used.
      Returns:
      the HTTP-Method of the Command

    • getHeaderParameters

      Map<String,String> getHeaderParameters()
      Get a Map of required Header-Parameters for this specific command. By Default, an empty map is returned, which indicates no Header-Parameters
      Returns:
      map of Header-Parameters

    • getHeaders

      default List<HttpHeader> getHeaders()

    • getRequestBody

      T getRequestBody()
      Get the FHIR-Resource for the Request-Body (of the inner-HTTP)
      Returns:
      aa FHIR-Resource for the Request-Body. If no request body should be provided, an EmptyResource must be provided

    • expectedResponseType

      Class<R> expectedResponseType()