au.gov.nehta.vendorlibrary.pcehr.clients.common.type
Class DocumentMetadata

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.type.DocumentMetadata

public final class DocumentMetadata
extends java.lang.Object

The DocumentMetadata encapsulates the set of metadata associated with a document.


Constructor Summary
DocumentMetadata()
           
 
Method Summary
 XON getAuthorInstitution()
          Returns the identifier of the organisation that authored the document.
 XCN getAuthorPerson()
          Returns the identifier of the individual that authored the document.
 java.lang.String getAuthorSpecialty()
           
 ConfidentialityCodes getConfidentialityCode()
           
 java.lang.String getCreationTime()
          Returns the time the document was created.
 CodedValue getDocumentClass()
          Returns the type of document being submitted.
 byte[] getDocumentHash()
          Returns the SHA-1 hash of the document.
 java.math.BigInteger getDocumentSize()
           
 CodedValue getDocumentType()
           
 java.lang.String getEntryUuid()
           
 CodedValue getFormatCode()
          Returns the identifier of the template this document conforms to.
 CodedValue getHealthcareFacilityType()
          Returns the type of healthcare facility where the event relating to this document submission request initiated.
 java.util.Set<java.lang.String> getKeywords()
          Get the working set of keywords which are related to the document submission.
 java.lang.String getLanguageCode()
           
 java.lang.String getMimeType()
           
 CX getPatientId()
           
 CodedValue getPracticeSetting()
          Returns clinical specialty where the event relating to this document submission request initiated.
 java.lang.String getRepositoryUniqueId()
           
 java.lang.String getServiceStartTime()
          Returns the datetime that the service being performed, which caused the document to be created, started.
 java.lang.String getServiceStopTime()
          Returns the datetime that the service being performed, which caused the document to be created, stopped.
 CX getSourcePatientId()
           
 java.lang.String getTitle()
          Returns the title for the given document.
 java.lang.String getUniqueId()
           
 java.lang.String getUri()
           
 boolean hasKeywords()
          Are there any keywords related to the document?
 void setAuthorInstitution(XON authorInstitution)
          Sets the identifier of the organisation that authored the document.
 void setAuthorPerson(XCN authorPerson)
          Sets the identifier of the individual that authored the document.
 void setAuthorSpecialty(java.lang.String authorSpecialty)
           
 void setConfidentialityCode(ConfidentialityCodes confidentialityCode)
           
 void setCreationTime(java.lang.String creationTime)
          Sets the time the document was created.
 void setDocumentClass(CodedValue documentClass)
          Sets the type of document being submitted.
 void setDocumentHash(byte[] documentHash)
          Sets the SHA-1 hash of the document.
 void setDocumentSize(java.math.BigInteger documentSize)
           
 void setDocumentType(CodedValue documentType)
           
 void setEntryUuid(java.lang.String entryUuid)
           
 void setFormatCode(CodedValue formatCode)
          Sets the identifier of the template this document conforms to.
 void setHealthcareFacilityType(CodedValue healthcareFacilityType)
          Sets the type of healthcare facility where the event relating to this document submission request initiated.
 void setLanguageCode(java.lang.String languageCode)
           
 void setMimeType(java.lang.String mimeType)
           
 void setPatientId(CX patientId)
           
 void setPracticeSetting(CodedValue practiceSetting)
          Sets the clinical specialty where the event relating to this document submission request initiated.
 void setRepositoryUniqueId(java.lang.String repositoryUniqueId)
           
 void setServiceStartTime(java.lang.String serviceStartTime)
          Sets the datetime that the service being performed, which caused the document to be created, started.
 void setServiceStopTime(java.lang.String serviceStopTime)
          Sets the datetime that the service being performed, which caused the document to be created, stopped.
 void setSourcePatientId(CX sourcePatientId)
           
 void setTitle(java.lang.String title)
          Sets the title for the given document.
 void setUniqueId(java.lang.String uniqueId)
           
 void setUri(java.lang.String uri)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentMetadata

public DocumentMetadata()
Method Detail

getAuthorInstitution

public XON getAuthorInstitution()
Returns the identifier of the organisation that authored the document.

Returns:
the identifier of the organisation that authored the document

setAuthorInstitution

public void setAuthorInstitution(XON authorInstitution)
Sets the identifier of the organisation that authored the document.

Parameters:
authorInstitution - the identifier of the organisation that authored the document

getAuthorPerson

public XCN getAuthorPerson()
Returns the identifier of the individual that authored the document.

Returns:
the identifier of the individual that authored the document.

setAuthorPerson

public void setAuthorPerson(XCN authorPerson)
Sets the identifier of the individual that authored the document.

Parameters:
authorPerson - the identifier of the individual that authored the document.

getDocumentClass

public CodedValue getDocumentClass()
Returns the type of document being submitted.

Returns:
the the type of document being submitted.

setDocumentClass

public void setDocumentClass(CodedValue documentClass)
Sets the type of document being submitted.

