Summary: Methods | [Expand All]
public interface

IExternalHealth

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

Class Overview

description: the interface contains the CTR2-patient Health soap webservices.

Summary

Public Methods
abstract List<WsCardioThoracic> getCardioThoracicProfiles(String nationalId)
Get a recipient's cardio thoracic profiles.
abstract WsDonorHealth getDonorHealth(String nationalId)
Gets a donor's health records.
abstract List<WsDonorMedications> getDonorMedications(String nationalId)
Gets the DWL donor medications.
abstract List<WsUrinalysis> getDonorUrinalysis(String nationalId)
Get a donor's urinalyses.
abstract WsMedicalHistory getMedicalHistory(String nationalId)
Gets the recipient medical history.
abstract List<WsPatientAbdominalProfile> getPatientAbdominalProfiles(String nationalId)
Gets a donor's abdominal profiles.
abstract List<WsPatientBloodGases> getPatientBloodGases(String nationalId)
Get a donor's blood gases records.
abstract List<WsChemistry> getPatientChemistry(String nationalId)
Get a patient's(donor/recipient) chemistry records.
abstract List<WsElectrolytes> getPatientElectrolytes(String nationalId)
Get a patient's(donor/recipient) electrolytes records.
abstract List<WsHeartProfile> getPatientHeartProfiles(String nationalId)
Get a donor's heart profiles.
abstract List<WsHematology> getPatientHematologies(String nationalId)
Get a patient's(donor/recipient) hematology records.
abstract List<WsInfection> getPatientInfections(String nationalId)
Gets a recipient's infections.
abstract List<WsLungProfile> getPatientLungProfile(String nationalId)
Get donor's lung profiles.
abstract List<WsMalignancy> getPatientMalignancies(String nationalId)
Gets a recipient's malignancies.
abstract List<WsMedSocialHistRisk> getPatientMedicalSocialHistory(String nationalId)
Gets the DWL donor's medical social history record.
abstract List<WsVitalSigns> getPatientVitalSigns(String nationalId)
Get a patient's(donor/recipient) vital signs records.
abstract WsRecipientHealth getRecipientHealth(String nationalId)
Gets a recipient's health records.
abstract List<WsRecipientMedications> getRecipientMedications(String nationalId)
Gets a recipient's medications.
abstract List<WsRenalProfile> getRenalProfiles(String nationalId)
Get a recipient's renal profiles.
abstract WsCardioThoracic updateCardioThoracicProfile(String nationalId, WsCardioThoracic wsInput)
Add or update a recipient's cardio thoracic profile.
abstract WsDonorMedications updateDonorMedications(String nationalId, WsDonorMedications wsInput)
Add or update a donor medication record.
abstract WsUrinalysis updateDonorUrinalysis(String nationalId, WsUrinalysis wsInput)
Add or update a donor's urinalysis record.
abstract WsMedicalHistory updateMedicalHistory(String nationalId, WsMedicalHistory wsInput)
Update the recipient medical history.
abstract WsPatientAbdominalProfile updatePatientAbdominalProfile(String nationalId, WsPatientAbdominalProfile wsInput)
Add or update a donor's abdominal profile.
abstract WsPatientBloodGases updatePatientBloodGases(String nationalId, WsPatientBloodGases wsInput)
Add or update a donor's blood gases record.
abstract WsChemistry updatePatientChemistry(String nationalId, WsChemistry wsInput)
Add or update a patient's(donor/recipient) chemistry record.
abstract WsElectrolytes updatePatientElectrolytes(String nationalId, WsElectrolytes wsInput)
Add or update a patient's(donor/recipient) electrolytes record.
abstract WsHeartProfile updatePatientHeartProfile(String nationalId, WsHeartProfile wsInput)
Add or update a donor's heart profile.
abstract WsHematology updatePatientHematology(String nationalId, WsHematology wsInput)
Add or update a patient's(donor/recipient) hematology record.
abstract WsInfection updatePatientInfections(String nationalId, WsInfection wsInput)
Add or update a recipient infections record.
abstract WsLungProfile updatePatientLungProfile(String nationalId, WsLungProfile wsInput)
Add or update a donor's lung profile.
abstract WsMalignancy updatePatientMalignancies(String nationalId, WsMalignancy wsInput)
Add or update a recipient malignancy record.
abstract WsMedSocialHistRisk updatePatientMedicalSocialHistory(String nationalId, WsMedSocialHistRisk wsInput)
Add or update a DWL donor's medical social history record.
abstract WsVitalSigns updatePatientVitalSigns(String nationalId, WsVitalSigns wsInput)
Add or update a patient's(donor/recipient) vital signs record.
abstract WsRecipientMedications updateRecipientMedications(String nationalId, WsRecipientMedications wsInput)
Add or update a recipient medications record.
abstract WsRenalProfile updateRenalProfile(String nationalId, WsRenalProfileInput wsInput)
Add or update a recipient's renal profile.

