Package org.ehrbase.client.openehrclient

Interface VersionedCompositionEndpoint

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Optional<com.nedap.archie.rm.ehr.VersionedComposition> find​(UUID versionedObjectUid)
      Retrieves the versioned composition identified by versioned_object_uid.
      List<com.nedap.archie.rm.generic.RevisionHistoryItem> findRevisionHistory​(UUID versionedObjectUid)
      Retrieves the list of revision history items for a given versioned composition.
      <T> Optional<com.nedap.archie.rm.changecontrol.OriginalVersion<T>> findVersionAtTime​(UUID versionedObjectUid, LocalDateTime versionAtTime, Class<T> clazz)
      Retrieves a version for a given versioned composition.
      <T> Optional<com.nedap.archie.rm.changecontrol.OriginalVersion<T>> findVersionById​(UUID versionedObjectUid, VersionUid versionUid, Class<T> clazz)
      Retrieves a version identified by version_uid for a given versioned composition.

    • Method Detail

      • find

        Optional<com.nedap.archie.rm.ehr.VersionedComposition> find​(UUID versionedObjectUid)
        Retrieves the versioned composition identified by versioned_object_uid.
        Parameters:
        versionedObjectUid - identifier of the versioned composition
        Returns:
        the versioned composition, or an empty Optional

      • findRevisionHistory

        List<com.nedap.archie.rm.generic.RevisionHistoryItem> findRevisionHistory​(UUID versionedObjectUid)
        Retrieves the list of revision history items for a given versioned composition.
        Parameters:
        versionedObjectUid - identifier of the versioned composition
        Returns:
        list of revision history items, or an empty List

      • findVersionById

        <T> Optional<com.nedap.archie.rm.changecontrol.OriginalVersion<T>> findVersionById​(UUID versionedObjectUid,
                                                                                   VersionUid versionUid,
                                                                                   Class<T> clazz)
        Retrieves a version identified by version_uid for a given versioned composition.
        Type Parameters:
        T - expected type
        Parameters:
        versionedObjectUid - identifier of the versioned composition
        versionUid - identifier of the version
        clazz - expected class
        Returns:
        the version of the versioned composition, or an empty Optional

      • findVersionAtTime

        <T> Optional<com.nedap.archie.rm.changecontrol.OriginalVersion<T>> findVersionAtTime​(UUID versionedObjectUid,
                                                                                     @Nullable
                                                                                     LocalDateTime versionAtTime,
                                                                                     Class<T> clazz)
        Retrieves a version for a given versioned composition.

        If version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest version.

        Type Parameters:
        T - expected type
        Parameters:
        versionedObjectUid - identifier of the versioned composition
        versionAtTime - given time in the extended ISO 8601 format
        clazz - expected class
        Returns:
        the version of the versioned composition, or an empty Optional