Summary: Methods | [Expand All]
public interface

IExternalOffers

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

Class Overview

description: the interface contains the CTR2-DWL-Offer soap webservices.

Summary

Public Methods
abstract WSOfferCore acceptOffer(long offerID, Date offerAcceptDate, String receivingODODonorId, Boolean sendAlerts)
Accept a DWL organ offer.
abstract List<WSOfferCore> findDonorOffers(String nationalDonorId, List<WSLookup> offerStates)
Find a donor's offers, the output can be filtered based on offer state.
abstract List<WSOfferCore> findRecipientOffers(String nationalRecipientId, List<WSLookup> offerStates)
Find a recipient's offers or ODO incoming offers.
abstract List<WSTransplantCore> findRecipientTransplants(String nationalRecipientID)
Find a recipient's transplant records.
abstract WsDonorSideInfo getOfferDonorInfo(Long offerID, String nationalDonorId)
Gets an offer's donor information.
abstract WsDonorSideInfo getOfferDonorInfoV2(Long offerId, String nationalDonorId, String dateOfBirth)
Retrieves donor information based on the provided national donor ID, offer ID and donor date of birth.
abstract List<WsOfferState> getOfferStateHistory(String nationalDonorId, Long offerId)
Get a list offer state histories or alternatively offer state history of a specific offer.
abstract WSOfferCore makeHshOffer(String nationalId, long hshMatchResultID, Date offerDate, Boolean sendAlerts)
Make an IPOS Heart offer to a recipient.
abstract WSOfferCore makeOfferAgainstHSPMatch(String nationalId, long hspMatchResultID, WSLookup donorOrganType, Date offerDate, Boolean sendAlerts)
Make an "IPOS Kidney" offer to a recipient.
abstract WSTransplantCore updateHSPTransplant(WSTransplantInput input)
Add or update an organ transplantation record.
abstract WsNotTransplantInfo updateNotTransplanted(WsNotTransplantInfo wsNotTransplantInfo)
Add or update an organ Non-transplantation record.
abstract WSOfferCore updateOfferState(long offerID, WSLookup wsOfferState, Date stateChangedDate, List<WSLookup> wsOfferStateReasons, String receivingODODonorId, Boolean sendAlerts)
Update the state of an offer.
abstract List<WsOfferState> updateOfferStateHistory(Long offerId, WSLookup offerState, Date stateChangeDate, List<WSLookup> offerStateReasons)
Update the offer state history of a specific offer.

Public Methods

public abstract WSOfferCore acceptOffer (long offerID, Date offerAcceptDate, String receivingODODonorId, Boolean sendAlerts)

Accept a DWL organ offer.

Sample soap requests: acceptOffer

Parameters
offerID the unique DWL offer identifier.
required: TRUE
see: id field info
offerAcceptDate the date and time the offer was accepted.
required: FALSE - defaults to the current system date/time.
see: NowOrPastDateForOffers
receivingODODonorId the unique identifier given by the receiving ODO to the organ donor.
required: FALSE
see: free format text, max L=25
sendAlerts a flag indicating if alerts should sent.
required: FALSE - defaults to FALSE.
Returns
Throws
SoapException

public abstract List<WSOfferCore> findDonorOffers (String nationalDonorId, List<WSLookup> offerStates)

Find a donor's offers, the output can be filtered based on offer state.

Sample soap requests: findDonorOffers

Parameters
nationalDonorId the CTR2 patient ID.
required: TRUE
see: nationalId info
offerStates the output filter: a list of offer states to include in output required: FALSE
see: LT_OFFER_STATE_DWL
Returns
Throws
SoapException

public abstract List<WSOfferCore> findRecipientOffers (String nationalRecipientId, List<WSLookup> offerStates)

Find a recipient's offers or ODO incoming offers.
Note: the offer list response can be filtered by a list of offer states.

Sample soap requests: findRecipientOffers

