oracle.hsgbu.hdr.hl7.rim

Interface Document

All Superinterfaces:

Act, ContextStructure, InfrastructureRoot, Serializable, Versioned

public interface Document
extends ContextStructure

Specialization of Act to add the characteristics unique to document management services.

See Also:

Act

Summary

Method Summary

Modifier and Type	Method and Description
CE	getCompletionCode() A code depicting the completion status of a report (example, incomplete, authenticated, legally authenticated).
TS	getCopyTime() Time a document is released (i.e., copied or sent to a display device) from a document management system that maintains revision control over the document.
II	getSetId() A report identifier that remains constant across all document revisions that derive from a common original document.
CE	getStorageCode() A code depicting the storage status (example, active, archived, purged) of a report.
INT	getVersionNumber() Version number is an integer starting at '1' and incrementing by 1.
void	setCompletionCode(CE completionCode)
void	setCopyTime(TS copyTime)
void	setSetId(II setId)
void	setStorageCode(CE storageCode)
void	setVersionNumber(INT versionNumber)

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.ContextStructure

getLocalId, setLocalId

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.Act

addConfidentialityCode, addIBActRelationship, addId, addOBActRelationship, addParticipation, addPriorityCode, addReasonCode, getActivityTime, getAvailabilityTime, getClassCode, getCode, getConfidentialityCode, getDerivationExpr, getEffectiveTime, getIBActRelationships, getIBActRelationships, getId, getIndependentInd, getInterruptibleInd, getLanguageCode, getLevelCode, getMoodCode, getNegationInd, getOBActRelationships, getOBActRelationships, getParticipations, getParticipations, getPriorityCode, getReasonCode, getRepeatNumber, getStatusCode, getText, getTitle, getUncertaintyCode, setActivityTime, setAvailabilityTime, setConfidentialityCode, setDerivationExpr, setEffectiveTime, setIndependentInd, setInterruptibleInd, setLanguageCode, setLevelCode, setNegationInd, setPriorityCode, setReasonCode, setRepeatNumber, setStatusCode, setText, setTitle, setUncertaintyCode

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.InfrastructureRoot

getControlAct, getToken, setToken

Methods inherited from interface oracle.hsgbu.hdr.hl7.fwk.Versioned

createNewVersion, getVersionNum, isCurrentVersion

Method Detail

getSetId

II getSetId()

A report identifier that remains constant across all document revisions that derive from a common original document. An original report is the first version of a report. It gets a new unique value for Document.setId, and has the value of Document.versionNumber set to equal "1". An addendum is an appendage to an existing report that contains supplemental information. The appendage is itself an original report. The parent report being appended is referenced via an ActRelationship, with ActRelationship.typeCode set to equal "APND" (for "appends"). The parent report being appended remains in place and its content and status are unaltered. A replacement report replaces an existing report. The replacement report uses the same value for Document.setId as the parent report being replaced, and increments the value of Document.versionNumber by 1. The state of the parent report being replaced should become "superceded" explicitly by another message, but is still retained in the system for historical reference.

setSetId

void setSetId(II setId)
       throws HDRRimException

Throws:

HDRRimException

getVersionNumber

INT getVersionNumber()

Version number is an integer starting at '1' and incrementing by 1. The first instance or original report should always be valued as '1'. The version number value must be incremented by one when a report is replaced, but can also be incremented more often to meet local requirements.

setVersionNumber

void setVersionNumber(INT versionNumber)
               throws HDRRimException

Throws:

HDRRimException

getCompletionCode

CE getCompletionCode()

A code depicting the completion status of a report (example, incomplete, authenticated, legally authenticated).

Membership code to be used:

CL_DOC_COMPLETION_CODE

setCompletionCode

void setCompletionCode(CE completionCode)
                throws HDRRimException

Throws:

HDRRimException

getStorageCode

CE getStorageCode()

A code depicting the storage status (example, active, archived, purged) of a report.

Membership code to be used:

CL_DOC_STORAGE_CODE

setStorageCode

void setStorageCode(CE storageCode)
             throws HDRRimException

Throws:

HDRRimException

getCopyTime

TS getCopyTime()

Time a document is released (i.e., copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, cannot be changed. Intent of this attribute is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

setCopyTime

void setCopyTime(TS copyTime)
          throws HDRRimException

Throws:

HDRRimException