Package org.ehrbase.api.service

Interface ContributionService

public interface ContributionService
Interface for contribution service roughly based on openEHR SM "I_EHR_CONTRIBUTION Interface", see: https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_i_ehr_contribution_interface

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ContributionService.ContributionChangeType
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    adminDelete(UUID ehrId, UUID contributionId)
    Admin method to delete a Contribution from the DB.
    UUID
    commitContribution(UUID ehrId, String content)
    Commit a CONTRIBUTION containing any number of serialized VERSION objects.
    org.ehrbase.openehr.sdk.response.dto.ehrscape.ContributionDto
    getContribution(UUID ehrId, UUID contributionId)
    Return the Contribution with given id in given EHR.

  • Method Details

    • getContribution

      @Nonnull org.ehrbase.openehr.sdk.response.dto.ehrscape.ContributionDto getContribution(UUID ehrId, UUID contributionId)
      Return the Contribution with given id in given EHR.
      Parameters:
      ehrId - ID of EHR
      contributionId - ID of contribution

    • commitContribution

      UUID commitContribution(UUID ehrId, String content)
      Commit a CONTRIBUTION containing any number of serialized VERSION objects.
      Parameters:
      ehrId - ID of EHR
      content - serialized content, containing version objects and audit object in given format
      Returns:
      ID of successfully committed contribution
      Throws:
      IllegalArgumentException - when input can't be processed
      InternalServerException - when DB is inconsistent

    • adminDelete

      void adminDelete(UUID ehrId, UUID contributionId)
      Admin method to delete a Contribution from the DB. See EHRbase Admin API specification for details.
      Parameters:
      ehrId -
      contributionId - Contribution to delete