public class

WsIPOSMatchResult

extends Object
implements Serializable
java.lang.Object
   ↳ com.cbs.ctr3ws.dtos.allocation.WsIPOSMatchResult

Class Overview

description: the class contains an “IPOS Organ Program" match information.
see: The class is used only to output returned values.

Summary

Fields
public BigDecimal adjustedCPRA description: the recipient's adjusted cPRA.
public double age description: the recipient's age.
public Date allocationDate description: the date-time the allocation was run.
public WSLookup bloodGroup description: the recipient's blood group.
public Boolean bloodGroupMatch description: a flag indicating if the donor's blood group matches the recipient's blood group.
public BigDecimal cPRA description: the recipient's cPRA.
public String comment description: the field contains comments that are required for some reason codes, recipient acceptance criteria, etc...
public Long daysAtCurrentStatus description: the number of days the organ request has been at the current medical status.
public Long daysOnDialysis description: the time the recipient has been on dialysis in days.
public Boolean donorAtThreshold description: a flag indicating that the donor's province is at threshold.
public Boolean highlySensitized description: a flag indicating that the organ request is highly sensitized.
public long id description: the unique “IPOS Organ Program" match identifier.
public Boolean inUtero description: a flag indicating that the patient not yet born.
public Date listDateTime description: the date/time when DWL recipient organ request listed in CTR.
public String localRecipientId description: the unique local patient identifier provided by local Transplant Program OR ODO.
public String nationalDonorId description: the donor's CTR2 patient ID.
public String nationalRecipientId description: the CTR2 patient ID.
public WSFacility odo description: the recipient's ODO facility.
public WSLookup organMedicalStatus description: the organ medical status.
public long organRequestId description: the unique organ request identifier.
public int organRequestRank description: the 'IPOS Organ Program' match organ request rank.
public WSLookup organRequestReason description: the reason for the organ status.
public WSLookup organRequestStatus description: the Organ Request State of patient’s readiness to accept an organ offer.
public WSLookup organRequired description: the Organ requested for transplant.
public List<WsRelatedOrganRequest> otherActiveRors description: a list of the recipient's other active organ request.
public Boolean recipientAtThreshold description: a flag indicating that the recipient's province is at threshold.
public WSFacility recipientTXCenter description: the patient's transplant centre facility.
public WSLookup transplantType description: the recipient's transplant type.
public WSLookup vxm description: the allocation virtual cross match information.
public String wtcCrossedAntigens description: the antigens that were crossed during the allocation.
Public Constructors
WsIPOSMatchResult()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public BigDecimal adjustedCPRA

description: the recipient's adjusted cPRA.
note:

  • the field applies to all organ allocation results
  • the field will always be returned, irrespective of the CTR configuration item (WTC=ON/OFF), when it's value = NULL, the XML value returned is: <adjustedCPRA xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

public double age

description: the recipient's age.
see: Age in decimal format

public Date allocationDate

description: the date-time the allocation was run.

public WSLookup bloodGroup

description: the recipient's blood group.

public Boolean bloodGroupMatch

description: a flag indicating if the donor's blood group matches the recipient's blood group.
note: this field applies only to IPOS Heart allocation results.

public BigDecimal cPRA

description: the recipient's cPRA.
* note:
*

    *
  • the field will always be returned, when it's value = NULL, the XML value returned is: * <cPRA xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  • *

public String comment

description: the field contains comments that are required for some reason codes, recipient acceptance criteria, etc... .

public Long daysAtCurrentStatus

description: the number of days the organ request has been at the current medical status.
note:

  • the field applies only to IPOS HEART allocation results
  • for other organs it's value = NULL, the XML value returned is: <daysAtCurrentStatus xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

public Long daysOnDialysis

description: the time the recipient has been on dialysis in days.
note:

  • the field applies only to IPOS KIDNEY allocation results
  • the calculation based on the transplant date and most recent dialysis start date ( excluding current date )
  • it is recalculated when either transplant date or most recent dialysis start date is changed ( if most recent dialysis start date is before the transplant date )
  • If 'Patient is on Dialysis' is updated to No and a value already exists in the Days on Dialysis at transplant field , no recalculation is required( even when the Transplant date is updated )
  • for other organs it's value = NULL, the XML value returned is: <daysOnDialysis xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

public Boolean donorAtThreshold

description: a flag indicating that the donor's province is at threshold.

public Boolean highlySensitized

description: a flag indicating that the organ request is highly sensitized.
note:

  • the field applies only to IPOS HEART allocation results
  • for other organs it's value = NULL, the XML value returned is: <highlySensitized xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

public long id

description: the unique “IPOS Organ Program" match identifier.
see: id field info

public Boolean inUtero

description: a flag indicating that the patient not yet born.

public Date listDateTime

description: the date/time when DWL recipient organ request listed in CTR.

public String localRecipientId

description: the unique local patient identifier provided by local Transplant Program OR ODO.
see: free format text, max L=100

public String nationalDonorId

description: the donor's CTR2 patient ID.

see: nationalId info

public String nationalRecipientId

description: the CTR2 patient ID.

public WSFacility odo

description: the recipient's ODO facility.
see: WSFacility

public WSLookup organMedicalStatus

description: the organ medical status.
see: LT_MEDICAL_STATUS

public long organRequestId

description: the unique organ request identifier.
see: id field info

public int organRequestRank

description: the 'IPOS Organ Program' match organ request rank.

public WSLookup organRequestReason

description: the reason for the organ status.
see: LT_ORGAN_REQ_STATE_REASON

public WSLookup organRequestStatus

description: the Organ Request State of patient’s readiness to accept an organ offer.
see: LT_ORGAN_REQ_STATE

public WSLookup organRequired

description: the Organ requested for transplant.
see: LT_ORGAN

public List<WsRelatedOrganRequest> otherActiveRors

description: a list of the recipient's other active organ request.

public Boolean recipientAtThreshold

description: a flag indicating that the recipient's province is at threshold.

public WSFacility recipientTXCenter

description: the patient's transplant centre facility.
see: WSFacility

public WSLookup transplantType

description: the recipient's transplant type.

public WSLookup vxm

description: the allocation virtual cross match information.
note: this field applies only to IPOS Heart allocation results.
see: VXM

public String wtcCrossedAntigens

description: the antigens that were crossed during the allocation.
note: this field does not represent the antigens defined as Willing to Cross for the recipient.
see: A set of comma separated text fields, each representing an antibody crossed during the allocation, max L=1000

Public Constructors

public WsIPOSMatchResult ()