Package org.cqframework.fhir.api

Interface FhirDal

All Known Subinterfaces:
FhirDal, FhirDal
public interface 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.instance.model.api.IBaseResource resource)
    Creates the IBaseResource.
    void
    delete(org.hl7.fhir.instance.model.api.IIdType id)
    Deletes an IBaseResource by id.
    org.hl7.fhir.instance.model.api.IBaseResource
    read(org.hl7.fhir.instance.model.api.IIdType id)
    Fetches an IBaseResource by id.
    org.hl7.fhir.instance.model.api.IBaseBundle
    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.instance.model.api.IBaseResource resource)
    Updates the IBaseResource.

  • Method Details

    • read

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

    • create

      void create(org.hl7.fhir.instance.model.api.IBaseResource 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.instance.model.api.IBaseResource 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.
      Parameters:
      id - the id of the resource

    • search

      org.hl7.fhir.instance.model.api.IBaseBundle 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.
      Parameters:
      resourceType - the type of resources to return.
      Returns:
      the resources