org.eclipse.ohf.bridge.xds
Interface XdsBridge

All Known Implementing Classes:

AbstractXdsBridge

public interface XdsBridge

Method Summary

SubmitDocumentResponseType	addCDADocument(java.lang.String cdaXml, DocumentSubmissionMetadataType pMetadata) Submits a new XDS CDA R2 document to the registry/repository.
SubmitDocumentResponseType	embedInCdaAndSendDocument(XDSDocType doc) Prepares, constructs and and submits a CDA R2 to an XDS registry/repository Takes a set datatype of variables for inclusion and constructs a properly-formatted CDA R2 document that corresponds to the data types.
QueryDocumentsResponseType	queryDocuments(FindDocumentQueryType pFindDocumentQueryType, DocumentQueryPreferencesType searchPreferences) Queries an XDS registry and returns an array of serializable objects of the form XDSBridgeDocument containing information about the resulting document or null if no matching documents are found.
QueryDocumentsResponseType	queryDocuments(GetDocumentQueryType pGetDocumentQueryType, DocumentQueryPreferencesType pQueryPreferences)
QueryDocumentsResponseType	queryDocumentsByPatientId(PatientIdType pPatientId, DocumentQueryPreferencesType pSearchPreferences) Queries an XDS registry and returns an array of serializable objects of the form XDSBridgeDocument containing information about the resulting document or null if no matching documents are found.
RetrieveDocumentResponseType	retrieveDocument(java.lang.String uniqueId, java.lang.String uuid) Performsn the final XDS registry search and returns a specific document by its Universally Unique Id (UUID) or registry-assigned Unique ID.
RetrieveDocumentResponseType	retrieveDocumentByUrl(java.lang.String pUrl) Performsn the final XDS registry search and returns a specific document by its URL.

Method Detail

queryDocumentsByPatientId

QueryDocumentsResponseType queryDocumentsByPatientId(PatientIdType pPatientId,
                                                     DocumentQueryPreferencesType pSearchPreferences)
                                                     throws java.lang.Exception

Queries an XDS registry and returns an array of serializable objects of the form XDSBridgeDocument containing information about the resulting document or null if no matching documents are found. Returned object contains relevant metadata about the documents found in the search, including document title, size and MIME Type. Single parameter, patientId, should be obtained via a secondary search from either a PDQ or PIX repository.

Parameters:

pPatientId - The patient ID on which to search the XDS registry for matching documents.

pStoredQuery -

pReturnReferencesOnly -

Returns:

Array of document metadata that matched the search criteria

Throws:

java.lang.Exception

See Also:

org.eclipse.ohf.ihe.xds.consumer.Consumer, org.eclipse.ohf.ihe.xds.consumer.query.Query, org.eclipse.ohf.bridge.xds.XDSBridgeDocument

retrieveDocument

RetrieveDocumentResponseType retrieveDocument(java.lang.String uniqueId,
                                              java.lang.String uuid)
                                              throws java.lang.Exception

Performsn the final XDS registry search and returns a specific document by its Universally Unique Id (UUID) or registry-assigned Unique ID. Returns an XDSBridgeDocument containing relevant metadata about the document and a Base64-encoded-equivalent of the document's binary or ASCII contents. Null is returned if the document is not found. The uniqueId or UUID can be obtained by using the queryDocumentByPatientId method.

Parameters:

uniqueId - The Unique ID to retrieve the document

uuid - The UUID to retrieve the document

Returns:

The document requested and associated metadata

Throws:

java.lang.Exception

addCDADocument

SubmitDocumentResponseType addCDADocument(java.lang.String cdaXml,
                                          DocumentSubmissionMetadataType pMetadata)
                                          throws java.lang.Exception

Submits a new XDS CDA R2 document to the registry/repository. Function accepts a raw CDA document and prepares the document by parsing out necessary data fields for using in the DocumentEntry and SubmissionSet XML Files. Returns boolean whether or not the submission was a success.

Parameters:

cdaXml - Raw CDA R2 document to be submitted to XDS

pMetadata -

Returns:

Whether or not the submit was successful.

Throws:

java.lang.Exception

See Also:

org.eclipse.ohf.ihe.xds.source

embedInCdaAndSendDocument

SubmitDocumentResponseType embedInCdaAndSendDocument(XDSDocType doc)
                                                     throws java.lang.Exception

Prepares, constructs and and submits a CDA R2 to an XDS registry/repository Takes a set datatype of variables for inclusion and constructs a properly-formatted CDA R2 document that corresponds to the data types. Designed to allow EMR/EHR/PHR apps that do not handle CDA R2 natively to still submit documents to XDS.

Parameters:

doc - XDSDocType containing necessary information to construct CDA R2 document

Returns:

Throws:

java.lang.Exception

See Also:

org.eclipse.ohf.ihe.xds.source

queryDocuments

QueryDocumentsResponseType queryDocuments(FindDocumentQueryType pFindDocumentQueryType,
                                          DocumentQueryPreferencesType searchPreferences)
                                          throws java.lang.Exception

Queries an XDS registry and returns an array of serializable objects of the form XDSBridgeDocument containing information about the resulting document or null if no matching documents are found. Returned object contains relevant metadata about the documents found in the search, including document title, size and MIME Type. Single parameter, patientId, should be obtained via a secondary search from either a PDQ or PIX repository.

Parameters:

pStoredQuery -

pReturnReferencesOnly -

Returns:

Array of document metadata that matched the search criteria

Throws:

java.lang.Exception

See Also:

org.eclipse.ohf.ihe.xds.consumer.Consumer, org.eclipse.ohf.ihe.xds.consumer.query.Query, org.eclipse.ohf.bridge.xds.XDSBridgeDocument

queryDocuments

QueryDocumentsResponseType queryDocuments(GetDocumentQueryType pGetDocumentQueryType,
                                          DocumentQueryPreferencesType pQueryPreferences)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

retrieveDocumentByUrl

RetrieveDocumentResponseType retrieveDocumentByUrl(java.lang.String pUrl)
                                                   throws java.net.MalformedURLException,
                                                          java.io.IOException,
                                                          ATNAAuditClientException,
                                                          java.security.GeneralSecurityException,
                                                          org.eclipse.ohf.bridge.conf.UnavailableResourcesException,
                                                          BridgeException

Performsn the final XDS registry search and returns a specific document by its URL. Returns an XDSBridgeDocument containing relevant metadata about the document and a Base64-encoded-equivalent of the document's binary or ASCII contents. Null is returned if the document is not found. The uniqueId or UUID can be obtained by using the queryDocumentByPatientId method.

Parameters:

url - The url to retrieve the document

Returns:

The document requested and associated metadata

Throws:

java.net.MalformedURLException

java.security.GeneralSecurityException

ATNAAuditClientException

java.io.IOException

org.eclipse.ohf.bridge.conf.UnavailableResourcesException

BridgeException

java.lang.Exception