|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectau.gov.nehta.vendorlibrary.pcehr.clients.common.type.DocumentMetadata
public final class DocumentMetadata
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 |
---|
public DocumentMetadata()
Method Detail |
---|
public XON getAuthorInstitution()
public void setAuthorInstitution(XON authorInstitution)
authorInstitution
- the identifier of the organisation that authored the documentpublic XCN getAuthorPerson()
public void setAuthorPerson(XCN authorPerson)
authorPerson
- the identifier of the individual that authored the document.public CodedValue getDocumentClass()
public void setDocumentClass(CodedValue documentClass)
documentClass
- the type of document being submitted.public CodedValue getFormatCode()
public void setFormatCode(CodedValue formatCode)
formatCode
- the identifier of the template this document conforms to.public byte[] getDocumentHash()
public void setDocumentHash(byte[] documentHash)
documentHash
- the documentHash to setpublic java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- the title for the given document.public java.lang.String getCreationTime()
public void setCreationTime(java.lang.String creationTime)
creationTime
- the time the document was created.public java.lang.String getServiceStartTime()
public void setServiceStartTime(java.lang.String serviceStartTime)
serviceStartTime
- the datetime that the service being performed, which caused the
document to be created, started.public java.lang.String getServiceStopTime()
public void setServiceStopTime(java.lang.String serviceStopTime)
serviceStopTime
- the datetime that the service being performed, which caused the
document to be created, stopped.public CodedValue getHealthcareFacilityType()
public void setHealthcareFacilityType(CodedValue healthcareFacilityType)
healthcareFacilityType
- the type of healthcare facility where the event relating to this
document submission request initiated.public CodedValue getPracticeSetting()
public void setPracticeSetting(CodedValue practiceSetting)
practiceSetting
- the clinical specialty where the event relating to this document
submission request initiated.public boolean hasKeywords()
public java.util.Set<java.lang.String> getKeywords()
public java.lang.String getLanguageCode()
public void setLanguageCode(java.lang.String languageCode)
public java.lang.String getAuthorSpecialty()
public void setAuthorSpecialty(java.lang.String authorSpecialty)
public CX getPatientId()
public void setPatientId(CX patientId)
public CX getSourcePatientId()
public void setSourcePatientId(CX sourcePatientId)
public java.lang.String getUniqueId()
public void setUniqueId(java.lang.String uniqueId)
public ConfidentialityCodes getConfidentialityCode()
public void setConfidentialityCode(ConfidentialityCodes confidentialityCode)
public java.lang.String getEntryUuid()
public void setEntryUuid(java.lang.String entryUuid)
public java.lang.String getMimeType()
public void setMimeType(java.lang.String mimeType)
public CodedValue getDocumentType()
public void setDocumentType(CodedValue documentType)
public java.lang.String getUri()
public void setUri(java.lang.String uri)
public java.lang.String getRepositoryUniqueId()
public void setRepositoryUniqueId(java.lang.String repositoryUniqueId)
public java.math.BigInteger getDocumentSize()
public void setDocumentSize(java.math.BigInteger documentSize)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |