RecipientOrganRequest
extends Object| java.lang.Object | |
| ↳ | com.cbs.ctr3ws.dtos.recipient.RecipientOrganRequest |
Class Overview
description: the Recipient organ request type.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public WSLookup | RecipientType | description: the recipient type. | |||||||||
| public Boolean | dwlEligible | description: a flag indicating whether organ request is eligible for the IPOS DWL organ program. | |||||||||
| public Long | id | description: the unique organ request identifier. | |||||||||
| public Date | listDateTime | description: the date/time when DWL recipient organ request listed in CTR. | |||||||||
| public String | localOrganRequestID | description: the organ request id on the local system. | |||||||||
| public Date | medicalStatusChangeDate | description: the date/time the organ medical status was updated in registry. | |||||||||
| public WSLookup | organMedicalStatus | description: the organ medical status. | |||||||||
| public WSLookup | organRequired | description: the required organ. | |||||||||
| public Date | organStatusChangeDate | description: the date/time the organ request status was updated in registry. | |||||||||
| public WSLookup | organTypeRequired | description: the required organ type. | |||||||||
| public WSLookup | program | description: the CTR Program that will enable a patient to get an organ transplant. | |||||||||
| public WSLookup | reason | description: the reason for the organ state. | |||||||||
| public String | reasonComment | description: the comment that is required for some reason codes. | |||||||||
| public WSLookup | status | description: the status (also referred to as: state) of recipient’s readiness to accept an offer. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
RecipientOrganRequest()
Instantiates a new recipient organ request.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public WSLookup RecipientType
description: the recipient type.
required: FALSE - when input, field value is ignored
default to:
-for a KPD organ request, defaults to "REGISTERED_PAIR"
-for a DWL organ request, defaults to "NULL"
see: LT_ORGAN_REQUEST_TYPE
public Boolean dwlEligible
description: a flag indicating whether organ request is eligible for the IPOS DWL organ program.
public Date listDateTime
description: the date/time when DWL recipient organ request listed in CTR.
required: TRUE if - state is: ACTIVE, ON_HOLD or OFFLIST
note:
⦁ not required when state is: REFERRAL(new)
≤ current date/time
≥ (date of birth - 1 year)
≤ Medical Status Change Date/Time
public String localOrganRequestID
description: the organ request id on the local system.
required: FALSE
note: ≤ 100 characters
public Date medicalStatusChangeDate
description: the date/time the organ medical status was updated in registry.
required: FALSE
For new ROR - if not provided then defaults to current date/time.
For new/update ROR - if > current date/time, defaults to current date/time.
note:
≤ current date
>= List Date Time
public WSLookup organMedicalStatus
description: the organ medical status.
required: TRUE
see: LT_MEDICAL_STATUS
note: not required in following conditions
⦁ ADD organ request: for organ (kidney, pancreas, stomach) and state (new, offlist, active) then if medical status not specified the WS code defaults to (KIDNEY_1, PANCREAS_NORMAL,
STOMACH_NORMAL).
⦁ UPDATE organ request: medical status not required on input unless updating.
⦁ For any organ, if state set to ON_HOLD THEN set medical status = 0.
public Date organStatusChangeDate
description: the date/time the organ request status was updated in registry.
required: FALSE - when nput field value is ignored.
public WSLookup organTypeRequired
description: the required organ type.
see: LT_RECIPIENT_ORGAN_TYPE
public WSLookup program
description: the CTR Program that will enable a patient to get an organ transplant.
required: FALSE - default to: DECEASED_WAITLIST
see: LT_PROGRAM
public WSLookup reason
description: the reason for the organ state.
required: TRUE-if - the organ request state (field: "status") may require a reason.
see: LT_ORGAN_REQ_STATE_REASON
public String reasonComment
description: the comment that is required for some reason codes.
required: TRUE-if - the organ request state reason (field: "reason") may require an additional comment.
note:
input STATE=NEW then default REASON = NEW_ORGAN_REQUEST
input PROGRAM = DWL AND STATE=ACTIVE then default REASON =ACTIVE_RECIPIENT_ON_WAITLIST
public WSLookup status
description: the status (also referred to as: state) of recipient’s readiness to accept an offer.
required: TRUE
see: LT_ORGAN_REQ_STATE
note: If Status (state) = On Hold then MedicalStatus is set to 0.
Public Constructors
public RecipientOrganRequest ()
Instantiates a new recipient organ request.