Package org.cqframework.fhir.api.r4

Interface FhirArtifactRepository<T extends org.hl7.fhir.r4.model.Resource>

All Superinterfaces:
FhirService, FhirService
All Known Subinterfaces:
FhirPublishableArtifactRepository<T>
public interface FhirArtifactRepository<T extends org.hl7.fhir.r4.model.Resource> extends FhirService
This interface supports basic shareable artifact repository interactions, as defined by the ShareableArtifact capability statement (https://build.fhir.org/ig/HL7/cqf-measures/CapabilityStatement-shareable-measure-repository.html)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hl7.fhir.r4.model.Bundle
    byCanonical(String url)
    Returns the set of resources matching the given canonical URL
    <T extends org.hl7.fhir.r4.model.Resource>
    T
    byCanonicalAndVersion(String url, String version)
    Returns the unique resource matching the given canonical and version.
    <T extends org.hl7.fhir.r4.model.Resource>
    T
    byCanonicalWithVersion(String urlWithVersion)
    Returns the unique resource matching the given canonical and version.
    <T extends org.hl7.fhir.r4.model.Resource>
    T
    currentByCanonical(String url)
    Returns the "current" version of the given canonical, using the versioning semantics defined by the repository.
    <T extends org.hl7.fhir.r4.model.Resource>
    T
    currentByCanonical(String url, boolean includeDraft)
    Returns the "current" version of the given canonical, including resources in draft status, using the versioning semantics defined by the repository.

  • Method Details

    • byCanonical

      org.hl7.fhir.r4.model.Bundle byCanonical(String url)
      Returns the set of resources matching the given canonical URL
      Parameters:
      url -
      Returns:

    • byCanonicalWithVersion

      <T extends org.hl7.fhir.r4.model.Resource> T byCanonicalWithVersion(String urlWithVersion)
      Returns the unique resource matching the given canonical and version. If more than one resource matches the given canonical and version, an error is thrown.
      Type Parameters:
      T -
      Parameters:
      urlWithVersion -
      Returns:

    • byCanonicalAndVersion

      <T extends org.hl7.fhir.r4.model.Resource> T byCanonicalAndVersion(String url, String version)
      Returns the unique resource matching the given canonical and version. If more than one resource matches the given canonical and version, an error is thrown.
      Type Parameters:
      T -
      Parameters:
      url -
      version -
      Returns:

    • currentByCanonical

      <T extends org.hl7.fhir.r4.model.Resource> T currentByCanonical(String url)
      Returns the "current" version of the given canonical, using the versioning semantics defined by the repository.
      Type Parameters:
      T -
      Parameters:
      url -
      Returns:

    • currentByCanonical

      <T extends org.hl7.fhir.r4.model.Resource> T currentByCanonical(String url, boolean includeDraft)
      Returns the "current" version of the given canonical, including resources in draft status, using the versioning semantics defined by the repository.
      Type Parameters:
      T -
      Parameters:
      url -
      includeDraft -
      Returns: