Summary:
Methods
| [Expand All]
public
interface
IExternalRecipient
| com.cbs.ctr3ws.iservices.IExternalRecipient |
 Known Indirect Subclasses
|
Class Overview
description: the interface contains the CTR2-Recipient soap webservices.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Recipient |
addRecipientByNationalRecipientId(WebServiceRecipient wsRecipient)
This method provides the ability to create a new record for patient type = recipient and organ request(s) for program = DWL, KPD, or DWL and KPD.
| ||||||||||
| abstract List<RecipientAcceptanceCriteria> |
findRecipientAcceptanceCriteriaByNationalRecipientId(String nationalID)
Find the acceptance criteria information for each recipient organ request.
| ||||||||||
| abstract Recipient |
findRecipientByNationalRecipientID(String nationalID)
Find a recipient information.
| ||||||||||
| abstract WsSocialDetails |
getSocialDetails(String nationalId)
Get the recipient's social details record.
| ||||||||||
| abstract WsPgmExclusion |
updateOrganRequestParticipation(String nationalRecipientId, Long organRequestId, boolean preventProgramParticipation)
Update a recipient's participation to the IPOS Heart program.
| ||||||||||
| abstract RecipientAcceptanceCriteria |
updateRecipientAcceptanceCriteriaByNationalRecipientId(String nationalID, WSRecipientAcceptanceCriteria updatedCriteria)
Update a recipient's organ request acceptance criteria record.
| ||||||||||
| abstract Recipient |
updateRecipientByNationalRecipientId(String nationalID, WebServiceRecipient wsRecipient)
This method provides the ability to modify an existing record for patient type = recipient and organ request(s) for program=DWL, KPD, or DWL and KPD.
| ||||||||||
| abstract WsSocialDetails |
updateSocialDetails(String nationalId, WsSocialDetails wsInput)
Update a recipient's social details record.
| ||||||||||
Public Methods
public abstract Recipient addRecipientByNationalRecipientId (WebServiceRecipient wsRecipient)
This method provides the ability to create a new record for patient type = recipient and organ request(s) for program = DWL, KPD, or DWL and KPD.
note: For a recipient with a KPD organ request, the organ request state can only be "new" and recipient type will default to registered pair.
Sample soap requests: addRecipientByNationalRecipientId
Parameters
| wsRecipient | the recipient information. required: TRUE see: WebServiceRecipientnote: KPD kidney organ request status must be "NEW" and cannot be changed in this method. |
|---|
Returns
- the recipient record that was added to the registry.
see:Recipient
Throws
| SoapException | the soap exception |
|---|
public abstract List<RecipientAcceptanceCriteria> findRecipientAcceptanceCriteriaByNationalRecipientId (String nationalID)
Find the acceptance criteria information for each recipient organ request.
Sample soap requests: findRecipientAcceptanceCriteriaByNationalRecipientId
Parameters
| nationalID | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|
Returns
- a list of acceptance criteria records.
see:RecipientAcceptanceCriteria
Throws
| SoapException | the soap exception |
|---|
public abstract Recipient findRecipientByNationalRecipientID (String nationalID)
Find a recipient information.
Sample soap requests: findRecipientByNationalRecipientID
Parameters
| nationalID | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|
Returns
- the recipient record.
see:Recipient
Throws
| SoapException | the soap exception |
|---|
public abstract WsSocialDetails getSocialDetails (String nationalId)
Get the recipient's social details record.
Sample soap requests: getSocialDetails
Parameters
| nationalId | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|
Returns
- the recipient's social details record.
see:WsSocialDetails
Throws
| SoapException | the soap exception |
|---|
public abstract WsPgmExclusion updateOrganRequestParticipation (String nationalRecipientId, Long organRequestId, boolean preventProgramParticipation)
Update a recipient's participation to the IPOS Heart program.
note:
- The exclusion or reinstatement applies to a specific DWL organ request.
- When an organ request is excluded from an IPOS program, it's IPOS program 'Eligibility' is set to FALSE.
The only exception to this rule, is when a heart organ request with a medical state of 'HEART 4', in this case the organ request 'Eligibility' will remain as TRUE.
Sample soap requests: updateOrganRequestParticipation
Parameters
| nationalRecipientId | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|---|
| organRequestId | the unique identifier of the organ request that is to be excluded or included from the IPOs program. required: TRUE see: id field info |
| preventProgramParticipation | a flag indicating that the organ request is to be excluded or included from the IPOs program. required: FALSE, when absent default to FALSE. |
Returns
- the updated organ request.
WsPgmExclusion
Throws
| SoapException | the soap exception |
|---|
public abstract RecipientAcceptanceCriteria updateRecipientAcceptanceCriteriaByNationalRecipientId (String nationalID, WSRecipientAcceptanceCriteria updatedCriteria)
Update a recipient's organ request acceptance criteria record.
note: The method does not add an organ request acceptance criteria record, since a unique organ request acceptance criteria record is automatically created when an organ request is created.
Sample soap requests: updateRecipientAcceptanceCriteriaByNationalRecipientId
Parameters
| nationalID | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|---|
| updatedCriteria | the organ request acceptance criteria information. required: TRUE see: WSRecipientAcceptanceCriterianote: acceptance criteria that are not included in the input will be reset to their default (boolean) or set to null (decimal fields/waitlist comment), depending on Type. |
Returns
- the updated recipient's organ request acceptance criteria record.
RecipientAcceptanceCriteria
Throws
| SoapException | the soap exception |
|---|
public abstract Recipient updateRecipientByNationalRecipientId (String nationalID, WebServiceRecipient wsRecipient)
This method provides the ability to modify an existing record for patient type = recipient and organ request(s) for program=DWL, KPD, or DWL and KPD.
It only supports the common patient fields as defined in webServiceRecipient. All other KPD fields must be updated in the UI.
Sample soap requests: updateRecipientByNationalRecipientId
Parameters
| nationalID | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|---|
| wsRecipient | the recipient information. required: TRUE see: WebServiceRecipientnote: - Can only update KPD organ request with Recipient type = registered pair. - Can only add KPD organ request state = new and recipient type will default to registered pair. - Cannot update KPD organ request state. - If PHN is being removed (set to null), other government id will default to yes and "Not Available": |
Returns
- the updated recipient record.
see:Recipient
Throws
| SoapException | the soap exception |
|---|
public abstract WsSocialDetails updateSocialDetails (String nationalId, WsSocialDetails wsInput)
Update a recipient's social details record.
note: A recipient can have only 1 entry for each social detail item.
For example, it is not possible to have 2 "ltAcademicProgress" entries.
If a specific item already exists and the one attempts to add 2nd entry, the existing item entry will be updated.
Sample soap requests: updateSocialDetails
Parameters
| nationalId | the CTR2 patient ID. required: TRUE see: nationalId info |
|---|---|
| wsInput | the added/social details record. required: TRUE see: WsSocialDetails |
Returns
- the recipient's updated social details record.
see:WsSocialDetails
Throws
| SoapException | the soap exception |
|---|