Public Methods

public abstract List<WsCardioThoracic> getCardioThoracicProfiles (String nationalId)

Get a recipient's cardio thoracic profiles.

Sample soap requests: cardio-thoracic profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of cardio thoracic profiles
Throws
SoapException the soap exception

public abstract WsDonorHealth getDonorHealth (String nationalId)

Gets a donor's health records.

Sample soap requests: donor Health

Parameters
nationalId the CTR2 donor ID.
required: TRUE
see: nationalId info
Returns
  • the list of donor health records
Throws
SoapException the soap exception

public abstract List<WsDonorMedications> getDonorMedications (String nationalId)

Gets the DWL donor medications.

Sample soap requests: donor Medications

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of donor medications.
Throws
SoapException the soap exception

public abstract List<WsUrinalysis> getDonorUrinalysis (String nationalId)

Get a donor's urinalyses.

Sample soap requests: donor Urinalysis

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of urinalysis
Throws
SoapException the soap exception

public abstract WsMedicalHistory getMedicalHistory (String nationalId)

Gets the recipient medical history.

Sample soap requests: medical History

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

public abstract List<WsPatientAbdominalProfile> getPatientAbdominalProfiles (String nationalId)

Gets a donor's abdominal profiles.

Sample soap requests: patient Abdominal profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of abdominal profiles
Throws
SoapException the soap exception

public abstract List<WsPatientBloodGases> getPatientBloodGases (String nationalId)

Get a donor's blood gases records.

Sample soap requests: patient Blood Gases

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of blood gases records
Throws
SoapException the soap exception

public abstract List<WsChemistry> getPatientChemistry (String nationalId)

Get a patient's(donor/recipient) chemistry records.

Sample soap requests: patient Chemistry

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of chemistry records
Throws
SoapException the soap exception

public abstract List<WsElectrolytes> getPatientElectrolytes (String nationalId)

Get a patient's(donor/recipient) electrolytes records.

Sample soap requests: patient Electrolytes

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of electrolytes records
Throws
SoapException the soap exception

public abstract List<WsHeartProfile> getPatientHeartProfiles (String nationalId)

Get a donor's heart profiles.

Sample soap requests: patient Heart profile

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of heart profiles
Throws
SoapException the soap exception

public abstract List<WsHematology> getPatientHematologies (String nationalId)

Get a patient's(donor/recipient) hematology records.

Sample soap requests: patient Hematologies

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of hematology records
Throws
SoapException the soap exception

public abstract List<WsInfection> getPatientInfections (String nationalId)

Gets a recipient's infections.

Sample soap requests: patient Infections

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the list of recipient infections
Throws
SoapException the soap exception

public abstract List<WsLungProfile> getPatientLungProfile (String nationalId)

Get donor's lung profiles.

Sample soap requests: patient Lung profile

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of lung profiles
Throws
SoapException the soap exception

public abstract List<WsMalignancy> getPatientMalignancies (String nationalId)

Gets a recipient's malignancies.

