|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.ohf.bridge.ws.OHFBridge
public class OHFBridge
Unified web service for aggregating functionality provided by the Eclipse Open Healthcare Framework. Web service currently implements necessary functionality to leverage IHE actors of the OHF Project, XDS (Consumer/Source), PDQ (Consumer), PIX (Consumer/Source), and ATNA Audit.
| Constructor Summary | |
|---|---|
OHFBridge()
|
|
| Method Summary | |
|---|---|
ResponseType |
AdmitInpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
This method admits an inpatient to the system, and adds their demographic information appropriately |
ResponseType |
AuditActorStartEvent(SessionContext sessionContext,
int eventOutcome)
Sends an "Application Start Event" to the Audit Repository. |
ResponseType |
AuditActorStopEvent(SessionContext sessionContext,
int eventOutcome)
Sends an "Application Stop Event" to the Audit Repository. |
ResponseType |
AuditPatientRecordCreateEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
Sends a "Patient Record Audit Event" to the Audit Repository indicating a CREATING of a patient record has taken place. |
ResponseType |
AuditPatientRecordDeleteEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
Sends a "Patient Record Audit Event" to the Audit Repository indicating a DELETING of a patient record has taken place. |
ResponseType |
AuditPatientRecordReadEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
Sends a "Patient Record Audit Event" to the Audit Repository indicating a READING of a patient record has taken place. |
ResponseType |
AuditPatientRecordUpdateEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
Sends a "Patient Record Audit Event" to the Audit Repository indicating a UPDATING of a patient record has taken place. |
ResponseType |
AuditPhiExport(SessionContext sessionContext,
int eventOutcome,
java.lang.String dataRecipientId,
java.lang.String exportedDataId,
PatientIdType patientId)
Sends a PHI export audit event to the audit repository. |
ResponseType |
AuditPhiImport(SessionContext sessionContext,
int eventOutcome,
java.lang.String dataSourceId,
PatientIdType[] patientIds,
java.lang.String importedDataId)
Sends a PHI import audit event to the audit repository. |
ResponseType |
AuditQueryEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String registryID,
java.lang.String queryText)
Sends a "Query Audit Event" to the Audit Repository. |
ResponseType |
AuditUserAuthenticationLoginEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String initiatingUserName,
java.lang.String initiatingUserNodeIP,
java.lang.String authenticatingNodeIP)
Sends a "User Authentication Event" to the Audit Repository indicating a LOGOUT event has taken place. |
ResponseType |
AuditUserAuthenticationLogoutEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String initiatingUserName,
java.lang.String initiatingUserNodeIP,
java.lang.String authenticatingNodeIP)
Sends a "User Authentication Event" to the Audit Repository indicating a LOGOUT event has taken place. |
java.lang.String[] |
GetMyLog(SessionContext sessionContext,
int startingAtLine)
Gets the current user's last n events from the log of activity within OHF, beginning at the line specified. |
org.eclipse.ohf.bridge.conf.rhio.RhioConfig[] |
GetRhios()
Gets the list of configured RHIOs from the RHIO configuration file. |
ResponseType |
MergePatient(SessionContext sessionContext,
PatientInfoType patientInfoTarget,
java.lang.String patientClassTarget,
PatientInfoType patientInfoMerge)
This method merges two local patients in the system, the target patient will remain after the merge |
ResponseType |
PreAdmitInpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
This method preAdmits an inpatient to the system, and adds their demographic information appropriately |
QueryDocumentsResponseType |
QueryDocumentsByPatientId(SessionContext sessionContext,
PatientIdType patientId,
DocumentQueryPreferencesType queryPreferences)
Searches an XDS Registry for all documents assigned to a given patient ID. |
QueryDocumentsResponseType |
QueryDocumentsFind(SessionContext sessionContext,
FindDocumentQueryType queryDocumentQueryType,
DocumentQueryPreferencesType queryPreferences)
Searches an XDS Registry for documents matching the search constraints specified. |
QueryDocumentsResponseType |
QueryDocumentsGet(SessionContext sessionContext,
GetDocumentQueryType getDocumentQueryType,
DocumentQueryPreferencesType queryPreferences)
Searches an XDS Registry for documents that match from a list of document unique IDs / UUIDs provided. |
ResponseType |
RegisterOutpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
This method registers an outpatient to the system, and adds their demographic information appropriately |
RetrieveDocumentResponseType |
RetrieveDocumentByUniqueId(SessionContext sessionContext,
java.lang.String uniqueId)
Performs an XDS registry search for a document by its Unique ID and retrieves the specified document from the XDS repository. |
RetrieveDocumentResponseType |
RetrieveDocumentByUrl(SessionContext sessionContext,
java.lang.String url)
Retrieves a document directly from an XDS repository by the URL specified. |
RetrieveDocumentResponseType |
RetrieveDocumentByUUID(SessionContext sessionContext,
java.lang.String UUID)
Performs an XDS registry search for a document by its Universally Unique Id (UUID) and retrieves the specified document from the XDS repository. |
SearchPatientResponseType |
SearchPatient(SessionContext sessionContext,
PatientInfoType patientInfo,
PatientSearchPreferencesType queryPreferences)
Performs either a PIX or PDQ consumer query. |
SubmitDocumentResponseType |
SubmitDocument(SessionContext sessionContext,
java.lang.String base64EncodedDocument,
DocumentSubmissionMetadataType metadata)
Takes a properly formed document and auxillary metadata necessary to create an XDS SubmissionSet and DocumentEntry. |
ResponseType |
UpdateInPatient(SessionContext sessionContext,
PatientInfoType patientInfo)
This method updates an existing inpatient in the system, and adds their demographic information appropriately |
ResponseType |
UpdateOutPatient(SessionContext sessionContext,
PatientInfoType patientInfo)
This method updates an existing outpatient in the system, and adds their demographic information appropriately |
java.lang.String |
Version()
Returns the version of the OHF Bridge currently in use. |
SubmitDocumentResponseType |
WrapInCdaAndSubmitDocument(SessionContext sessionContext,
XDSDocType doc)
Wraps a provided document into CDA R2 format created from user-specified metadata, prepares the document for submission, and sends to an XDS repository. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public OHFBridge()
| Method Detail |
|---|
public QueryDocumentsResponseType QueryDocumentsByPatientId(SessionContext sessionContext,
PatientIdType patientId,
DocumentQueryPreferencesType queryPreferences)
throws java.lang.Throwable
sessionContext - Transactional context informationpatientId - The patient ID to find documents forqueryPreferences - User preferences for the query
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.queryDocumentsByPatientId
public QueryDocumentsResponseType QueryDocumentsFind(SessionContext sessionContext,
FindDocumentQueryType queryDocumentQueryType,
DocumentQueryPreferencesType queryPreferences)
throws java.lang.Throwable
sessionContext - Transactional context informationqueryDocumentQueryType - Search constraints for the XDS queryqueryPreferences - User preferences for the query
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.queryDocuments
public QueryDocumentsResponseType QueryDocumentsGet(SessionContext sessionContext,
GetDocumentQueryType getDocumentQueryType,
DocumentQueryPreferencesType queryPreferences)
throws java.lang.Throwable
sessionContext - Transactional context informationgetDocumentQueryType - Object containing list of IDs for documents to get metadata forqueryPreferences - Preferences for the query
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.queryDocuments
public RetrieveDocumentResponseType RetrieveDocumentByUUID(SessionContext sessionContext,
java.lang.String UUID)
throws java.lang.Throwable
sessionContext - Transactional context informationUUID - The "Universally Unique ID" (UUID) of the document to retrieve
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.retrieveDocument
public RetrieveDocumentResponseType RetrieveDocumentByUniqueId(SessionContext sessionContext,
java.lang.String uniqueId)
throws java.lang.Throwable
sessionContext - Transactional context informationuniqueId - The Unique ID of the document to retrieve
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.retrieveDocument
public RetrieveDocumentResponseType RetrieveDocumentByUrl(SessionContext sessionContext,
java.lang.String url)
throws java.lang.Throwable
sessionContext - Transactional context informationurl - The URL of the document to retrieve
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.retrieveDocumentByUrl
public SubmitDocumentResponseType WrapInCdaAndSubmitDocument(SessionContext sessionContext,
XDSDocType doc)
throws java.lang.Throwable
sessionContext - Transactional context informationdoc - Complex SOAP-mapped object that contains necessary meta
information to construct a CDA R2 document
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.embeddInCdaAndSendDocument
public SubmitDocumentResponseType SubmitDocument(SessionContext sessionContext,
java.lang.String base64EncodedDocument,
DocumentSubmissionMetadataType metadata)
throws java.lang.Throwable
sessionContext - Transactional context informationdocument - Raw document of type identified by the metadatametadata - Auxillary metadata, including patient IDs and document type being submitted
java.lang.Throwableorg.eclipse.ohf.bridge.xds.XdsBridge.addCDADocument
public SearchPatientResponseType SearchPatient(SessionContext sessionContext,
PatientInfoType patientInfo,
PatientSearchPreferencesType queryPreferences)
throws java.lang.Throwable
PatientSearchPreferencesType.withoutDemographics=true) query performs
a cross-reference search on patient IDs on a given PIX server, returning
matching IDs from the cross reference. A PDQ query (PatientSearchPreferencesType.withoutDemographics=false)
searches demographic data on a given PIX server, returning a list of patients that
match the given demographic constraints.
sessionContext - Transactional context informationpatientInfo - Patient identification and demographic data to search onqueryPreferences - Search preferences (e.g. to specify PIX or PDQ queries)
java.lang.Throwableorg.eclipse.ohf.bridge.pix.PatientConsumerBridge.searchPatient
public ResponseType AdmitInpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
throws java.lang.Throwable
sessionContext - patientInfo - The demographic information of the patient
java.lang.Throwable
public ResponseType RegisterOutpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
throws java.lang.Throwable
sessionContext - patientInfo - The demographic information of the patient
java.lang.Throwable
public ResponseType PreAdmitInpatient(SessionContext sessionContext,
PatientInfoType patientInfo)
throws java.lang.Throwable
sessionContext - patientInfo - The demographic information of the patient
java.lang.Throwable
public ResponseType UpdateOutPatient(SessionContext sessionContext,
PatientInfoType patientInfo)
throws java.lang.Throwable
sessionContext - patientInfo - The demographic information of the patient
java.lang.Throwable
public ResponseType UpdateInPatient(SessionContext sessionContext,
PatientInfoType patientInfo)
throws java.lang.Throwable
sessionContext - patientInfo - The demographic information of the patient
java.lang.Throwable
public ResponseType MergePatient(SessionContext sessionContext,
PatientInfoType patientInfoTarget,
java.lang.String patientClassTarget,
PatientInfoType patientInfoMerge)
throws java.lang.Throwable
sessionContext - patientInfoTarget - The demographic information of the patient to remainpatientClassTarget - The target patient class (ex "I" - inpatient, "O" - outpatient, "E" - emergency)patientInfoMerge - The local ID of the patient to merge with the target
java.lang.Throwable
public ResponseType AuditPhiImport(SessionContext sessionContext,
int eventOutcome,
java.lang.String dataSourceId,
PatientIdType[] patientIds,
java.lang.String importedDataId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event (see ATNAAuditClient constants)dataSourceId - String indicating where imported data came from (e.g. XDS Registry)patientIds - List of patient IDs that came from imported dataimportedData - Either the actual data or a UUID of the data that was imported
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPHIImportEvent
public ResponseType AuditPhiExport(SessionContext sessionContext,
int eventOutcome,
java.lang.String dataRecipientId,
java.lang.String exportedDataId,
PatientIdType patientId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event (see ATNAAuditClient constants)dataRecipientId - Destination of data (XDS repository, for example)exportedDataId - Either the actual data or a UUID of the data that was exportedpatientId - The ID of the patient the data pertains to
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPHIExportEvent
public ResponseType AuditActorStartEvent(SessionContext sessionContext,
int eventOutcome)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event (see ATNAAuditClient constants)
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditActorStartEvent
public ResponseType AuditActorStopEvent(SessionContext sessionContext,
int eventOutcome)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event (see ATNAAuditClient constants)
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditActorStopEvent
public ResponseType AuditUserAuthenticationLoginEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String initiatingUserName,
java.lang.String initiatingUserNodeIP,
java.lang.String authenticatingNodeIP)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)initiatingUserName - The username of the user attempting to logininitiatingUserNodeIP - The IP address of the user attempting to loginauthenticatingNodeIP - The IP adderss of the system conducting the authentication
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditUserAuthenticationLoginEvent
public ResponseType AuditUserAuthenticationLogoutEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String initiatingUserName,
java.lang.String initiatingUserNodeIP,
java.lang.String authenticatingNodeIP)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)initiatingUserName - The username of the user attempting to logininitiatingUserNodeIP - The IP address of the user attempting to loginauthenticatingNodeIP - The IP adderss of the system conducting the authentication
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditUserAuthenticationLogoutEvent
public ResponseType AuditQueryEvent(SessionContext sessionContext,
int eventOutcome,
java.lang.String registryID,
java.lang.String queryText)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)registryId - The entity responsible for answering the queryqueryText - Text of the query issued
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditQueryEvent
public ResponseType AuditPatientRecordReadEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)patientID - The ID of the patient the transaction pertains to
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPatientRecordReadEvent
public ResponseType AuditPatientRecordCreateEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)patientID - The ID of the patient the transaction pertains to
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPatientRecordCreateEvent
public ResponseType AuditPatientRecordUpdateEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)patientID - The ID of the patient the transaction pertains to
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPatientRecordUpdateEvent
public ResponseType AuditPatientRecordDeleteEvent(SessionContext sessionContext,
int eventOutcome,
PatientIdType patientId)
throws java.lang.Throwable
sessionContext - Transactional context informationeventOutcome - Code indicating the outcome of the event
(see ATNAAuditClient constants)patientID - The ID of the patient the transaction pertains to
java.lang.Throwableorg.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient,
org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient.auditPatientRecordDeleteEvent
public org.eclipse.ohf.bridge.conf.rhio.RhioConfig[] GetRhios()
throws java.lang.Throwable
java.lang.Throwablepublic java.lang.String Version()
public java.lang.String[] GetMyLog(SessionContext sessionContext,
int startingAtLine)
throws java.lang.Throwable
sessionContext - The transaction's session informationstartingAtLine - Line to start at in the log
java.lang.Throwable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||