Package org.cqframework.fhir.api.r4

Interface FhirDal

All Superinterfaces:
FhirDal
public interface FhirDal extends FhirDal
This interface is a minimal Fhir CRUD API. It's based on the FHIR HTTP API, but constrained to provide only the operations necessary for the cql-evaluator modules to function.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    create(org.hl7.fhir.r4.model.Resource resource)
    Creates the IBaseResource.
    void
    delete(org.hl7.fhir.instance.model.api.IIdType id)
    Deletes an IBaseResource by id.
    org.hl7.fhir.r4.model.Resource
    read(org.hl7.fhir.instance.model.api.IIdType id)
    Fetches an Resource by id.
    org.hl7.fhir.r4.model.Bundle
    search(String resourceType, Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>> searchParameters)
    Returns an Iterable<IBaseResource> of all the resources of type resourceType.
    void
    update(org.hl7.fhir.r4.model.Resource resource)
    Updates the IBaseResource.

    Methods inherited from interface org.cqframework.fhir.api.FhirDal

    create, update

  • Method Details

    • read

      org.hl7.fhir.r4.model.Resource read(org.hl7.fhir.instance.model.api.IIdType id)
      Fetches an Resource by id. The IIdType must have the resourceType defined. Returns null if no resource is found.
      Specified by:
      read in interface FhirDal
      Parameters:
      id - the id of the resource
      Returns:
      the resource

    • create

      void create(org.hl7.fhir.r4.model.Resource resource)
      Creates the IBaseResource. Default behavior is to overwrite the resource if it already exists.
      Parameters:
      resource - the resource

    • update

      void update(org.hl7.fhir.r4.model.Resource resource)
      Updates the IBaseResource. Default behavior is to create the resource if it does not exist.
      Parameters:
      resource - the resource

    • delete

      void delete(org.hl7.fhir.instance.model.api.IIdType id)
      Deletes an IBaseResource by id. The IIdType must have the resourceType defined. Default behavior is no-op if the resource does not exist.
      Specified by:
      delete in interface FhirDal
      Parameters:
      id - the id of the resource

    • search

      org.hl7.fhir.r4.model.Bundle search(String resourceType, Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>> searchParameters)
      Returns an Iterable<IBaseResource> of all the resources of type resourceType. Default behavior is to return null if no resources are found.
      Specified by:
      search in interface FhirDal
      Parameters:
      resourceType - the type of resources to return.
      Returns:
      the resources