Sample soap requests: patient Malignancies

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the list of recipient malignancies
Throws
SoapException the soap exception

public abstract List<WsMedSocialHistRisk> getPatientMedicalSocialHistory (String nationalId)

Gets the DWL donor's medical social history record.

Sample soap requests: patient MedicalSocialHistory

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the list of DWL donor medical social history risks.
Throws
SoapException the soap exception

public abstract List<WsVitalSigns> getPatientVitalSigns (String nationalId)

Get a patient's(donor/recipient) vital signs records.

Sample soap requests: patient Vital Signs

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of vital signs records
Throws
SoapException the soap exception

public abstract WsRecipientHealth getRecipientHealth (String nationalId)

Gets a recipient's health records.

Sample soap requests: recipient Health

Parameters
nationalId the CTR2 recipient ID.
required: TRUE
see: nationalId info
Returns
  • the list of recipient health records
Throws
SoapException the soap exception

public abstract List<WsRecipientMedications> getRecipientMedications (String nationalId)

Gets a recipient's medications.

Sample soap requests: recipient Medications

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the list of recipient medication records
Throws
SoapException the soap exception

public abstract List<WsRenalProfile> getRenalProfiles (String nationalId)

Get a recipient's renal profiles.

Sample soap requests: renal profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • a list of renal profile records
Throws
SoapException the soap exception

public abstract WsCardioThoracic updateCardioThoracicProfile (String nationalId, WsCardioThoracic wsInput)

Add or update a recipient's cardio thoracic profile.

Sample soap requests: cardio-thoracic profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated cardio thoracic profile
required: TRUE
see: { WsCardioThoracic}, Ws_DTO... Info.
Returns
  • a cardio thoracic profile
Throws
SoapException the soap exception

public abstract WsDonorMedications updateDonorMedications (String nationalId, WsDonorMedications wsInput)

Add or update a donor medication record.

Sample soap requests: donor Medications

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated donor medication record
required: TRUE
see: { WsDonorMedications}, Ws_DTO... Info.
Returns
  • the list of donor medication records
Throws
SoapException the soap exception

public abstract WsUrinalysis updateDonorUrinalysis (String nationalId, WsUrinalysis wsInput)

Add or update a donor's urinalysis record.

Sample soap requests: donor Urinalysis

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated a urinalysis record
required: TRUE
see: { WsUrinalysis}, Ws_DTO... Info.
Returns
  • a urinalysis record
Throws
SoapException the soap exception

public abstract WsMedicalHistory updateMedicalHistory (String nationalId, WsMedicalHistory wsInput)

Update the recipient medical history.

Sample soap requests: medical History
  • add a "WsMedicalHistory" record: method is not applicable in the "Add" context.

    A recipient has only 1 medical history record. The medical history record is created when a new recipient is added to the CTR and the medical history fields are empty.
    When a record - field ( for exmaple : prevCardiacSurgeryType ) exists and the request attempts to add another record field of type: prevCardiacSurgeryType, the request will not add a second field of type: prevCardiacSurgeryType, but will update the existing field.

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated recipient medical history.
see: WsMedicalHistory}
Returns
Throws
SoapException

public abstract WsPatientAbdominalProfile updatePatientAbdominalProfile (String nationalId, WsPatientAbdominalProfile wsInput)

Add or update a donor's abdominal profile.

Sample soap requests: patient Abdominal profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated abdominal profile
required: TRUE
see: { WsPatientAbdominalProfile}, Ws_DTO... Info.
Returns
  • an abdominal profile
Throws
SoapException the soap exception

public abstract WsPatientBloodGases updatePatientBloodGases (String nationalId, WsPatientBloodGases wsInput)

Add or update a donor's blood gases record.

Sample soap requests: patient Blood Gases

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated blood gases record
required: TRUE
see: { WsPatientBloodGases}, Ws_DTO... Info.
Returns
  • a blood gases record
Throws
SoapException the soap exception