Parameters:
documentClass - the type of document being submitted.

getFormatCode

public CodedValue getFormatCode()
Returns the identifier of the template this document conforms to.

Returns:
the identifier of the template this document conforms to.

setFormatCode

public void setFormatCode(CodedValue formatCode)
Sets the identifier of the template this document conforms to.

Parameters:
formatCode - the identifier of the template this document conforms to.

getDocumentHash

public byte[] getDocumentHash()
Returns the SHA-1 hash of the document.

Returns:
value of documentHash

setDocumentHash

public void setDocumentHash(byte[] documentHash)
Sets the SHA-1 hash of the document.

Parameters:
documentHash - the documentHash to set

getTitle

public java.lang.String getTitle()
Returns the title for the given document.

Returns:
the title for the given document.

setTitle

public void setTitle(java.lang.String title)
Sets the title for the given document.

Parameters:
title - the title for the given document.

getCreationTime

public java.lang.String getCreationTime()
Returns the time the document was created.

Returns:
the time the document was created.

setCreationTime

public void setCreationTime(java.lang.String creationTime)
Sets the time the document was created.

Parameters:
creationTime - the time the document was created.

getServiceStartTime

public java.lang.String getServiceStartTime()
Returns the datetime that the service being performed, which caused the document to be created, started.

Returns:
the datetime that the service being performed, which caused the document to be created, started.

setServiceStartTime

public void setServiceStartTime(java.lang.String serviceStartTime)
Sets the datetime that the service being performed, which caused the document to be created, started.

Parameters:
serviceStartTime - the datetime that the service being performed, which caused the document to be created, started.

getServiceStopTime

public java.lang.String getServiceStopTime()
Returns the datetime that the service being performed, which caused the document to be created, stopped.

Returns:
the datetime that the service being performed, which caused the document to be created, stopped.

setServiceStopTime

public void setServiceStopTime(java.lang.String serviceStopTime)
Sets the datetime that the service being performed, which caused the document to be created, stopped.

The Service Stop Time may be set to the same value as the Service Start Time in order to indicate the datetime of an event.

Parameters:
serviceStopTime - the datetime that the service being performed, which caused the document to be created, stopped.

getHealthcareFacilityType

public CodedValue getHealthcareFacilityType()
Returns the type of healthcare facility where the event relating to this document submission request initiated.

Returns:
the type of healthcare facility where the event relating to this document submission request initiated.

setHealthcareFacilityType

public void setHealthcareFacilityType(CodedValue healthcareFacilityType)
Sets the type of healthcare facility where the event relating to this document submission request initiated.

Parameters:
healthcareFacilityType - the type of healthcare facility where the event relating to this document submission request initiated.

getPracticeSetting

public CodedValue getPracticeSetting()
Returns clinical specialty where the event relating to this document submission request initiated.

Returns:
the clinical specialty where the event relating to this document submission request initiated.

setPracticeSetting

public void setPracticeSetting(CodedValue practiceSetting)
Sets the clinical specialty where the event relating to this document submission request initiated.

Parameters:
practiceSetting - the clinical specialty where the event relating to this document submission request initiated.

hasKeywords

public boolean hasKeywords()
Are there any keywords related to the document?

Returns:
true if there are any keywords related to the document.

getKeywords

public java.util.Set<java.lang.String> getKeywords()
Get the working set of keywords which are related to the document submission.

Returns:
the working set of keywords which are related to the document submission.

getLanguageCode

public java.lang.String getLanguageCode()

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

getAuthorSpecialty

public java.lang.String getAuthorSpecialty()

setAuthorSpecialty

public void setAuthorSpecialty(java.lang.String authorSpecialty)

getPatientId

public CX getPatientId()

setPatientId

public void setPatientId(CX patientId)

getSourcePatientId

public CX getSourcePatientId()

setSourcePatientId

public void setSourcePatientId(CX sourcePatientId)

getUniqueId

public java.lang.String getUniqueId()

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

getConfidentialityCode

public ConfidentialityCodes getConfidentialityCode()

setConfidentialityCode

public void setConfidentialityCode(ConfidentialityCodes confidentialityCode)

getEntryUuid

public java.lang.String getEntryUuid()

setEntryUuid

public void setEntryUuid(java.lang.String entryUuid)

getMimeType

public java.lang.String getMimeType()

setMimeType

public void setMimeType(java.lang.String mimeType)

getDocumentType

public CodedValue getDocumentType()

setDocumentType

public void setDocumentType(CodedValue documentType)

getUri

public java.lang.String getUri()

setUri

public void setUri(java.lang.String uri)

getRepositoryUniqueId

public java.lang.String getRepositoryUniqueId()

setRepositoryUniqueId

public void setRepositoryUniqueId(java.lang.String repositoryUniqueId)

getDocumentSize

public java.math.BigInteger getDocumentSize()

setDocumentSize

public void setDocumentSize(java.math.BigInteger documentSize)