Package org.projecthusky.communication.at

Class DocumentMetadataAt

java.lang.Object

org.projecthusky.common.communication.DocumentMetadata

org.projecthusky.communication.at.DocumentMetadataAt

public class DocumentMetadataAt
extends DocumentMetadata

Nested Class Summary

Nested classes/interfaces inherited from class org.projecthusky.common.communication.DocumentMetadata

DocumentMetadata.DocumentMetadataExtractionMode

Constructor Summary

Constructors

Constructor	Description
DocumentMetadataAt()	Instantiates a new document metadata.
DocumentMetadataAt(org.openehealth.ipf.commons.ihe.xds.core.metadata.DocumentEntry documentEntryType, POCDMT000040ClinicalDocument cda, List<Identificator> patientIds)	Instantiates a new document metadata.
DocumentMetadataAt(POCDMT000040ClinicalDocument cda, boolean urnOidNeeded)

Method Summary

Modifier and Type	Method	Description
void	addAuthor(AuthorAt author, boolean orgUrnOidNeeded)	Adds an (optional) author element.
void	addConfidentialityCodeHl7Cdar2(ConfidentialityCode code)	Adds the confidentialityCode code (e.g.
void	addServiceEventCode(org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code)
ClassCode	getClassCodeEnum()	Gets the classCode
List<ConfidentialityCode>	getConfidentialityCodesEnum()	Gets the confidentialityCode list
FormatCode	getFormatCodeEnum()	Gets the formatCode
HealthcareFacilityTypeCode	getHealthcareFacilityTypeCodeEnum()	Gets the healthcareFacilityTypeCode
LanguageCode	getLanguageCodeEnum()	Gets the languageCode
Person	getLegalAuthenticator()
MimeType	getMimeTypeCodeEnum()	Method to get mimetype
Identificator	getParentDocumentId()	Gets the parent document.
org.openehealth.ipf.commons.ihe.xds.core.metadata.AssociationType	getParentDocumentType()	Gets the parent document type.
List<Identificator>	getPatientIdsHl7Cdar2()	Gets all patient ids.
PracticeSettingCode	getPracticeSettingCodeEnum()	Method to get the practice settings code
org.openehealth.ipf.commons.ihe.xds.core.metadata.ReferenceId	getRefrencedIdList()
Code	getServiceEventCode()
ZonedDateTime	getServiceEventStartTime()
ZonedDateTime	getServiceEventStopTime()
Identificator	getSetId()
TypeCode	getTypeCodeEnum()	Gets the practice setting code.
void	removePatientIdsFromPatient()
void	setClassCode(org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code, boolean urnOidNeeded)	Sets the (required, but in principle computable) class code, which defines the class of the document (e.g.
void	setCodedLanguage(LanguageCode codedLanguage)	Sets the (required) coded language (e.g.
void	setComments(String comments)	Sets the comments for the CDA document
void	setLegalAuthenticator(Person legalAuthenticator)
void	setMetadata(DocumentMetadataAt metaData)
void	setMimeType(MimeType mimeType)	Sets the (required) mime type (e.g.
void	setParentDocument(org.openehealth.ipf.commons.ihe.xds.core.metadata.Identifiable id, org.openehealth.ipf.commons.ihe.xds.core.metadata.AssociationType relationship)	Sets the parent document.
void	setRefrencedIdList(Identificator id, String homeCommunityId)
void	setServiceEventCode(List<Code> codes)
void	setServiceEventCode(Code eventCode)
void	setServiceEventStartTime(ZonedDateTime startDate)
void	setServiceEventStopTime(ZonedDateTime stopDate)

Methods inherited from class org.projecthusky.common.communication.DocumentMetadata

addAuthor, addAuthor, addConfidentialityCode, addConfidentialityCode, clear, clearExtracted, equals, equals, getAuthors, getAvailabilityStatus, getCda, getClassCode, getCodedLanguage, getComments, getConfidentialityCodes, getCreationTime, getDocSourceActorOrganizationId, getDocumentDescriptor, getDocumentEntry, getEntryUUID, getFormatCode, getHealthcareFacilityTypeCode, getMetadataLanguage, getMimeType, getPatient, getPatientId, getPracticeSettingCode, getSourcePatientId, getTitle, getTypeCode, getUniqueId, getUri, getXDoc, hashCode, setAvailabilityStatus, setClassCode, setCodedLanguage, setCreationTime, setDestinationPatientId, setDocSourceActorOrganizationId, setDocumentDescriptor, setEntryUUID, setFormatCode, setHealthcareFacilityTypeCode, setMetadata, setMetadataLanguage, setMimeType, setPatient, setPracticeSettingCode, setSourcePatientId, setTitle, setTypeCode, setUniqueId, setUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentMetadataAt

public DocumentMetadataAt()

Instantiates a new document metadata.

DocumentMetadataAt

public DocumentMetadataAt(org.openehealth.ipf.commons.ihe.xds.core.metadata.DocumentEntry documentEntryType,
 POCDMT000040ClinicalDocument cda,
 List<Identificator> patientIds)

Instantiates a new document metadata.

Parameters:

documentEntryType - the document entry type

DocumentMetadataAt

public DocumentMetadataAt(POCDMT000040ClinicalDocument cda,
 boolean urnOidNeeded)

Method Details

addAuthor

public void addAuthor(AuthorAt author,
 boolean orgUrnOidNeeded)

Adds an (optional) author element. All information relevant for the XDS Document Metadata will be extracted from the Convenience API Author.

Parameters:

author - the author

addServiceEventCode

public void addServiceEventCode(org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code)

getClassCodeEnum

public ClassCode getClassCodeEnum()

Gets the classCode

Returns:

Code element with classCode as Enum

getConfidentialityCodesEnum

public List<ConfidentialityCode> getConfidentialityCodesEnum()

Gets the confidentialityCode list

Returns:

the ArrayList with ConfidentialityCodes as Enums

getFormatCodeEnum

public FormatCode getFormatCodeEnum()

Gets the formatCode

Returns:

formatCode as Enum

getHealthcareFacilityTypeCodeEnum

public HealthcareFacilityTypeCode getHealthcareFacilityTypeCodeEnum()

Gets the healthcareFacilityTypeCode

Returns:

healthcareFacilityTypeCode as Enum

getLanguageCodeEnum

public LanguageCode getLanguageCodeEnum()

Gets the languageCode

Returns:

codedLanguage as Enum

getLegalAuthenticator

public Person getLegalAuthenticator()

getMimeTypeCodeEnum

public MimeType getMimeTypeCodeEnum()

Method to get mimetype

Returns:

the mimetype of the document

getPracticeSettingCodeEnum

public PracticeSettingCode getPracticeSettingCodeEnum()

Method to get the practice settings code

Returns:

the pactice settings code

getRefrencedIdList

public org.openehealth.ipf.commons.ihe.xds.core.metadata.ReferenceId getRefrencedIdList()

getServiceEventCode

public Code getServiceEventCode()

getServiceEventStartTime

public ZonedDateTime getServiceEventStartTime()

getServiceEventStopTime

public ZonedDateTime getServiceEventStopTime()

getSetId

public Identificator getSetId()

getTypeCodeEnum

public TypeCode getTypeCodeEnum()

Gets the practice setting code. This is the medical speciality of the practice where the document was produced

Returns:

the practiceSettingCode as Enum

setClassCode

public void setClassCode(org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code,
 boolean urnOidNeeded)

Sets the (required, but in principle computable) class code, which defines the class of the document (e.g. 'DCT01' for "Notes on Consultations")

Parameters:

code - the new class code

setCodedLanguage

public void setCodedLanguage(LanguageCode codedLanguage)

Sets the (required) coded language (e.g. "de-CH"). This code can be extracted from CDA Document automatically.

Parameters:

codedLanguage - the new language code

setComments

public void setComments(String comments)

Sets the comments for the CDA document

Parameters:

comments - comments to add for the document

setMimeType

public void setMimeType(MimeType mimeType)

Sets the (required) mime type (e.g. "text/xml")

Parameters:

mimeType - the new mime type

setParentDocument

public void setParentDocument(org.openehealth.ipf.commons.ihe.xds.core.metadata.Identifiable id,
 org.openehealth.ipf.commons.ihe.xds.core.metadata.AssociationType relationship)

Sets the parent document. All information relevant for the parent document have to be set here.

Parameters:

id - reference to an other document

relationship - type of the relationship of the referenced document

removePatientIdsFromPatient

public void removePatientIdsFromPatient()

setRefrencedIdList

public void setRefrencedIdList(Identificator id,
 String homeCommunityId)

setServiceEventStartTime

public void setServiceEventStartTime(ZonedDateTime startDate)

setServiceEventStopTime

public void setServiceEventStopTime(ZonedDateTime stopDate)

setServiceEventCode

public void setServiceEventCode(List<Code> codes)

setServiceEventCode

public void setServiceEventCode(Code eventCode)

addConfidentialityCodeHl7Cdar2

public void addConfidentialityCodeHl7Cdar2(ConfidentialityCode code)

Adds the confidentialityCode code (e.g. 'N' for 'normal')

Parameters:

code - confidentiality code

getParentDocumentId

public Identificator getParentDocumentId()

Gets the parent document. All information relevant for the parent document have to be set here.

Returns:

parent document.

getParentDocumentType

public org.openehealth.ipf.commons.ihe.xds.core.metadata.AssociationType getParentDocumentType()

Gets the parent document type. All information relevant for the parent document have to be set here.

Returns:

parent document type.

getPatientIdsHl7Cdar2

public List<Identificator> getPatientIdsHl7Cdar2()

Gets all patient ids.

Returns:

patientId as Identificator

setLegalAuthenticator

public void setLegalAuthenticator(Person legalAuthenticator)

setMetadata

public void setMetadata(DocumentMetadataAt metaData)