Class ConvenienceCommunicationCh

All Implemented Interfaces:
org.apache.camel.CamelContextAware

@Component public class ConvenienceCommunicationCh extends ConvenienceCommunication
Implementation of ch specific convenience communication
  • Constructor Details

    • ConvenienceCommunicationCh

      public ConvenienceCommunicationCh()
      Default constructor to instanciate the object
    • ConvenienceCommunicationCh

      public ConvenienceCommunicationCh(AffinityDomain affinityDomain)
      Default constructor to instanciate the object
      Parameters:
      affinityDomain - the affinity Domain
    • ConvenienceCommunicationCh

      public ConvenienceCommunicationCh(AffinityDomain affinityDomain, AtnaConfig.AtnaConfigMode atnaConfigMode, DocumentMetadata.DocumentMetadataExtractionMode documentMetadataExtractionMode, SubmissionSetMetadata.SubmissionSetMetadataExtractionMode submissionSetMetadataExtractionMode)
      Instantiates a new convenience communication ch.
      Parameters:
      affinityDomain - the affinity domain
      atnaConfigMode - the atna config mode
      documentMetadataExtractionMode - the document metadata extraction mode
      submissionSetMetadataExtractionMode - the submission set metadata extraction mode
  • Method Details

    • addChDocument

      public DocumentMetadataCh addChDocument(DocumentDescriptor desc, InputStream inputStream)
      Adds a document to the XDS Submission set.
      Parameters:
      desc - the document descriptor (which kind of document do you want to transfer? e.g. PDF, CDA,...)
      inputStream - the input stream to the document
      Returns:
      the document metadata (which have to be completed)
    • addChDocument

      public DocumentMetadataCh addChDocument(DocumentDescriptor desc, InputStream inputStream, InputStream inputStream4Metadata)
      Adds a document to the XDS Submission set.
      Parameters:
      desc - the document descriptor (which kind of document do you want to transfer? e.g. PDF, CDA,...)
      inputStream - the input stream to the document
      inputStream4Metadata - the input stream 4 metadata
      Returns:
      the document metadata (which have to be completed)
    • addChDocument

      public DocumentMetadataCh addChDocument(DocumentDescriptor desc, String filePath) throws IOException
      Adds a document to the XDS Submission set.
      Parameters:
      desc - the document descriptor (which kind of document do you want to transfer? e.g. PDF, CDA,...)
      filePath - the file path
      Returns:
      the document metadata (which have to be completed)
      Throws:
      IOException
    • queryDocumentReferencesOnly

      public org.openehealth.ipf.commons.ihe.xds.core.responses.QueryResponse queryDocumentReferencesOnly(Identificator patientId, SecurityHeaderElement security) throws Exception
      Queries the registry of the affinity domain for all documents of one patient. This is useful if the number of results is limited in the registry and your query would exceed this limit. In this case, precise your query or do a query for references first, choose the possible matches (e.g. the last 10 results) and then query for metadata.
      Parameters:
      patientId - the ID of the patient
      security - a security header element for example an assertion
      Returns:
      the IPF QueryResponse containing references instead of the complete document metadata
      Throws:
      Exception
    • queryDocuments

      public org.openehealth.ipf.commons.ihe.xds.core.responses.QueryResponse queryDocuments(Identificator patientId, SecurityHeaderElement security) throws Exception
      Queries the registry of the affinity domain for all documents of one patient.
      Parameters:
      patientId - the ID of the patient
      security - a security header element for example an assertion
      Returns:
      the IPF Response containing full document metadata
      Throws:
      Exception
    • submit

      public org.openehealth.ipf.commons.ihe.xds.core.responses.Response submit(AuthorRole authorRole, SecurityHeaderElement security) throws Exception
      Submission of the previously prepared document(s) to the repository
      IHE [ITI-41] Provide and Register Document Set – b in the role of the IHE ITI Document Source actor
      Parameters:
      authorRole - The AuthorRole is one of the minimal required information according to IHE Suisse for classification of documents in Switzerland.
      security - a security header element for example an assertion
      Returns:
      the IPF Response
      Throws:
      Exception - if the transfer is not successful