Class DocumentMetadataAt
java.lang.Object
org.projecthusky.common.communication.DocumentMetadata
org.projecthusky.communication.at.DocumentMetadataAt
-
Nested Class Summary
Nested classes/interfaces inherited from class org.projecthusky.common.communication.DocumentMetadata
DocumentMetadata.DocumentMetadataExtractionMode
-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates 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 TypeMethodDescriptionvoid
Adds an (optional) author element.void
Adds the confidentialityCode code (e.g.void
addServiceEventCode
(org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code) Gets the classCodeGets the confidentialityCode listGets the formatCodeGets the healthcareFacilityTypeCodeGets the languageCodeMethod to get mimetypeGets the parent document.org.openehealth.ipf.commons.ihe.xds.core.metadata.AssociationType
Gets the parent document type.Gets all patient ids.Method to get the practice settings codeorg.openehealth.ipf.commons.ihe.xds.core.metadata.ReferenceId
getSetId()
Gets the practice setting code.void
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 documentvoid
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
-
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
-
-
Method Details
-
addAuthor
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
Gets the classCode- Returns:
- Code element with classCode as Enum
-
getConfidentialityCodesEnum
Gets the confidentialityCode list- Returns:
- the ArrayList with ConfidentialityCodes as Enums
-
getFormatCodeEnum
Gets the formatCode- Returns:
- formatCode as Enum
-
getHealthcareFacilityTypeCodeEnum
Gets the healthcareFacilityTypeCode- Returns:
- healthcareFacilityTypeCode as Enum
-
getLanguageCodeEnum
Gets the languageCode- Returns:
- codedLanguage as Enum
-
getLegalAuthenticator
-
getMimeTypeCodeEnum
Method to get mimetype- Returns:
- the mimetype of the document
-
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
-
getServiceEventStartTime
-
getServiceEventStopTime
-
getSetId
-
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
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
Sets the comments for the CDA document- Parameters:
comments
- comments to add for the document
-
setMimeType
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 documentrelationship
- type of the relationship of the referenced document
-
removePatientIdsFromPatient
public void removePatientIdsFromPatient() -
setRefrencedIdList
-
setServiceEventStartTime
-
setServiceEventStopTime
-
setServiceEventCode
-
setServiceEventCode
-
addConfidentialityCodeHl7Cdar2
Adds the confidentialityCode code (e.g. 'N' for 'normal')- Parameters:
code
- confidentiality code
-
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
Gets all patient ids.- Returns:
- patientId as Identificator
-
setLegalAuthenticator
-
setMetadata
-