Package org.ehrbase.dao.access.interfaces

Interface I_StatusAccess

  • All Superinterfaces:
    I_VersionedCRUD
    All Known Implementing Classes:
    StatusAccess
    public interface I_StatusAccess
extends I_VersionedCRUD
    Status access layer interface
    the status entry holds data pertaining to an Ehr owner, generally a patient Created by Christian Chevalley on 4/21/2015.

    • Method Detail

      • retrieveInstance

        static I_StatusAccess retrieveInstance​(I_DomainAccess domainAccess,
                                       UUID statusId)
        retrieve a status by given status ID
        Parameters:
        domainAccess - SQL access
        statusId - Id of an status to retrieve
        Returns:
        UUID or null

      • retrieveInstanceByParty

        static I_StatusAccess retrieveInstanceByParty​(I_DomainAccess domainAccess,
                                              UUID partyIdentified)
        retrieve a status by an identified party id
        Parameters:
        domainAccess - SQL access
        partyIdentified - Id of an identified party
        Returns:
        UUID or null

      • retrieveInstanceByEhrId

        static I_StatusAccess retrieveInstanceByEhrId​(I_DomainAccess domainAccess,
                                              UUID ehrId)
        retrieve latest status by given EHR ID
        Parameters:
        domainAccess - SQL access
        ehrId - Id of associated EHR
        Returns:
        UUID or null

      • retrieveInstanceByNamedSubject

        static I_StatusAccess retrieveInstanceByNamedSubject​(I_DomainAccess domainAccess,
                                                     String partyName)
        retrieve a status for a named subject (patient)
        NB. for security reason, most deployment will not provide an explicit subject name, this method is provided for small deployment or test purpose.
        Parameters:
        domainAccess - SQL access
        partyName - a subject name
        Returns:
        UUID or null

      • retrieveInstanceByContribution

        static Map<com.nedap.archie.rm.support.identification.ObjectVersionId,​I_StatusAccess> retrieveInstanceByContribution​(I_DomainAccess domainAccess,
                                                                                                                           UUID contributionId,
                                                                                                                           String node)
        Retrieve a map of status accesses for all statuses referencing a contribution
        Parameters:
        domainAccess - SQL context, knowledge
        contributionId - contribution object uuid
        node - Name of local node, for creation of object version ID
        Returns:
        a map of I_StatusAccess and their version ID, that match the condition
        Throws:
        IllegalArgumentException - on DB inconsistency

      • getId

        UUID getId()

      • setStatusRecord

        void setStatusRecord​(StatusRecord record)

      • getAuditDetailsId

        UUID getAuditDetailsId()

      • setContributionId

        void setContributionId​(UUID contribution)

      • getContributionId

        UUID getContributionId()

      • setAuditAndContributionAuditValues

        void setAuditAndContributionAuditValues​(UUID systemId,
                                        UUID committerId,
                                        String description,
                                        I_ConceptAccess.ContributionChangeType changeType)
        Helper that sets values in Status' direct audit and Status' implicit contribution audit
        Parameters:
        systemId - ID of committing system
        committerId - ID of committer
        description - Optional description
        changeType - Change type of operation

      • getLatestVersionNumber

        static Integer getLatestVersionNumber​(I_DomainAccess domainAccess,
                                      UUID statusId)
        Get latest version number of EHR_STATUS by versioned object UID.
        Parameters:
        domainAccess - access
        statusId - versioned object UID
        Returns:
        version number

      • getEhrStatusVersionFromTimeStamp

        int getEhrStatusVersionFromTimeStamp​(Timestamp time)
        Get a specific version number of the associated EHR_STATUS of this instance by timestamp. General idea behind the algorithm: 'what version was the top version at moment T?'
        Parameters:
        time - Timestamp
        Returns:
        version number

      • getInitialTimeOfVersionedEhrStatus

        Timestamp getInitialTimeOfVersionedEhrStatus()
        Get initial time (or time of oldest record) of the status object of this instance.
        Returns:
        time as Timestamp

      • exists

        static boolean exists​(I_DomainAccess domainAccess,
                      UUID ehrStatusId)
        Checks existence of given EHR_STATUS.
        Parameters:
        domainAccess - domain access
        ehrStatusId - given EHR_STATUS
        Returns:
        True if object with ID exists, false if not

      • getVersionMapOfStatus

        static Map<Integer,​I_StatusAccess> getVersionMapOfStatus​(I_DomainAccess domainAccess,
                                                               UUID statusId)
        Get complete version list, mapped to their version number.
        Parameters:
        domainAccess - Access
        statusId -
        Returns:

      • getStatus

        com.nedap.archie.rm.ehr.EhrStatus getStatus()
        Get current record as EhrStatus representation.
        Returns:
        Current status object

      • setOtherDetails

        void setOtherDetails​(com.nedap.archie.rm.datastructures.ItemStructure otherDetails)

      • getOtherDetails

        com.nedap.archie.rm.datastructures.ItemStructure getOtherDetails()

      • setEhrId

        void setEhrId​(UUID ehrId)

      • getEhrId

        UUID getEhrId()