com.mirth.match.client
Class EISManagementAndQuery

java.lang.Object
  com.mirth.match.client.EISManagementAndQuery

public class EISManagementAndQuery
extends java.lang.Object

Author:

davidp

Constructor Summary

EISManagementAndQuery(MirthMatchClient client)

Method Summary

Result	createIdentityFromEntity(java.lang.String entityTypeName, EisIdentityQualifier systemId, EisEntityIdentifyingTraits traits) This operation generates an Entity ID on behalf of a Source that does not generate Entity IDs.
Result<java.util.List<EisResultSetElement>>	findIdentitiesByTraits(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, java.lang.String eisId, EisEntityIdentifyingTraits entityIdentifyingTraits, EisSearchQualifier searchQualifiers) This operation provides the means to perform a broad search of all records in the EIS whose Traits match some criteria in the supplied search criteria (such as find all records who match the name “Jones, Bob”.
Result	getEntityTraitValues(java.lang.String entityId, EisIdentityQualifier systemId, java.lang.String semanticSignifierName, EisEntityIdentifyingTraits traits) Retrieves the Traits associated with a Source ID/Entity ID pair.
DTOResultSet<EisResultSetElement>	listLinkedIdentities(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, EisEntityIdentifyingTraits entityIdentifyingTraits, java.util.List<EisIdentityQualifier> identityQualifierConstraintSet) This operation retrieves all the Source ID/Entity ID pairs that are linked to the supplied Source ID/Entity ID pair.
Result<java.util.List<EisResultSetElement>>	listUnlinkedIdentities(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, EisEntityIdentifyingTraits entityIdentifyingTraits, java.util.List<EisIdentityQualifier> identityQualifierConstraintSet) This operation retrieves duplicately specified, yet unlinked records in the EIS repository.
Result<EisEntityIdentifier>	registerEntityWithIdentity(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, EisEntityIdentifyingTraits entityIdentifyingTraits) This operation inserts a Source ID/Entity ID pair and supplied Traits into the EIS with implicit linking to other matching Source ID/ Entity ID pairs, based on the configured internal matching algorithm.
DTOStatus	removeIdentity(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, EisEntityIdentifyingTraits entityIdentifyingTraits) This function deletes a Source ID/Entity ID pair and its associated Traits from the EIS repository.
DTOStatus	updateEntityTraitValues(java.lang.String entityTypeName, java.lang.String localEntityIdentifier, EisIdentityQualifier systemId, EisEntityIdentifyingTraits entityIdentifyingTraits) This operation generates an Entity ID on behalf of a Source that does not generate Entity IDs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EISManagementAndQuery

public EISManagementAndQuery(MirthMatchClient client)

Method Detail

registerEntityWithIdentity

public Result<EisEntityIdentifier> registerEntityWithIdentity(java.lang.String entityTypeName,
                                                              java.lang.String localEntityIdentifier,
                                                              EisIdentityQualifier systemId,
                                                              EisEntityIdentifyingTraits entityIdentifyingTraits)

This operation inserts a Source ID/Entity ID pair and supplied Traits into the EIS with implicit linking to other matching Source ID/ Entity ID pairs, based on the configured internal matching algorithm. It is the normal operation for the insertion of new Entity data into the EIS.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

entityIdentifyingTraits -

Returns:

createIdentityFromEntity

public Result createIdentityFromEntity(java.lang.String entityTypeName,
                                       EisIdentityQualifier systemId,
                                       EisEntityIdentifyingTraits traits)

This operation generates an Entity ID on behalf of a Source that does not generate Entity IDs. It inserts the Source ID/newly-generated Entity ID pair and supplied Traits into the EIS with implicit linking to other matching Source ID/Entity ID pairs, based on the configured internal matching algorithm. This operation may be used in environments where the RegisterEntityWithIdentity cannot be used because the Source does not assign Identifiers to Entities.

Parameters:

entityTypeName -

systemId -

traits -

Returns:

updateEntityTraitValues

public DTOStatus updateEntityTraitValues(java.lang.String entityTypeName,
                                         java.lang.String localEntityIdentifier,
                                         EisIdentityQualifier systemId,
                                         EisEntityIdentifyingTraits entityIdentifyingTraits)

This operation generates an Entity ID on behalf of a Source that does not generate Entity IDs. It inserts the Source ID/newly-generated Entity ID pair and supplied Traits into the EIS with implicit linking to other matching Source ID/Entity ID pairs, based on the configured internal matching algorithm. This operation may be used in environments where the RegisterEntityWithIdentity cannot be used because the Source does not assign Identifiers to Entities.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

entityIdentifyingTraits -

Returns:

removeIdentity

public DTOStatus removeIdentity(java.lang.String entityTypeName,
                                java.lang.String localEntityIdentifier,
                                EisIdentityQualifier systemId,
                                EisEntityIdentifyingTraits entityIdentifyingTraits)

This function deletes a Source ID/Entity ID pair and its associated Traits from the EIS repository. This operation is designed to correct a true invalid data condition, such as the data entry of practice or testing data. All of the operations in the EISAdminInterface are the normal operations to deal with changes and corrections to otherwise valid data.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

entityIdentifyingTraits -

Returns:

findIdentitiesByTraits

public Result<java.util.List<EisResultSetElement>> findIdentitiesByTraits(java.lang.String entityTypeName,
                                                                          java.lang.String localEntityIdentifier,
                                                                          EisIdentityQualifier systemId,
                                                                          java.lang.String eisId,
                                                                          EisEntityIdentifyingTraits entityIdentifyingTraits,
                                                                          EisSearchQualifier searchQualifiers)

This operation provides the means to perform a broad search of all records in the EIS whose Traits match some criteria in the supplied search criteria (such as find all records who match the name “Jones, Bob”. This operation is equivalent to the IHE PDQ transaction.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

eisId -

entityIdentifyingTraits -

searchQualifiers -

Returns:

listLinkedIdentities

public DTOResultSet<EisResultSetElement> listLinkedIdentities(java.lang.String entityTypeName,
                                                              java.lang.String localEntityIdentifier,
                                                              EisIdentityQualifier systemId,
                                                              EisEntityIdentifyingTraits entityIdentifyingTraits,
                                                              java.util.List<EisIdentityQualifier> identityQualifierConstraintSet)

This operation retrieves all the Source ID/Entity ID pairs that are linked to the supplied Source ID/Entity ID pair. The operation can be filtered with the sourceConstraintSet property of the EISSearchQualifier to only return entities within specified Source domains. This operation is equivalent to the IHE PIX transaction.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

entityIdentifyingTraits -

identityQualifierConstraintSet -

Returns:

listUnlinkedIdentities

public Result<java.util.List<EisResultSetElement>> listUnlinkedIdentities(java.lang.String entityTypeName,
                                                                          java.lang.String localEntityIdentifier,
                                                                          EisIdentityQualifier systemId,
                                                                          EisEntityIdentifyingTraits entityIdentifyingTraits,
                                                                          java.util.List<EisIdentityQualifier> identityQualifierConstraintSet)

This operation retrieves duplicately specified, yet unlinked records in the EIS repository. It filters the record set to only return matching, but unlinked records. The operation can be filtered with sourceConstraintSet to only return entities within specified Source domains.

Parameters:

entityTypeName -

localEntityIdentifier -

systemId -

entityIdentifyingTraits -

identityQualifierConstraintSet -

Returns:

getEntityTraitValues

public Result getEntityTraitValues(java.lang.String entityId,
                                   EisIdentityQualifier systemId,
                                   java.lang.String semanticSignifierName,
                                   EisEntityIdentifyingTraits traits)

Retrieves the Traits associated with a Source ID/Entity ID pair.

Parameters:

entityId -

systemId -

semanticSignifierName -

traits -

Returns: