WebServiceRecipient
extends Objectimplements Serializable
| java.lang.Object | |
| ↳ | com.cbs.ctr3ws.dtos.recipient.WebServiceRecipient |
Class Overview
description: the class contains the recipient information.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public String | address1 | description: the first Address of the patient. | |||||||||
| public String | address2 | description: the second Address of the patient. | |||||||||
| public WSLookup | bloodGroup | description: the blood group of patient. | |||||||||
| public BigDecimal | 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 Boolean | consentReceivedByCbs | description: a flag confirming the DWL consent received by cbs. | |||||||||
| public Calendar | dateOfBirth | description: the patient's date of birth. | |||||||||
| public Calendar | 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 Date | dwlRegistryConsentDate | 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 | inUtero | description: a flag indicating that the patient not yet born. | |||||||||
| public Boolean | isLocked | description: a flag indicating the patient has been locked in CTR. | |||||||||
| public Date | kpdRegistryConsentDate | description: the Kpd registry consent date. | |||||||||
| public String | lastName | description: the patient's last name. | |||||||||
| public Date | lastUpdated | description: the date/time the organ request was "last updated". | |||||||||
| public String | ldpeId | description: not used, deprecated field: CTR1 used this field 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 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> | referralCentres | 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 resgistered in CTR. | |||||||||
| public WSLookup | rh | description: the RH of patient. | |||||||||
| public Boolean | suddenDeath | description: a flag indicating patient sudden death. | |||||||||
| public Integer | 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. | |||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public String address1
description: the first Address of the patient.
required:FALSE
see: free format text, max L=70
public String address2
description: the second Address of the patient.
required:FALSE
see: free format text, max L=70
public BigDecimal bmi
description: the Body mass index of patient.
BMI = weight(kg)/ (height(m) * height(m))
required:FALSE
see: system calculated value
public WSLookup causeOfDeath
description: the patient cause of death.
required:TRUE-if - Required if "dateOfDeath" field is not NULL
see: LT_CAUSE_OF_DEATH
public String causeOfDeathComments
description: the Cause of death comments.
required:FALSE
public String city
description: the City associated to patient’s address where they can be contacted.
required:TRUE
see: free format text, max L=70
public Boolean consentReceivedByCbs
description: a flag confirming the DWL consent received by cbs.
required: FALSE
see: system set value.
public Calendar dateOfBirth
description: the patient's date of birth.
required:TRUE
see: Date format
public Calendar dateOfDeath
description: the date of death of patient.
required:FALSE
see: Date format
public Boolean deathInHospital
description: a flag indicating patient death occurred in a hospital.
required:FALSE
public Boolean donatedKidney
description: a flag indicating the recipient has previously donated a kidney.
required:FALSE
public Date dwlRegistryConsentDate
description: the Dwl registry consent date.
required: FALSE
see: NowOrPastDate
public WSLookup ethnicity
description: the Ethnicity of the patient.
required:FALSE
see: LT_ETHNICITY
public String firstName
description: the first name of the patient.
required: TRUE
see: free format text, max L=70
public String formerLastName
description: the former last name of the patient.
required:FALSE
see: free format text, max L=200
public WSFacility hlaLab
description: the recipient's HLA lab facility.
required: TRUE
see: WSFacility
public Long id
description: the unique patient identifier.
required:FALSE
see: the field is "output only".
see: patientId field info
public Boolean inUtero
description: a flag indicating that the patient not yet born.
required: FALSE - default to: false
public Boolean isLocked
description: a flag indicating the patient has been locked in CTR.
required: FALSE
see: system set value.
public Date kpdRegistryConsentDate
description: the Kpd registry consent date.
required: FALSE
see: NowOrPastDate
public String lastName
description: the patient's last name.
required: TRUE
see: free format text, max L=200
public Date lastUpdated
description: the date/time the organ request was "last updated".
public String ldpeId
description: not used, deprecated field: CTR1 used this field to cross reference if patient is on both the LDPE and HSP registries.
required: FALSE
public String localRecipientId
description: the unique local patient identifier provided by local Transplant Program OR ODO.
required:FALSE
see: free format text, max L=100
public String localRecipientSource
description: the source of local Recipient ID.
required:TRUE-if - Required if "localRecipientId" field is not NULL
see: free format text, max L=200
public String middleName
description: the patient's middle name.
required:FALSE
see: free format text, max L=200
public Date mostRecentDialysisStartDate
description: the patient's most recent dialysis start date.
required: FALSE
see: date info
public String nationalRecipientId
description: the CTR2 patient ID.
required:FALSE
see: the field is "output only".
see: nationalId info
public Boolean onDialysis
description: a flag indicating that the patient is on dialysis.
required: FALSE
public List<RecipientOrganRequest> organRequests
description: a list of the recipient's organ requests.
required: TRUE
see: RecipientOrganRequest
public String phin
description: the patient's Provincial Health Information Number.
required:FALSE
see: free format text, max L=50
public WSLookup phinProvince
description: the province or territory of the PHIN.
required:TRUE-if - Required if "phin" field is not NULL
see: LT_PROVINCE
public String postCode
description: the patient's postal code.
required:FALSE
see: free format text, max L=10
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 WSLookup province
description: the province or territory of residence.
required:TRUE
see: LT_PROVINCE
public WSLookup provinceOfDeath
description: the Province patient of death.
required:FALSE
see: LT_PROVINCE
public List<WSFacility> referralCentres
description: a list of the recipient's referral facilities.
required: FALSE
see: WSFacility
public Boolean registeredOnLDPE
description: a ctr1 flag indicating that patient is on both the KPD and HSP registries.
required: FALSE
see: system set value.
public Date registryEnterDate
description: the date the patient was resgistered in CTR.
required: FALSE
see: system set value.
see: date info
public Boolean suddenDeath
description: a flag indicating patient sudden death.
required:FALSE
note: not applicable to new recipent.
public Integer timeOnDialysisInDays
description: the Time the patient has been on dialysis in days.
required: FALSE
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.
required: TRUE
see: WSFacility
public WSLookup transplantType
description: the Transplant type requested.
required: TRUE
see: LT_TRANSPLANT_TYPE