| Oracle® Healthcare Master Person Index Message Processing Reference Release 4.0 E68421-01 |
|
 Previous |
| Oracle® Healthcare Master Person Index Message Processing Reference Release 4.0 E68421-01 |
|
Previous |
This chapter lists the web services that are available with this release of Oracle Healthcare Master Person Index.
The following sections provide a list of the available web services, including a description of the action each one performs.
The OHMPI web service is available for use in the client application. The WSDL of the web service is generated by the Oracle WebLogic application server when the OHMPI application is deployed.
The WSDL file is accessible at http://HOST:PORT/APPLICATION-NAMEEJB/APPLICATION-NAMEEJBService?WSDL
For example, http://localhost:7001/PersonEJB/PersonEJBService?WSDL
The xsd for the WSDL is accessible at http://HOST:PORT/APPLICATION-NAMEEJB/APPLICATION-NAMEEJBService?xsd=1
For example, http://localhost:7001/PersonEJB/PersonEJBService?xsd=1
For more information on the available web service operations and message, see the WSDL file and XSD file.
Description
This method changes the status of a deactivated enterprise object back to active.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object to activate. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method changes the status of a deactivated system object back to active.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The processing code of the system associated with the system record to be activated. |
| localID | String | The local identifier associated with the system record to be activated. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method adds the system object to the enterprise object associated with the specified EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object to which you want to add the system object. |
| sysObjBean | SystemObjectName | The Bean for the system object to be added to the enterprise object. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method changes the status of an active enterprise object to inactive.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object to deactivate. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method changes the status of an active system object to inactive.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The system code of the system object to deactivate. |
| localid | String | The local ID of the system object to deactivate. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method permanently deletes a system object from its associated enterprise object.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The system code of the system object to be deleted. |
| localid | String | The local ID of the system object to be deleted. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
executeMatch is one of two methods you can call to process an incoming system object based on the configuration defined for the matching and associated runtime components (the second method is "executeMatchUpdate"). This process searches for possible matches in the database and contains the logic to add a new record or update existing records in the database. One of the two execute match methods should be used for inserting or updating a record in the database.
The following runtime components configure executeMatch.
The Query Builder defines the blocking queries used for matching.
The Threshold file (master.xml) specifies which blocking query to use and specifies matching parameters, including duplicate and match thresholds.
The pass controller and block picker classes specify how the blocking query is executed.
|
Note: IfexecuteMatch determines that an existing system record will be updated by the incoming record, it replaces the entire existing record with the information in the new record. This could result in loss of data; for example, if the incoming record does not include all address information, existing address information could be lost. To avoid this, use the executeMatchUpdate method instead. |
Input Message
| Name | Type | Description |
|---|---|---|
| sysObjBean | SystemObjectName | The Bean for the system object to be added to or updated in the enterprise object. |
Output Message
A match result object containing the results of the matching process.
Fault Message
ProcessingException
UserException
Description
Similar to "executeMatch", executeMatchUpdate processes the system object based on the configuration defined for the matching and associated runtime components. It is configured by the same runtime components as executeMatch. One of these two execute match methods should be used for inserting or updating a record in the database.
The primary difference between these two methods is that when executeMatchUpdate finds that an incoming record matches an existing record, only the changed data is updated. With executeMatch, the entire existing record would be replaced by the incoming record. The executeMatchUpdate method differs from executeMatch in the following ways:
If a partial record is received, executeMatchUpdate only updates fields whose values are different in the incoming record. Unless the clearFieldIndicator field is used, empty or null fields in the incoming record do not update existing values.
The clearFieldIndicator field can be used to null out specific fields.
Child objects in the existing record are not deleted if they are not present in the incoming record.
Child objects in the existing record are updated if the same key field value is found in both the incoming and existing records.
To allow a child object to be removed from the parent object when using executeMatchUpdate, a new "delete" method is added to each child object bean.
Input Message
| Name | Type | Description |
|---|---|---|
| sysObjBean | SystemObjectName | The Bean for the system object to be added to or updated in the enterprise object. |
Output Message
A match result object containing the results of the matching process.
Fault Message
ProcessingException
UserException
Description
This method returns the enterprise object associated with the specified EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object you want to retrieve. |
Output Message
An enterprise object associated with the specified EUID or null if the enterprise object is not found.
Fault Message
ProcessingException
UserException
Description
This method returns the enterprise object associated with the specified system code and local ID pair.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The system code of a system associated with the enterprise object to find. |
| localid | String | A local ID associated with the specified system. |
Output Message
An enterprise object or null if the enterprise object is not found.
Fault Message
ProcessingException
UserException
Description
This method returns the EUID of the enterprise object associated with the specified system code and local ID.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | A known system code for the enterprise object. |
| localid | String | The local ID corresponding with the given system. |
Output Message
A string containing an EUID or null if the EUID is not found.
Fault Message
ProcessingException
UserException
Description
This method retrieves the local ID and system pairs associated with the given EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object whose local ID and system pairs you want to retrieve. |
Output Message
An array of system object keys (SystemObjectNamePK objects) or null if no results are found.
Fault Message
ProcessingException
UserException
Description
This method retrieves the local ID and system pairs that are of the specified status and that are associated with the given EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object whose local ID and system pairs to retrieve. |
| status | String | The status of the local ID and system pairs to retrieve. |
Output Message
An array of system object keys (SystemObjectNamePK objects) or null if no system object keys are found.
Fault Message
ProcessingException
UserException
Description
This method retrieves the history of the merge transactions associated with the specified EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID associated with the merge history to retrieve. |
Output Message
A mergeHistoryNode object containing the merge history retrieved.
Fault Message
ProcessingException
UserException
Description
This method retrieves the single best record (SBR) associated with the specified EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object whose SBR you want to retrieve. |
Output Message
An SBR object or null if no SBR associated with the specified EUID is found.
Fault Message
ProcessingException
UserException
Description
This method retrieves the system object associated with the given system code and local ID pair.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The system code of the system object to retrieve. |
| localid | String | The local ID of the system object to retrieve. |
Output Message
A system object containing the results of the search or null if no system objects are found.
Fault Message
ProcessingException
UserException
Description
This method returns the active system objects associated with the specified EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object whose system objects you want to retrieve. |
Output Message
An array of system objects associated with the specified EUID.
Fault Message
ProcessingException
UserException
Description
This method returns the system objects of the specified status that are associated with the given EUID.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object whose system objects you want to retrieve. |
| status | String | The status of the system objects you want to retrieve. |
Output Message
An array of system objects associated with the specified EUID and status, or null if no system objects are found.
Fault Message
ProcessingException
UserException
Description
This method returns an array of assumed match result records based on the criteria contained in the assumed match search object.
Input Message
| Name | Type | Description |
|---|---|---|
| amsoBean | AssumedMatchSearchObjectBean | An object containing the criteria for an assumed match search. |
Output Message
An array of AssumedMatchResult objects representing the matches to an assumed match search.
Fault Message
ProcessingException
UserException
Description
This method first looks up the EUID associated with the specified source system and source local ID. It then retrieves the local ID and system pairs of the specified status that are associated with that EUID and are from the specified destination system.
|
Note: Both systems must be of the specified status or an error will occur. |
Input Message
| Name | Type | Description |
|---|---|---|
| sourceSystemCode | String | The system code of the known system and local ID pair. |
| sourceLID | String | The local ID of the known system and local ID pair. |
| destSystemCode | String | The system from which the local ID and system pairs to retrieve originated. |
| status | String | The status of the local ID and system pairs to retrieve. |
Output Message
An array of system object keys (SystemObjectNamePK objects).
Fault Message
ProcessingException
UserException
Description
This method returns an array of potential duplicate result records based on the criteria contained in the potential duplicate search object.
Input Message
| Name | Type | Description |
|---|---|---|
| pdsoBean | PotentialDuplicateSearchObjectBean | An object containing the criteria for a potential duplicate search. |
Output Message
An array of PotentialDuplicateResult objects representing the matches to a potential duplicate search.
Fault Message
ProcessingException
UserException
Description
This method returns a summary of the transaction associated with the specified transaction number.
Input Message
| Name | Type | Description |
|---|---|---|
| transId | String | The transaction number for the transaction to look up. |
Output Message
A TransactionSummaryBean object representing the transaction summary for the specified transaction ID.
Fault Message
ProcessingException
UserException
Description
This method returns an array of the transaction summaries based on the search criteria contained in the transaction search object.
Input Message
| Name | Type | Description |
|---|---|---|
| obj | TransactionSearchObject | The transaction search object containing the search criteria. |
Output Message
An array of transaction summaries matching the given search criteria.
Fault Message
ProcessingException
UserException
Description
This method merges two enterprise objects, specified by their EUIDs.
Input Message
| Name | Type | Description |
|---|---|---|
| fromEUID | String | The EUID of the enterprise object that will not survive the merge. |
| toEUID | String | The EUID of the enterprise object that will survive the merge. |
| calculateOnly | boolean | An indicator of whether to commit changes to the database or to simply compute the merge results. Specify false to commit the changes. |
Output Message
A merge result object containing the results of the merge.
Fault Message
ProcessingException
UserException
Description
This method merges two system objects, specified by their local IDs, from the specified system. The system objects can belong to a single enterprise object or to two different enterprise objects.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The processing code of the system to which the two system objects belong. |
| sourceLID | String | The local ID of the system object that will not survive the merge. |
| destLID | String | The local ID of the system object that will survive the merge. |
| calculateOnly | boolean | An indicator of whether to commit changes to the database or to simply compute the merge results. Specify false to commit the changes. |
Output Message
A merge result object containing the results of the merge.
Fault Message
ProcessingException
UserException
Description
This method flags a potential duplicate pair with Resolved or Auto Resolved status. If resolved, the pair can be marked as potential duplicates again during a future transaction. If auto-resolved, the pair is permanently flagged as resolved.
Input Message
| Name | Type | Description |
|---|---|---|
| id | String | The potential duplicate ID of the pair to be resolved. |
| autoResolve | boolean | A Boolean value indicating whether to resolve or auto-resolve the pair. Use true for auto-resolve, and use false for resolve. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method performs a query against the database using the query specified in queryName and the criteria contained in the specified object bean.
Input Message
| Name | Type | Description |
|---|---|---|
| objBean | ObjectNameBean | The search criteria for the query. |
| queryName | String | The name of the query to use. |
| weightOption | boolean | An indicator of whether to calculate the score of matching. Specify true to calculate. |
Output Message
An array of search result records.
Fault Message
ProcessingException
UserException
Description
This method performs a blocking query against the database using the blocking query specified in the master.xml and the criteria contained in the specified object bean.
Input Message
| Name | Type | Description |
|---|---|---|
| objBean | ObjectNameBean | The search criteria for the blocking query. |
Output Message
An array of search result records.
Fault Message
ProcessingException
UserException
Description
This method performs an exact match search using the criteria specified in the object bean. Only records that exactly match the search criteria are returned in the search results object.
Input Message
| Name | Type | Description |
|---|---|---|
| objBean | ObjectNameBean | The search criteria for the exact match search. |
Output Message
An array of search result records.
Fault Message
ProcessingException
UserException
Description
This method performs search using phonetic values for some of the criteria specified in the object bean. This type of search allows for typographical errors and misspellings.
Input Message
| Name | Type | Description |
|---|---|---|
| objBean | ObjectNameBean | The search criteria for the phonetic search. |
Output Message
An array of search result records.
Fault Message
ProcessingException
UserException
Description
This method transfers a system record from one enterprise record to another enterprise record.
Input Message
| Name | Type | Description |
|---|---|---|
| toEUID | String | The EUID of the enterprise record to which the system record will be transferred. |
| systemCode | String | The processing code of the system record to transfer. |
| localID | String | The local ID of the system record to transfer. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method reverses an assumed match transaction, unmerging the two objects that were matched and creating a new enterprise object for the record that caused the assumed match. Potential duplicates are calculated for the new enterprise object.
Input Message
| Name | Type | Description |
|---|---|---|
| assumedMatchId | String | The ID of the assumed match transaction to reverse. |
Output Message
The EUID of the newly created enterprise object resulting from the reversing assumed match.
Fault Message
ProcessingException
UserException
Description
This method unmerges the two enterprise objects that were involved in the most recent merge transaction for the specified EUID. When the calculateOnly is set to true, the unmerge results is calculated, but the changes are not committed to the database.
Input Message
| Name | Type | Description |
|---|---|---|
| euid | String | The EUID of the enterprise object to be unmerged. |
| calculateOnly | String | An indicator of whether to commit the unmerge to the database or to calculate the changes for viewing. Specify true to calculate for viewing; specify false to commit to the database. |
Output Message
The MergePersonResult object, the result of the unmerge transaction.
Fault Message
ProcessingException
UserException
Description
This method unmerges the two system objects that were involved in the most recent merge transaction for the specified local ID. When the calculateOnly is set to true, the unmerge results is computed, but the changes are not committed to the database.
Input Message
| Name | Type | Description |
|---|---|---|
| systemCode | String | The system code of the system object to be unmerged. |
| sourceLID | String | The local ID of the non-surviving system object. |
| destLID | String | The local ID of the surviving system object. |
| calculateOnly | String | An indicator of whether to commit unmerge to the database or to calculate the changes for viewing. Specify true to calculate for viewing; specify false to commit to the database. |
Output Message
The MergePersonResult object, the result of the unmerge transaction.
Fault Message
ProcessingException
UserException
Description
This method changes the status of a resolved or auto-resolved potential duplicate record pair back to unresolved and places the records back in the potential duplicate listing.
Input Message
| Name | Type | Description |
|---|---|---|
| id | String | The potential duplicate ID of the records to be unresolved. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method updates the fields in an existing enterprise object with the values specified in the fields the enterprise object passed in as a parameter. When updating an enterprise object, attempting to change a field that is not updateable will cause an exception. This method does not update the SBR; the survivor calculator updates the SBR once the changes are made to the associated system records. To update SBR via link or lock, you must provide a list of SBROverWriteBean in the SBR<ObjectName>. The list of SBROverWriteBean is a list of SBR fields to be updated.
Input Message
| Name | Type | Description |
|---|---|---|
| eoBean | EnterpriseObjectName | The enterprise object containing the values that will update the existing enterprise object. |
Output Message
None
Fault Message
ProcessingException
UserException
Description
This method updates the existing system object in the database with the given system object.
Input Message
| Name | Type | Description |
|---|---|---|
| sysObjBean | SystemObjectName | The system object to be updated to the enterprise object. |
Output Message
None
Fault Message
ProcessingException
UserException
The following are standard web services for IHE PIXv3/PDQv3 (HL7 v3 based) profiles. They are defined by IHE. The WSDLs and associated schemas are available at ftp://ftp.ihe.net/TF_Implementation_Material/ITI/.
pixManagerPRPAIN201301UV02
Adds a new patient record to the PIX Manager.
pixManagerPRPAIN201302UV02
Updates an existing patient record in the PIX Manager.
pixManagerPRPAIN201304UV02
Merges two existing patient records in the PIX Manager.
pixManagerPRPAIN201309UV02
PIX query to get patient identifiers in selected or all domains against the PIX Manager.
pdqSupplierPRPAIN201305UV02
Patient demographics query against the PDQ Supplier.
pdqSupplierQUQIIN000003UV01Cancel
Cancels an existing patient demographics query against the PDQ Supplier.
pdqSupplierQUQIIN000003UV01Continue
Continues an existing patient demographics query against the PDQ Supplier.