public abstract WsChemistry updatePatientChemistry (String nationalId, WsChemistry wsInput)

Add or update a patient's(donor/recipient) chemistry record.

Sample soap requests: patient Chemistry

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated chemistry record
required: TRUE
see: { WsChemistry}, Ws_DTO... Info.
Returns
  • a chemistry record
Throws
SoapException the soap exception

public abstract WsElectrolytes updatePatientElectrolytes (String nationalId, WsElectrolytes wsInput)

Add or update a patient's(donor/recipient) electrolytes record.

Sample soap requests: patient Electrolytes

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated electrolytes record
required: TRUE
see: { WsElectrolytes}, Ws_DTO... Info.
Returns
  • a electrolytes record
Throws
SoapException the soap exception

public abstract WsHeartProfile updatePatientHeartProfile (String nationalId, WsHeartProfile wsInput)

Add or update a donor's heart profile.

Sample soap requests: patient Heart profile

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated heart profile
required: TRUE
see: { WsHeartProfile}, Ws_DTO... Info.
Returns
  • a heart profile
Throws
SoapException the soap exception

public abstract WsHematology updatePatientHematology (String nationalId, WsHematology wsInput)

Add or update a patient's(donor/recipient) hematology record.

Sample soap requests: patient Hematologies

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated hematology record
required: TRUE
see: { WsHematology}, Ws_DTO... Info.
Returns
  • a hematology record
Throws
SoapException the soap exception

public abstract WsInfection updatePatientInfections (String nationalId, WsInfection wsInput)

Add or update a recipient infections record.

Sample soap requests: patient Infections

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated recipient infections
required: TRUE
see: { WsInfection}, Ws_DTO... Info.
Returns
Throws
SoapException the soap exception

public abstract WsLungProfile updatePatientLungProfile (String nationalId, WsLungProfile wsInput)

Add or update a donor's lung profile.

Sample soap requests: patient Lung profile

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated lung profile
required: TRUE
see: { WsLungProfile}, Ws_DTO... Info.
Returns
  • a lung profile profile
Throws
SoapException the soap exception

public abstract WsMalignancy updatePatientMalignancies (String nationalId, WsMalignancy wsInput)

Add or update a recipient malignancy record.

Sample soap requests: patient Malignancies

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated recipient medication
required: TRUE
see: { WsMalignancy}, Ws_DTO... Info.
Returns
Throws
SoapException the soap exception

public abstract WsMedSocialHistRisk updatePatientMedicalSocialHistory (String nationalId, WsMedSocialHistRisk wsInput)

Add or update a DWL donor's medical social history record.

Sample soap requests: patient MedicalSocialHistory

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated medical social history record
required: TRUE
see: { WsMedSocialHistRisk}, Ws_DTO... Info.
Returns
Throws
SoapException the soap exception

public abstract WsVitalSigns updatePatientVitalSigns (String nationalId, WsVitalSigns wsInput)

Add or update a patient's(donor/recipient) vital signs record.

Sample soap requests: patient Vital Signs

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated vital signs record
required: TRUE
see: { WsVitalSigns}, Ws_DTO... Info.
Returns
  • a vital signs record
Throws
SoapException the soap exception

public abstract WsRecipientMedications updateRecipientMedications (String nationalId, WsRecipientMedications wsInput)

Add or update a recipient medications record.

Sample soap requests: recipient Medications

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated recipient medication
required: TRUE
see: { WsRecipientMedications}, Ws_DTO... Info.
Returns
  • the list of recipient medication records
Throws
SoapException the soap exception

public abstract WsRenalProfile updateRenalProfile (String nationalId, WsRenalProfileInput wsInput)

Add or update a recipient's renal profile.

Sample soap requests: renal profiles

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/updated cardio thoracic profile
required: TRUE
see: { WsRenalProfileInput}, Ws_DTO... Info.
Returns
  • a renal profile record
Throws
SoapException the soap exception