Parameters
nationalRecipientId the CTR2 patient ID.
required: FALSE
  • If '@param nationalRecipientId' IS NOT null: the response will contain only the offers for the specified recipient (if any exist) see: nationalId info
  • Else '@param nationalRecipientId' IS null: the response will contain the offers made to recipients of the user's ODO (if any exist)
    • offerStates the output filter: if set, the response is filtered to only have offers with these states
    required: FALSE
    see: LT_OFFER_STATE_DWL
    Returns
    Throws
    SoapException

    public abstract List<WSTransplantCore> findRecipientTransplants (String nationalRecipientID)

    Find a recipient's transplant records.

    Sample soap requests: findRecipientTransplants

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

    public abstract WsDonorSideInfo getOfferDonorInfo (Long offerID, String nationalDonorId)

    Gets an offer's donor information.
    The method response differs depending on the input arguments:

    • Case 1: when the CTR user making the soap request has permissions to the donor offers
      • a) when input offerID is not NULL and valid: the response will contain only information for the specified DWL offer
      • b) when nationalDonorId is not NULL and valid: the response will contain a list information for all DWL offers from the specified CTR donor.
    • Case 2: when the CTR user making the soap request has permissions to the recipient offers
      • a) when input offerID is not NULL and valid: the response will contain only information for the specified DWL offer
      • b) when nationalDonorId is not NULL and valid: the response will contain a list information for all DWL offers from the specified CTR donor to the recipient ODO.
    Sample soap requests: getOfferDonorInfo

    Parameters
    offerID the unique offer identifier.
    required: TRUE-if -required if input arg1 "nationalDonorId" = NULL or is empty.
    see: id field info
    • when offerID is not NULL, it must reference a valid offer (the value = 0 will cause an error)
      nationalDonorId the CTR2 patient ID.
      required: TRUE-if -required if input arg0 "offerID" = NULL.
      see: nationalId info
      • when nationalDonorId is not NULL, it must reference a valid CTR donor
        Returns
        Throws
        SoapException

        public abstract WsDonorSideInfo getOfferDonorInfoV2 (Long offerId, String nationalDonorId, String dateOfBirth)

        Retrieves donor information based on the provided national donor ID, offer ID and donor date of birth. Gets an offer's donor information.
        The method response differs depending on the input arguments:

        • Case 1: when the CTR user making the soap request has permissions to the donor offers
          • a) when input offerID is not NULL and valid: the response will contain only information for the specified DWL offer
          • b) when nationalDonorId is not NULL and valid: the response will contain a list information for all DWL offers from the specified CTR donor.
        • Case 2: when the CTR user making the soap request has permissions to the recipient offers
          • a) when input offerID is not NULL and valid: the response will contain only information for the specified DWL offer
          • b) when nationalDonorId is not NULL and valid: the response will contain a list information for all DWL offers from the specified CTR donor to the recipient ODO.
        Sample soap requests: getOfferDonorInfoV2

        Parameters
        offerId the unique offer identifier.
        required: TRUE-if -required if input arg1 "nationalDonorId" = NULL or is empty.
        see: id field info
        • when offerID is not NULL, it must reference a valid offer (the value = 0 will cause an error)
          nationalDonorId the CTR2 patient ID.
          required: TRUE-if -required if input arg0 "offerID" = NULL.
          see: nationalId info
          • when nationalDonorId is not NULL, it must reference a valid CTR donor
            dateOfBirth the donor's date of birth (Format: YYYY-MM-DD). If provided, it is validated against the donor's record.
            Returns
            • a`WsDonorSideInfo` object containing the donor's information and associated offers.the organ donor information.
              WsDonorSideInfo
            Throws
            SoapException

            public abstract List<WsOfferState> getOfferStateHistory (String nationalDonorId, Long offerId)

            Get a list offer state histories or alternatively offer state history of a specific offer.

            Sample soap requests: getOfferStateHistory

            Parameters
            nationalDonorId the CTR2 patient ID.
            required: TRUE
            see: nationalId info
            offerId the unique offer identifier.
            required: TRUE
            see: id field info
            Returns
            Throws
            SoapException

            public abstract WSOfferCore makeHshOffer (String nationalId, long hshMatchResultID, Date offerDate, Boolean sendAlerts)

            Make an IPOS Heart offer to a recipient.

            Sample soap requests: makeHshOffer

            Parameters
            nationalId the CTR2 patient(donor) ID.
            required: TRUE
            see: nationalId info
            hshMatchResultID the unique "IPOS Heart" match identifier.
            required: TRUE
            see: id field info
            offerDate the offer date-time.
            required: FALSE - defaults to the current system date/time.
            see: NowOrAllocationDate
            sendAlerts a flag indicating if alerts are to be sent.
            required: FALSE - defaults to TRUE.

            Note: the "sendAlerts" value is intended to be set to TRUE or set to its default value.
            Setting "sendAlerts" to FALSE will prevent the application from sending notifications to recipient facilities who may be receiving an offer or receiving a notification of an offer action.
            Only in limited situations – for example, when testing – should the "sendAlerts" value be set to False.
            Returns
            Throws
            SoapException

            public abstract WSOfferCore makeOfferAgainstHSPMatch (String nationalId, long hspMatchResultID, WSLookup donorOrganType, Date offerDate, Boolean sendAlerts)

            Make an "IPOS Kidney" offer to a recipient.

            Sample soap requests: makeOfferAgainstHSPMatch

            Parameters
            nationalId the CTR2 patient(donor) ID.
            required: TRUE
            see: nationalId info
            hspMatchResultID the unique "IPOS Kidney" required: TRUE
            see: id field info
            donorOrganType the consented donor organ type.
            required: FALSE - defaults to [id: 7 , bizRef: RIGHT_KIDNEY]
            see: LT_DONOR_ORGAN_TYPE
            offerDate the offer date-time.
            required: FALSE - defaults to the current system date/time.
            see: NowOrAllocationDate
            sendAlerts a flag indicating if alerts are to be sent.
            required: FALSE - defaults to TRUE.

            Note: the "sendAlerts" value is intended to be set to TRUE or set to its default value.
            Setting "sendAlerts" to FALSE will prevent the application from sending notifications to recipient facilities who may be receiving an offer or receiving a notification of an offer action.
            Only in limited situations – for example, when testing – should the "sendAlerts" value be set to False.
            Returns
            Throws
            SoapException

            public abstract WSTransplantCore updateHSPTransplant (WSTransplantInput input)

            Add or update an organ transplantation record.
            note: this method only supports donor organ-types for kidney(s) and heart, any other organ-types will return an error

            Sample soap requests: updateHSPTransplant

            Parameters
            input the transplant information.
            required: TRUE
            see:WSTransplantInput
            Returns
            Throws
            SoapException

            public abstract WsNotTransplantInfo updateNotTransplanted (WsNotTransplantInfo wsNotTransplantInfo)

            Add or update an organ Non-transplantation record.

            Sample soap requests: updateNotTransplanted

            Parameters
            wsNotTransplantInfo the not transplant organ information.
            required: TRUE
            WsNotTransplantInfo
            Returns
            Throws
            SoapException

            public abstract WSOfferCore updateOfferState (long offerID, WSLookup wsOfferState, Date stateChangedDate, List<WSLookup> wsOfferStateReasons, String receivingODODonorId, Boolean sendAlerts)

            Update the state of an offer.

            Sample soap requests: updateOfferState

            Parameters
            offerID the unique DWL offer identifier.
            required: TRUE
            see: id field info
            wsOfferState the state to which the DWL offer is being updated.
            required: TRUE
            see: LT_OFFER_STATE_DWL
            stateChangedDate the date and time the offer state was changed.
            required: FALSE - defaults to the current system date/time.
            see: NowOrPastDateForOffers
            wsOfferStateReasons description: a list of offer state reasons.
            required: TRUE-if - required if the updated offer state is DECLINED or WITHDRAWN or CANCELLED_ACCEPTANCE
            see: LT_OFFER_STATE_REASON_DWL
            receivingODODonorId the unique identifier given by the receiving ODO to the organ donor.
            required: FALSE
            see: free format text, max L=25
            sendAlerts a flag indicating if alerts should sent.
            required: FALSE - defaults to FALSE.
            Returns
            Throws
            SoapException

            public abstract List<WsOfferState> updateOfferStateHistory (Long offerId, WSLookup offerState, Date stateChangeDate, List<WSLookup> offerStateReasons)

            Update the offer state history of a specific offer.

            Sample soap requests: updateOfferStateHistory

            Parameters
            offerId the unique offer identifier.
            required: TRUE
            see: id field info
            offerState the offer state to update.
            required: TRUE
            see: LT_OFFER_STATE_DWL
            stateChangeDate the offer state change date-time.
            required: TRUE-if - required if input param "offerStateReasons" is NULL or empty.
            see: NowOrPastDateForOffers
            offerStateReasons a list offer state reason.
            required: TRUE-if - required if input param "stateChangeDate" is NULL.
            see: LT_OFFER_STATE_REASON_DWL
            Returns
            Throws
            SoapException