Recipient
extends Object| java.lang.Object | |
| ↳ | com.cbs.ctr3ws.dtos.recipient.Recipient |
Class Overview
description: the CTR Recipient data type.
see: The class is used only to output returned values.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public Boolean | InUtero | description: a flag indicating that the patient not yet born. | |||||||||
| public Boolean | KPDWithdrewConsent | description: a flag indicating that the recipient withdrew consent to participate in the KPD program. | |||||||||
| public String | address1 | description: the first Address of the patient. | |||||||||
| public String | address2 | description: the second Address of the patient. | |||||||||
| public Age | age | description: the recipient's age. | |||||||||
| public WSLookup | bloodGroup | description: the blood group of patient. | |||||||||
| public Double | bmi | description: the Body mass index of patient. | |||||||||
| public WSLookup | causeOfDeath | description: the patient cause of death. | |||||||||
| public String | causeOfDeathComments | description: the Cause of death comments. | |||||||||
| public String | city | description: the City associated to patient’s address where they can be contacted. | |||||||||
| public String | confirmBloodType | description: a flag confirming the blood type of patient. | |||||||||
| public String | confirmRh | description: a flag confirming RH of patient.. | |||||||||
| public Boolean | consentReceivedByCbs | description: a flag confirming the DWL consent received by cbs. | |||||||||
| public Date | dateOfBirth | description: the patient's date of birth. | |||||||||
| public Date | dateOfDeath | description: the date of death of patient. | |||||||||
| public Boolean | deathInHospital | description: a flag indicating patient death occurred in a hospital. | |||||||||
| public Boolean | donatedKidney | description: a flag indicating the recipient has previously donated a kidney. | |||||||||
| public String | duplicateOf | description: the CTR National ID that this record is a duplicate of. | |||||||||
| public List<String> | duplicates | description: list of duplicate nationalIDs. | |||||||||
| public Date | dwlRregistryConsentDate | description: the Dwl registry consent date. | |||||||||
| public WSLookup | ethnicity | description: the Ethnicity of the patient. | |||||||||
| public String | firstName | description: the first name of the patient. | |||||||||
| public String | formerLastName | description: the former last name of the patient. | |||||||||
| public WSLookup | gender | description: the gender of the patient. | |||||||||
| public BigDecimal | height | description: the height of patient. | |||||||||
| public WSFacility | hlaLab | description: the recipient's HLA lab facility. | |||||||||
| public long | id | description: the unique patient identifier. | |||||||||
| public Boolean | isOffListDuplicate | description: a flag indicating that the recipient is off list because the patient is a duplicate of another CTR patient. | |||||||||
| public Boolean | isOffListWithdrewConsent | description: a flag indicating that the recipient is off list because the consent to participate in the DWL program was withdrawn. | |||||||||
| public Date | kpdRegistryConsentDate | description: the Kpd registry consent date. | |||||||||
| public String | lastName | description: the patient's last name. | |||||||||
| public String | ldpeId | description: not used, the CTR1 - used to cross reference if patient is on both the LDPE and HSP registries. | |||||||||
| public String | localRecipientId | description: the unique local patient identifier provided by local Transplant Program OR ODO. | |||||||||
| public String | localRecipientSource | description: the source of local Recipient ID. | |||||||||
| public Boolean | locked | description: a flag indicating the patient has been locked in CTR. | |||||||||
| public String | middleName | description: the patient's middle name. | |||||||||
| public Date | mostRecentDialysisStartDate | description: the patient's most recent dialysis start date. | |||||||||
| public String | nationalRecipientId | description: the CTR2 patient ID. | |||||||||
| public Boolean | onDialysis | description: a flag indicating that the patient is on dialysis. | |||||||||
| public WSFacility | opo | description: the recipient's ODO facility. | |||||||||
| public List<RecipientOrganRequest> | organRequests | description: a list of the recipient's organ requests. | |||||||||
| public String | phin | description: the patient's Provincial Health Information Number. | |||||||||
| public WSLookup | phinProvince | description: the province or territory of the PHIN. | |||||||||
| public String | postCode | description: the patient's postal code. | |||||||||
| public Boolean | preEmptive | description: a flag indicating that the Kidney patient is 'preEmptive' and thus does need to be on dialysis to be eligible for the IPOS Kidney program. | |||||||||
| public WSLookup | province | description: the province or territory of residence. | |||||||||
| public WSLookup | provinceOfDeath | description: the Province patient of death. | |||||||||
| public List<WSFacility> | referralCenters | description: a list of the recipient's referral facilities. | |||||||||
| public Boolean | registeredOnLDPE | description: a ctr1 flag indicating that patient is on both the KPD and HSP registries. | |||||||||
| public Date | registryEnterDate | description: the date the patient was registered in CTR. | |||||||||
| public WSLookup | rh | description: the RH of patient. | |||||||||
| public Boolean | suddenDeath | description: a flag indicating patient sudden death. | |||||||||
| public int | timeOnDialysisInDays | description: the Time the patient has been on dialysis in days. | |||||||||
| public WSFacility | transplantCentre | description: the recipient's transplant centre facility. | |||||||||
| public WSLookup | transplantType | description: the Transplant type requested. | |||||||||
| public BigDecimal | weight | description: the weight of patient. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Recipient() | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public Boolean InUtero
description: a flag indicating that the patient not yet born.
public Boolean KPDWithdrewConsent
description: a flag indicating that the recipient withdrew consent to participate in the KPD program.
public String address1
description: the first Address of the patient.
see: free format text, max L=70
public String address2
description: the second Address of the patient.
see: free format text, max L=70
public Double bmi
description: the Body mass index of patient.
BMI = weight(kg)/ (height(m) * height(m))
see: system calculated value
public String causeOfDeathComments
description: the Cause of death comments.
public String city
description: the City associated to patient’s address where they can be contacted.
see: free format text, max L=70
public String confirmBloodType
description: a flag confirming the blood type of patient.
public String confirmRh
description: a flag confirming RH of patient..
public Boolean consentReceivedByCbs
description: a flag confirming the DWL consent received by cbs.
public Boolean deathInHospital
description: a flag indicating patient death occurred in a hospital.
public Boolean donatedKidney
description: a flag indicating the recipient has previously donated a kidney.
public String duplicateOf
description: the CTR National ID that this record is a duplicate of. The "duplicate of" is the link between a secondary record (offlist) and the primary record.
see: nationalId info
public List<String> duplicates
description: list of duplicate nationalIDs. Duplicate is the reverse link to "duplicatesOf". It exists in the primary record to indicate secondary records which are no longer used.
There may be multiple duplicate records referred to in a primary record, but all of them should not be "active".
public Date dwlRregistryConsentDate
description: the Dwl registry consent date.
see: system set value.
see: date info
public String formerLastName
description: the former last name of the patient.
see: free format text, max L=200
public Boolean isOffListDuplicate
description: a flag indicating that the recipient is off list because the patient is a duplicate of another CTR patient.
public Boolean isOffListWithdrewConsent
description: a flag indicating that the recipient is off list because the consent to participate in the DWL program was withdrawn.
public Date kpdRegistryConsentDate
description: the Kpd registry consent date.
see: system set value.
see: date info
public String ldpeId
description: not used, the CTR1 - used to cross reference if patient is on both the LDPE and HSP registries.
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 localRecipientSource
description: the source of local Recipient ID.
see: free format text, max L=200
public Boolean locked
description: a flag indicating the patient has been locked in CTR.
see: system set value.
public Date mostRecentDialysisStartDate
description: the patient's most recent dialysis start date.
see: date info
public Boolean onDialysis
description: a flag indicating that the patient is on dialysis.
public List<RecipientOrganRequest> organRequests
description: a list of the recipient's organ requests.
see: RecipientOrganRequest
public String phin
description: the patient's Provincial Health Information Number.
see: free format text, max L=50
public Boolean preEmptive
description: a flag indicating that the Kidney patient is 'preEmptive' and thus does need to be on dialysis to be eligible for the IPOS Kidney program.
note: The preEmptive data element may only be True when the onDialysis data element is False. When the onDialysis is True, the preEmptive data element may be Null/Empty or False.
required: FALSE
public List<WSFacility> referralCenters
description: a list of the recipient's referral facilities.
see: WSFacility
public Boolean registeredOnLDPE
description: a ctr1 flag indicating that patient is on both the KPD and HSP registries.
see: system set value.
public Date registryEnterDate
description: the date the patient was registered in CTR.
see: system set value.
see: date info
public Boolean suddenDeath
description: a flag indicating patient sudden death.
public int timeOnDialysisInDays
description: the Time the patient has been on dialysis in days.
see: system calculated value
- Calculation based on the transplant date and most recent dialysis start date ( excluding current date )
- Recalculated when either transplant date or most recent dialysis start date ischanged ( 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 ).
public WSFacility transplantCentre
description: the recipient's transplant centre facility.
see: WSFacility