Summary: Methods | [Expand All]
public interface

IExternalAllocation

com.cbs.ctr3ws.iservices.IExternalAllocation
Known Indirect Subclasses

Class Overview

description: the interface contains the CTR2-IPOS- organ allocation soap webservices.

Summary

Public Methods
abstract List<WsIPOSMatchResult> getHSPMatchforDonor(String nationalDonorId)
Gets a donor's current 'IPOS Kidney' match results.
abstract List<WsIPOSMatchResult> getHsHeartMatchResults(String nationalId)
Gets a donor's current 'IPOS Heart' match results.
abstract WsPreviewIPOS_Match previewHSPMatchForDonor(String nationalDonorId)
Preview the 'IPOS Kidney' match results for a donor.
abstract WsPreviewIPOS_Match previewHsHeartMatch(String nationalId)
Preview the 'IPOS Heart' match results for a donor.
abstract List<WsIPOSMatchResult> runHSPMatchOnDonor(String nationalDonorId)
Run an 'IPOS Kidney' allocation for a DWL donor.
abstract List<WsIPOSMatchResult> runHsHeartMatch(String nationalId)
Run an 'IPOS Heart' allocation for a donor.

Public Methods

public abstract List<WsIPOSMatchResult> getHSPMatchforDonor (String nationalDonorId)

Gets a donor's current 'IPOS Kidney' match results.

Sample soap requests: getHSPMatchforDonor

Parameters
nationalDonorId the CTR donor ID.
required: TRUE
see: nationalId info
Returns
  • the donor's current 'IPOS Kidney' match results, sorted descending by match rank.
      The HSP allocation list returned depends on the CTR user's permissions:
    • WHEN the Donor ODO user of donor has permission to view the HSP Allocation list.
      THEN the allocation list returned will include all the recipients matched.

    • WHEN the Recipient ODO user has permission to view HSP kidney offers.
      THEN the allocation list returned will include only the Recipient ODO's recipients that have active kidney offers(proposed, under_review, accepted) from the donor.
    WsIPOSMatchResult
Throws
SoapException

public abstract List<WsIPOSMatchResult> getHsHeartMatchResults (String nationalId)

Gets a donor's current 'IPOS Heart' match results.

Sample soap requests: getHsHeartMatchResults

Parameters
nationalId the CTR donor ID.
required: TRUE
see: nationalId info
Returns
  • the donor's current 'IPOS Heart' match results, sorted descending by match rank.
      The HSH allocation list returned depends on the CTR user's permissions:
    • WHEN the Donor ODO user of donor has permission to view the HSH Allocation list.
      THEN the allocation list returned will include all the recipients matched.

    • WHEN the Recipient ODO user has permission to view HSH heart offers.
      THEN the allocation list returned will include only the Recipient ODO's recipients that have active heart offers(proposed, under_review, accepted) from the donor.
    WsIPOSMatchResult
Throws
SoapException

public abstract WsPreviewIPOS_Match previewHSPMatchForDonor (String nationalDonorId)

Preview the 'IPOS Kidney' match results for a donor.

Sample soap requests: previewHSPMatchForDonor

Parameters
nationalDonorId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the donor's 'IPOS Kidney' match results (in preview mode, active offers are not withdrawn).
    WsPreviewIPOS_Match
Throws
SoapException

public abstract WsPreviewIPOS_Match previewHsHeartMatch (String nationalId)

Preview the 'IPOS Heart' match results for a donor.

Sample soap requests: previewHsHeartMatch

Parameters
nationalId the CTR2 donor ID.
required: TRUE
see: nationalId info
Returns
  • the donor's 'IPOS Heart' match results (in preview mode currently active offers are not withdrawn).
    WsPreviewIPOS_Match
Throws
SoapException

public abstract List<WsIPOSMatchResult> runHSPMatchOnDonor (String nationalDonorId)

Run an 'IPOS Kidney' allocation for a DWL donor.
note: Calling this method will automatically set any of the donor's active kidney offers to WITHDRAWN.

Sample soap requests: runHSPMatchOnDonor

Parameters
nationalDonorId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
Throws
SoapException

public abstract List<WsIPOSMatchResult> runHsHeartMatch (String nationalId)

Run an 'IPOS Heart' allocation for a donor.

Sample soap requests: runHsHeartMatch

Parameters
nationalId the CTR2 donor ID.
required: TRUE
see: nationalId info
Returns
Throws
SoapException